Datasets

Search the steam-charts dataset

Searches daily snapshots of Steam's player-count and sales charts, stored in a search index (one document per chart × country × snapshot × rank) so history accumulates. Charts: most_played (weekly peak concurrent), concurrent (live concurrent players), top_sellers (weekly sales; country-specific). With no date the latest snapshot is returned (today's chart); pair app_id with sort=date_desc for an app's rank/players over time. Country is global for the player-count charts or an ISO code (e.g. us) for top_sellers. Sort enum: rank, rank_desc, date_desc. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).

get/datasets/steam-charts/search

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/datasets/steam-charts/search
  • Auth: API key in header x-api-key

Query parameters

qstring

Full-text query over the game name, max 256 characters

chart'most_played' | 'concurrent' | 'top_sellers'

Chart enum: most_played, concurrent, top_sellers

countrystring

Market filter: global (player-count charts) or an ISO country code (top_sellers), max 128 characters

app_idstring

Exact Steam app id filter; pair with sort=date_desc for rank/players history

datestring

Snapshot date filter yyyy-MM-dd; defaults to the latest snapshot

sort'rank' | 'rank_desc' | 'date_desc'

Sort enum: rank, rank_desc, date_desc

pageinteger

Page number, defaults to 1

page_sizeinteger

Page size, defaults to 20 and maxes at 100; page * page_size must be <= 10000

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.