Introduction
Endpoints
- POSTBookmark or Unbookmark Badge
- POSTCompare Badge Collections
- POSTCreate OAuth Connection
- POSTCreate developer application
- POSTDelete OAuth or domain connection
- POSTDelete developer application
- POSTDelete uploaded images
- POSTDelete user session
- POSTGet account badge statistics
- POSTGet account data points for charts
- POSTGet account profile information
- POSTGet account metadata
- POSTGet user session information
- POSTGet account settings
- POSTList account owned apps
- POSTList User's Bookmarked Badges
- POSTList account badges
- POSTList account friends
- POSTList uploaded images
- POSTGet leaderboard history
- POSTList User's Owned Badges
- POSTLogin with Steam
- POSTLogout from session
- POSTQueue Account Data Update
- POSTReconnect OAuth Connection
- POSTRefresh Authentication Session
- POSTSend email verification
- POSTSubscribe to email notifications
- POSTUpdate OAuth connection
- POSTUpdate developer application
- POSTUpdate account images
- POSTUpdate account role
- POSTUpdate account settings
- POSTUpdate account vanity URL
- POSTUpload images
- POSTVerify OAuth connection
- POSTVerify email address
- POST
curl --request POST \
--url https://api.steamsets.com/v1/account.getSettings \
--header 'Authorization: Bearer <token>'{
"chosenRole": {
"role": "user",
"tier": "<string>"
},
"connections": [
{
"avatar": "<string>",
"connectionId": "<string>",
"externalId": "<string>",
"failed": true,
"hide": true,
"name": "<string>",
"provider": "discord",
"verified": true
}
],
"developerApps": [
{
"apiKey": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"environment": "production",
"id": "<string>",
"keyId": "<string>",
"name": "<string>",
"analytics": {
"last24Hours": {
"failedRequests": 1,
"outcomeBreakdown": [
{
"count": 1,
"outcome": "VALID"
}
],
"successRate": 123,
"successfulRequests": 1,
"totalRequests": 1
},
"timeSeries": {
"hourly": [
{
"count": 1,
"outcome": "<string>",
"time": "2023-11-07T05:31:56Z"
}
]
}
}
}
],
"email": "[email protected]",
"emailVerifiedAt": "2023-11-07T05:31:56Z",
"hidden": true,
"images": [
{
"active": true,
"fileName": "<string>",
"imageId": "<string>",
"imageType": "avatar"
}
],
"language": "<string>",
"privacy": "public",
"sessions": [
{
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"ip": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"sessionId": "<string>",
"userAgent": "<string>"
}
],
"subscribed": true,
"vanity": "<string>",
"vanityAnalytics": {
"clicks": 123
},
"$schema": "<string>",
"analytics": {
"last24Hours": {
"failedRequests": 1,
"outcomeBreakdown": [
{
"count": 1,
"outcome": "VALID"
}
],
"successRate": 123,
"successfulRequests": 1,
"totalRequests": 1
},
"timeSeries": {
"hourly": [
{
"count": 1,
"outcome": "<string>",
"time": "2023-11-07T05:31:56Z"
}
]
}
}
}Get account settings
curl --request POST \
--url https://api.steamsets.com/v1/account.getSettings \
--header 'Authorization: Bearer <token>'{
"chosenRole": {
"role": "user",
"tier": "<string>"
},
"connections": [
{
"avatar": "<string>",
"connectionId": "<string>",
"externalId": "<string>",
"failed": true,
"hide": true,
"name": "<string>",
"provider": "discord",
"verified": true
}
],
"developerApps": [
{
"apiKey": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"environment": "production",
"id": "<string>",
"keyId": "<string>",
"name": "<string>",
"analytics": {
"last24Hours": {
"failedRequests": 1,
"outcomeBreakdown": [
{
"count": 1,
"outcome": "VALID"
}
],
"successRate": 123,
"successfulRequests": 1,
"totalRequests": 1
},
"timeSeries": {
"hourly": [
{
"count": 1,
"outcome": "<string>",
"time": "2023-11-07T05:31:56Z"
}
]
}
}
}
],
"email": "[email protected]",
"emailVerifiedAt": "2023-11-07T05:31:56Z",
"hidden": true,
"images": [
{
"active": true,
"fileName": "<string>",
"imageId": "<string>",
"imageType": "avatar"
}
],
"language": "<string>",
"privacy": "public",
"sessions": [
{
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"ip": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"sessionId": "<string>",
"userAgent": "<string>"
}
],
"subscribed": true,
"vanity": "<string>",
"vanityAnalytics": {
"clicks": 123
},
"$schema": "<string>",
"analytics": {
"last24Hours": {
"failedRequests": 1,
"outcomeBreakdown": [
{
"count": 1,
"outcome": "VALID"
}
],
"successRate": 123,
"successfulRequests": 1,
"totalRequests": 1
},
"timeSeries": {
"hourly": [
{
"count": 1,
"outcome": "<string>",
"time": "2023-11-07T05:31:56Z"
}
]
}
}
}Authentication Required
This endpoint requires an active user session and cannot be accessed via API keys. It’s designed for authenticated user interactions within the web application.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
OK
The chosen role the account has
Show child attributes
Show child attributes
user, donator, staff, developer, partner, owner, amethyst, amber, emerald, sapphire, ruby, diamond, contributor, early_supporter, beta, translator, top_100, badge_scout, nitro_booster, astral, nebula The tier of the donation
The connections the account has
Show child attributes
Show child attributes
The avatar of the connected account
The public id of the connection
The external id of the connected account
Whether the connection has failed to refresh or not
Whether the connection should be hidden or not
The name of the connected account
The provider to connect with
discord, patreon, kick, reddit, twitch, youtube, x, domain Whether the connection has been verified or not
The developer apps the account has
Show child attributes
Show child attributes
The api key (deprecated, always null for security)
When the app was created
The description of the developer app
The environment of the developer app
production, development, staging The id of the developer app (same as keyId for backwards compatibility)
The Unkey key ID
The name of the developer app
Analytics data for this API key
Show child attributes
Show child attributes
Analytics for the last 24 hours
Show child attributes
Show child attributes
Number of failed requests (non-VALID outcomes)
x >= 0Breakdown of requests by outcome
Show child attributes
Show child attributes
The number of verifications with this outcome
x >= 0The outcome of the verification
VALID, RATE_LIMITED, INVALID, EXPIRED, DISABLED, INSUFFICIENT_PERMISSIONS, FORBIDDEN, USAGE_EXCEEDED Success rate as a percentage
Number of successful requests (VALID outcome)
x >= 0Total number of requests in the last 24 hours
x >= 0Time series data
Show child attributes
Show child attributes
Hourly time series data for the last 24 hours
Show child attributes
Show child attributes
The number of verifications at this time
x >= 0The outcome of the verifications
The timestamp of the data point
The email the account is using
The time the email was verified
Whether the account is hidden in the leaderboards
The images the account has
Show child attributes
Show child attributes
Whether the image is active or not
The name of the file
The id of the image
The type of the image
avatar, background, avatar_frame, aniamted_avatar, mini_background The language the account is using
The privacy of the account
public, private, friends_only The sessions the account has
Show child attributes
Show child attributes
The time the session was created
The time the session expires
The ip of the session
The time the session was last seen
The session id
The user agent of the session
Whether the account is subscribed to marketing emails
The vanity the account is using
A URL to the JSON Schema for this object.
Aggregated analytics for all API keys of this account
Show child attributes
Show child attributes
Analytics for the last 24 hours
Show child attributes
Show child attributes
Number of failed requests (non-VALID outcomes)
x >= 0Breakdown of requests by outcome
Show child attributes
Show child attributes
The number of verifications with this outcome
x >= 0The outcome of the verification
VALID, RATE_LIMITED, INVALID, EXPIRED, DISABLED, INSUFFICIENT_PERMISSIONS, FORBIDDEN, USAGE_EXCEEDED Success rate as a percentage
Number of successful requests (VALID outcome)
x >= 0Total number of requests in the last 24 hours
x >= 0Time series data
Show child attributes
Show child attributes
Hourly time series data for the last 24 hours
Show child attributes
Show child attributes