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

# Search steam-achievements dataset

`GET /datasets/steam-achievements/search`

## Request

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

Searches per-game global achievement unlock percentages (one document per appid × achievement). Pass `app_id` to list a game's achievements. Sort enum: `percent_desc` (most-unlocked first, default), `percent_asc` (rarest first), `rank_asc`. 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

- `app_id` string
- `sort` 'percent_desc' | 'percent_asc' | 'rank_asc'
- `page` integer
- `page_size` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- DatasetsSteamAchievementsSearchResponseDoc
  - `code` integer
  - `data` DatasetsSteamAchievementsSearchResponse
    - `dataset` string
    - `items` EsSteamAchievementRecord[]
      - `appid` integer
      - `crawled_at` string
      - `name` string
      - `percent` number
      - `rank` integer: 0 = most-unlocked
      - `schema_version` integer
    - `page` integer
    - `page_size` integer
    - `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)