v4

latestOpenAPI 3.1.02026-07-3196251302.5 KB

account

Compare badge collections between accounts

post/v1/account.compareBadges

Request body

$schemastring uri

A URL to the JSON Schema for this object.

appIdsinteger[] nullable

appTypesstring[] nullable

excludeAppIdsinteger[] nullable

filter'all' | 'normal' | 'foil'

ignorestring[] nullable

match'tuple' | 'tupleLevel' | 'tupleMinLevel'

minLevelinteger

Only used when match=tupleMinLevel

mode'missing' | 'ownedByAll' | 'unique'

pageinteger

Example request

{
  "$schema": "https://api.steamsets.com/schemas/V1AccountCompareBadgesRequestBody.json",
  "accounts": [
    {
      "$schema": "https://api.steamsets.com/schemas/AccountSearch.json"
    }
  ],
  "difference": {
    "has": {
      "$schema": "https://api.steamsets.com/schemas/AccountSearch.json"
    },
    "lacks": {
      "$schema": "https://api.steamsets.com/schemas/AccountSearch.json"
    }
  }
}

Response

$schemastring uri

A URL to the JSON Schema for this object.

pagesinteger required

The number of pages

totalHitsinteger required

The total number of hits for all pages

Example response

{
  "$schema": "https://api.steamsets.com/schemas/V1AccountCompareBadgesResponseBody.json",
  "pages": 1,
  "totalHits": 1
}