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

# Search the steam-reviews dataset

`GET /datasets/steam-reviews/search`

## Request

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

Searches the stored Steam review corpus (the most-helpful reviews per game; one document per appid × recommendation). Full-text `q` over the review body, filter by `app_id`, `language`, or `voted_up` (positive/negative). Sort enum: `votes_desc` (most-helpful first, default), `weighted_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
- `app_id` string
- `language` string
- `voted_up` string
- `sort` 'votes_desc' | 'weighted_desc' | 'date_desc'
- `page` integer
- `page_size` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- DatasetsSteamReviewsSearchResponseDoc
  - `code` integer
  - `data` DatasetsSteamReviewsSearchResponse
    - `dataset` string
    - `items` EsSteamReviewRecord[]
      - `appid` integer
      - `author_playtime_forever_min` integer
      - `comment_count` integer
      - `crawled_at` string
      - `created_at` string: ISO, derived
      - `language` string
      - `playtime_at_review_min` integer
      - `received_for_free` boolean
      - `recommendation_id` string
      - `review` string
      - `schema_version` integer
      - `steam_purchase` boolean
      - `timestamp_created` integer
      - `timestamp_updated` integer
      - `voted_up` boolean
      - `votes_funny` integer
      - `votes_up` integer
      - `weighted_vote_score` number
      - `written_during_early_access` boolean
    - `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)