Skip to main content
POST
/
v1
/
account.compareBadges
Compare badge collections between accounts
curl --request POST \
  --url https://api.steamsets.com/v1/account.compareBadges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "Comparing": [
    {
      "id": {
        "accountId": 1,
        "steamId64": "<string>"
      },
      "vanity": {
        "type": "steam",
        "value": "<string>"
      }
    }
  ],
  "compare": {
    "against": "<string>",
    "mode": "missing"
  },
  "filter": "all",
  "ignore": [
    "event"
  ],
  "order": {
    "by": "xp",
    "direction": "desc"
  },
  "page": 1
}'
{
  "$schema": "https://api.steamsets.com/schemas/V1AccountCompareBadgesResponseBody.json",
  "appBadges": [
    {
      "appId": 1,
      "appImage": "<string>",
      "appName": "<string>",
      "badgeImage": "<string>",
      "badgeName": "<string>",
      "foil": {},
      "foilScarcity": 1,
      "hasFoil": true,
      "isEvent": true,
      "isSale": true,
      "normal": {},
      "normalScarcity": 1,
      "steamId": 1
    }
  ],
  "pages": 1,
  "totalHits": 1
}
This endpoint supports both API key authentication and user authentication

​
Authentication Options

  • API Keys: For external applications and integrations
  • User Sessions: For personalized badge comparisons
When authenticated with a user session, one of the accounts in the comparison can be the authenticated user. 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
​
Comparing
object[] | null
required
​
compare
object | null
required
​
filter
enum<string>
default:all
required
Available options:
all,
normal,
foil
​
ignore
enum<string>[] | null
required
​
order
object | null
required
​
page
integer
default:1
required
Required range: x >= 0

Response

OK

​
appBadges
object[] | null
required
​
pages
integer
required

The number of pages

Examples:

1

​
totalHits
integer
required

The total number of hits for all pages

Examples:

1

​
$schema
string<uri>

A URL to the JSON Schema for this object.

Examples:

"https://api.steamsets.com/schemas/V1AccountCompareBadgesResponseBody.json"