Skip to main content
POST
/
v1
/
badge.searchBadges
Search badges
curl --request POST \
  --url https://api.steamsets.com/v1/badge.searchBadges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": "<string>",
  "query": "<string>",
  "sort": [
    "<string>"
  ],
  "facets": [
    "<string>"
  ],
  "image": "<string>",
  "limit": 123,
  "offset": 123,
  "page": 123
}
'
{
  "badges": [
    {
      "_vectors": {
        "image": [
          123
        ]
      },
      "appId": 1,
      "appImage": "<string>",
      "appName": "<string>",
      "bookmarks": 1,
      "colors": [
        "<string>"
      ],
      "designs": [
        "<string>"
      ],
      "firstCompletion": 123,
      "highestLevel": 123,
      "id": "<string>",
      "image": "<string>",
      "isEvent": true,
      "isFoil": true,
      "isSale": true,
      "lastChangedAt": 123,
      "lastCompletion": 123,
      "level": 1,
      "name": "<string>",
      "scarcity": 123,
      "steamId": 1,
      "xp": 123
    }
  ],
  "facets": "<unknown>",
  "pages": 1,
  "results": 1,
  "$schema": "<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
This endpoint has rate limiting to prevent scraping while allowing normal usage
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.

Headers

​
X-Forwarded-For
string

Body

application/json
​
filter
string
required

The filter to apply to the search

​
query
string
required

The query to search for

​
sort
string[] | null
required

sort order

Example:
["price:asc", "author:desc"]
​
facets
string[] | null
​
image
string | null

The image to reverse search

Example:

"base64_encoded_image"

​
limit
integer<int64> | null
​
offset
integer<int64> | null
​
page
integer<int64> | null

Response

OK

​
badges
object[] | null
required
​
facets
any
required
​
pages
integer<int32>
required

total number of pages

Required range: x >= 0
​
results
integer<int32>
required

total number of results

Required range: x >= 0
​
$schema
string<uri>

A URL to the JSON Schema for this object.

Example:

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