Get account profile information

curl --request POST \
  --url https://api.steamsets.com/v1/account.getInfo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": {
    "accountId": 1,
    "steamId64": "<string>"
  },
  "vanity": {
    "type": "steam",
    "value": "<string>"
  }
}
'

{
  "accountId": 1,
  "animatedAvatar": "<string>",
  "appCost": 1,
  "appPrivacy": "private",
  "apps": 1,
  "avatar": "<string>",
  "avatarFrame": "<string>",
  "awardsGiven": 1,
  "awardsReceived": 1,
  "background": "<string>",
  "badges": 1,
  "bans": 1,
  "communityBan": true,
  "connections": [
    {
      "avatar": "<string>",
      "connectionId": "<string>",
      "externalId": "<string>",
      "failed": true,
      "hide": true,
      "name": "<string>",
      "provider": "discord",
      "verified": true
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "currentBestRanks": [
    {
      "leaderboard": "apps",
      "ranks": "<string>"
    }
  ],
  "currentRanks": [
    {
      "leaderboard": "apps",
      "ranks": "<string>"
    }
  ],
  "donated": 1,
  "economyBan": "<string>",
  "foilBadgeCost": 1,
  "foilBadges": 1,
  "friendPrivacy": "private",
  "friends": 1,
  "gameBans": 1,
  "images": [
    {
      "active": true,
      "fileName": "<string>",
      "imageId": "<string>",
      "imageType": "avatar"
    }
  ],
  "lastBanDate": "2023-11-07T05:31:56Z",
  "lastQueueStatus": "undefined",
  "level": 1,
  "miniBackground": "<string>",
  "name": "<string>",
  "nextAllowedTime": "2023-11-07T05:31:56Z",
  "normalBadgeCost": 1,
  "normalBadges": 1,
  "playtime": 1,
  "pointsGiven": 1,
  "pointsReceived": 1,
  "privacy": "private",
  "roles": [
    {
      "extras": {},
      "rating": 123,
      "role": "user"
    }
  ],
  "shortlinkDomain": "<string>",
  "steamId": "<string>",
  "steamSetsScore": 1,
  "steamSetsVanity": "<string>",
  "steamVanity": "<string>",
  "theme": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "vacBans": 1,
  "xp": 1,
  "$schema": "<string>",
  "city": {
    "name": "<string>"
  },
  "country": {
    "name": "<string>",
    "code": "<string>"
  },
  "region": {
    "name": "<string>"
  },
  "state": {
    "name": "<string>"
  }
}

POST

account.getInfo

curl --request POST \
  --url https://api.steamsets.com/v1/account.getInfo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": {
    "accountId": 1,
    "steamId64": "<string>"
  },
  "vanity": {
    "type": "steam",
    "value": "<string>"
  }
}
'

{
  "accountId": 1,
  "animatedAvatar": "<string>",
  "appCost": 1,
  "appPrivacy": "private",
  "apps": 1,
  "avatar": "<string>",
  "avatarFrame": "<string>",
  "awardsGiven": 1,
  "awardsReceived": 1,
  "background": "<string>",
  "badges": 1,
  "bans": 1,
  "communityBan": true,
  "connections": [
    {
      "avatar": "<string>",
      "connectionId": "<string>",
      "externalId": "<string>",
      "failed": true,
      "hide": true,
      "name": "<string>",
      "provider": "discord",
      "verified": true
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "currentBestRanks": [
    {
      "leaderboard": "apps",
      "ranks": "<string>"
    }
  ],
  "currentRanks": [
    {
      "leaderboard": "apps",
      "ranks": "<string>"
    }
  ],
  "donated": 1,
  "economyBan": "<string>",
  "foilBadgeCost": 1,
  "foilBadges": 1,
  "friendPrivacy": "private",
  "friends": 1,
  "gameBans": 1,
  "images": [
    {
      "active": true,
      "fileName": "<string>",
      "imageId": "<string>",
      "imageType": "avatar"
    }
  ],
  "lastBanDate": "2023-11-07T05:31:56Z",
  "lastQueueStatus": "undefined",
  "level": 1,
  "miniBackground": "<string>",
  "name": "<string>",
  "nextAllowedTime": "2023-11-07T05:31:56Z",
  "normalBadgeCost": 1,
  "normalBadges": 1,
  "playtime": 1,
  "pointsGiven": 1,
  "pointsReceived": 1,
  "privacy": "private",
  "roles": [
    {
      "extras": {},
      "rating": 123,
      "role": "user"
    }
  ],
  "shortlinkDomain": "<string>",
  "steamId": "<string>",
  "steamSetsScore": 1,
  "steamSetsVanity": "<string>",
  "steamVanity": "<string>",
  "theme": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "vacBans": 1,
  "xp": 1,
  "$schema": "<string>",
  "city": {
    "name": "<string>"
  },
  "country": {
    "name": "<string>",
    "code": "<string>"
  },
  "region": {
    "name": "<string>"
  },
  "state": {
    "name": "<string>"
  }
}

This endpoint supports API key authentication for external integrations

API Access

This endpoint can be accessed using:

API Keys: For external applications and integrations
User Sessions: For web application access

See our API documentation for authentication details.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

object

Show child attributes

id.accountId

integer<int32>

Account ID to search for

Required range: x >= 0

id.steamId64

string

SteamID64 to search for

Required string length: 17

vanity

object

Show child attributes

vanity.type

enum<string>

required

Which type of vanity to search for

Available options:

steam,

internal

vanity.value

string

required

Vanity to search for

Minimum string length: 2

Response

accountId

integer<int32>

required

The account id

Required range: x >= 0

animatedAvatar

string

required

The animated avatar of the account

appCost

integer<int32>

required

deprecated

The cost of an app

Required range: x >= 0

appPrivacy

enum<string>

required

The privacy of the account

Available options:

private,

public,

friends_only

apps

integer<int32>

required

The number of apps the account has

Required range: x >= 0

avatar

string

required

The avatar hash of the account

avatarFrame

string

required

The avatar frame of the account

awardsGiven

integer<int32>

required

The number of awards the account has

Required range: x >= 0

awardsReceived

integer<int32>

required

The number of awards the account has

Required range: x >= 0

background

string

required

The background of the account

badges

integer<int32>

required

The number of badges the account has

Required range: x >= 0

bans

integer<int32>

required

The number of bans

Required range: x >= 0

communityBan

boolean

required

If the account is community banned or not

connections

object[] | null

required

The connections of the account

Show child attributes

connections.avatar

string

required

The avatar of the connected account

connections.connectionId

string

required

The public id of the connection

connections.externalId

string

required

The external id of the connected account

connections.failed

boolean

required

Whether the connection has failed to refresh or not

connections.hide

boolean

required

Whether the connection should be hidden or not

connections.name

string

required

The name of the connected account

connections.provider

enum<string>

required

The provider to connect with

Available options:

discord,

patreon,

kick,

reddit,

twitch,

youtube,

x,

domain

connections.verified

boolean

required

Whether the connection has been verified or not

createdAt

string<date-time> | null

required

The time the account was created

currentBestRanks

object[] | null

required

The current best ranks

Show child attributes

currentBestRanks.leaderboard

enum<string>

required

The leaderboard of the best leaderboard

Available options:

apps,

app_playtime,

app_valid_playtime,

awards_given,

awards_received,

bans,

game_bans,

vac_bans,

donations,

foil_badges,

normal_badges,

badges,

playtime,

valid_playtime,

points_given,

points_received,

steam_sets,

xp

currentBestRanks.ranks

string

required

The ranks in the leaderboard in csv global,regional,country,state,city

currentRanks

object[] | null

required

The current ranks

Show child attributes

currentRanks.leaderboard

enum<string>

required

The leaderboard of the best leaderboard

Available options:

apps,

app_playtime,

app_valid_playtime,

awards_given,

awards_received,

bans,

game_bans,

vac_bans,

donations,

foil_badges,

normal_badges,

badges,

playtime,

valid_playtime,

points_given,

points_received,

steam_sets,

xp

currentRanks.ranks

string

required

The ranks in the leaderboard in csv global,regional,country,state,city

donated

integer<int32>

required

The total of donations the account has

Required range: x >= 0

economyBan

string

required

The economy ban of the account

foilBadgeCost

integer<int32>

required

deprecated

The cost of a foil badge

Required range: x >= 0

foilBadges

integer<int32>

required

The number of foil badges the account has

Required range: x >= 0

friendPrivacy

enum<string>

required

The privacy of the account

Available options:

private,

public,

friends_only

friends

integer<int32>

required

The number of friends the account has

Required range: x >= 0

gameBans

integer<int32>

required

The number of game bans

Required range: x >= 0

images

object[] | null

required

The images of the account

Show child attributes

images.active

boolean

required

Whether the image is active or not

images.fileName

string

required

The name of the file

images.imageId

string

required

The id of the image

images.imageType

enum<string>

required

The type of the image

Available options:

avatar,

background,

avatar_frame,

aniamted_avatar,

mini_background

lastBanDate

string<date-time> | null

required

The Last date the account got a ban on

lastQueueStatus

enum<string>

required

Available options:

undefined,

pending,

in_progress,

completed

level

integer<int32>

required

The level of the account

Required range: x >= 0

miniBackground

string

required

The mini background of the account

name

string

required

The name of the account

nextAllowedTime

string<date-time>

required

The time the account is allowed to be refreshed

normalBadgeCost

integer<int32>

required

deprecated

The cost of a normal badge

Required range: x >= 0

normalBadges

integer<int32>

required

The number of normal badges the account has

Required range: x >= 0

playtime

integer<int32>

required

The playtime of the account

Required range: x >= 0

pointsGiven

integer<int32>

required

The number of points the account has

Required range: x >= 0

pointsReceived

integer<int32>

required

The number of points the account has

Required range: x >= 0

privacy

enum<string>

required

The privacy of the account

Available options:

private,

public,

friends_only

roles

object[] | null

required

The roles of the account

Show child attributes

roles.extras

object

required

Extra data associated with the role

Show child attributes

roles.extras.{key}

any

roles.rating

integer<int32>

required

The higher the more presedence it has

roles.role

enum<string>

required

Available options:

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

shortlinkDomain

string | null

required

The shortlink domain of the account, is to be used with their steamsets vanity

steamId

string

required

The steam id

steamSetsScore

integer<int32>

required

The steam sets score

Required range: x >= 0

steamSetsVanity

string

required

The vanity of the account

steamVanity

string

required

The vanity of the account

theme

string

required

The theme of the account

updatedAt

string<date-time> | null

required

The time the account was updated

vacBans

integer<int32>

required

The number of vac bans

Required range: x >= 0

integer<int32>

required

The number of xp the account has

Required range: x >= 0

$schema

string<uri>

A URL to the JSON Schema for this object.

city

object

The city of the account

Show child attributes

city.name

string

required

The name of the city

country

object

The country of the account

Show child attributes

country.name

string

required

The name of the country

country.code

string

The code of the country

region

object

The region of the account

Show child attributes

region.name

string

required

The name of the region

state

object

The state of the account

Show child attributes

state.name

string

required

The name of the state

Get account data points for charts Get account metadata

⌘I

Introduction

Endpoints

Get account profile information

API Access

Authorizations

Body

Response

Introduction

Endpoints

​API Access

Authorizations

Body

Response

API Access