{ "openapi": "3.0.1", "info": { "title": "Steam Reviews Scraper", "description": "Steam Reviews Scraper SD - Steam Reviews Scraper is a game data tool that extracts Steam user reviews of any game via Valve's official keyless API: text, recommendation, votes, playtime, language, dates, developer replies and app details, with filters.", "version": "1.0", "x-build-id": "c8JXJsH9N3OMphO10" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~steam-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-steam-reviews-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/neuro-scraper~steam-reviews-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-steam-reviews-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/neuro-scraper~steam-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-steam-reviews-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "appIds": { "title": "Steam apps", "type": "array", "description": "App ids (730) or store / community links (https://store.steampowered.com/app/1091500/Cyberpunk_2077/), one per line.", "items": { "type": "string" } }, "sort": { "title": "Sort reviews by", "enum": [ "recent", "updated", "helpful", "funny" ], "type": "string", "description": "Most recent (best for paging through everything), recently updated, most helpful or funniest.", "default": "recent" }, "reviewType": { "title": "Review type", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "All reviews, only positive (recommended) or only negative ones.", "default": "all" }, "purchaseType": { "title": "Purchase type", "enum": [ "all", "steam", "nonSteam" ], "type": "string", "description": "Reviews from every reviewer, only from people who bought the app on Steam, or only from people who got it elsewhere (keys, gifts).", "default": "all" }, "languages": { "title": "Languages", "type": "array", "description": "Steam API language codes, one per line: all, english, german, french, spanish, schinese, russian, brazilian, japanese, koreana ... Default: all.", "default": [ "all" ], "items": { "type": "string" } }, "dateFrom": { "title": "Written on or after", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional. Date as YYYY-MM-DD." }, "dateTo": { "title": "Written on or before", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional. Date as YYYY-MM-DD." }, "minPlaytimeHours": { "title": "Minimum playtime at review (hours)", "minimum": 0, "type": "integer", "description": "Optional. Only reviews whose author had played at least this many hours when writing." }, "helpfulDayRange": { "title": "Most helpful: days back", "minimum": 0, "maximum": 365, "type": "integer", "description": "Only for \"Most helpful\". Look this many days back (max 365). 0 = all time.", "default": 0 }, "includeOffTopic": { "title": "Include off-topic reviews (review bombs)", "type": "boolean", "description": "Steam hides reviews posted during off-topic review bombs by default. Turn on to include them.", "default": false }, "includeAppDetails": { "title": "Add store details of each app", "type": "boolean", "description": "Adds the app's name, type, developers, publishers, release date, price and genres to every review row (one extra request per app).", "default": true }, "country": { "title": "Store country for prices", "type": "string", "description": "Two-letter country code for the price in the store details, e.g. us, gb, de, in.", "default": "us" }, "includeReviewerIds": { "title": "Include reviewer Steam IDs", "type": "boolean", "description": "Adds each reviewer's public Steam ID and the review's link. Off by default: a Steam ID identifies a person - turn it on only if you need it.", "default": false }, "maxResults": { "title": "Max reviews per app", "minimum": 1, "type": "integer", "description": "How many reviews to return for each app. The Actor pages through Steam's reviews (100 per request) until this number or the end.", "default": 100 }, "maxItems": { "title": "Max reviews in total", "minimum": 1, "type": "integer", "description": "Optional cap on the whole run. Leave empty for no total cap." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed for Valve's review API. Turn a proxy on only if you see HTTP 429 errors.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }