---
title: "Search the steam-charts dataset"
method: GET
path: "/datasets/steam-charts/search"
tags: ["Datasets"]
---

# Search the steam-charts dataset

`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`

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).

## Query parameters

- `q` string
- `chart` 'most_played' | 'concurrent' | 'top_sellers'
- `country` string
- `app_id` string
- `date` string
- `sort` 'rank' | 'rank_desc' | 'date_desc'
- `page` integer
- `page_size` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- DatasetsSteamChartsSearchResponseDoc
  - `code` integer
  - `data` DatasetsSteamChartsSearchResponse
    - `dataset` string
    - `items` EsSteamChartEntry[]
      - `app_id` string
      - `chart` string
      - `chart_uid` string
      - `concurrent_in_game` integer
      - `country` string
      - `crawled_at` string
      - `final_price_cents` integer
      - `last_week_rank` integer
      - `name` string
      - `peak_in_game` integer
      - `rank` integer
      - `review_summary` string
      - `snapshot_date` string
    - `page` integer
    - `page_size` integer
    - `snapshot_date` string
    - `sort` string
    - `total` integer
  - `msg` string

## Other responses

- `400`: Bad Request
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)