{ "openapi": "3.0.1", "info": { "title": "Steam Game Reviews & Ratings Scraper", "description": "Scrape Steam game reviews in bulk via Steam's official public reviews API. Extract ratings, sentiment (positive/negative), review text, playtime, helpful votes, reviewer language and purchase type.", "version": "1.0", "x-build-id": "XGoR5afhdN03wtqWb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coolinbex~steam-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coolinbex-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/coolinbex~steam-reviews-scraper/runs": { "post": { "operationId": "runs-sync-coolinbex-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/coolinbex~steam-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-coolinbex-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", "required": [ "games" ], "properties": { "games": { "title": "Games", "type": "array", "description": "Steam games to scrape reviews for. Each entry can be a numeric Steam appId (e.g. 730), a Steam store URL (e.g. https://store.steampowered.com/app/730/), or a free-text game name (e.g. \"Elden Ring\") which will be auto-resolved to its appId.", "items": { "type": "string" } }, "maxReviewsPerGame": { "title": "Max reviews per game", "minimum": 1, "type": "integer", "description": "Maximum number of reviews to collect for each game.", "default": 200 }, "reviewType": { "title": "Review type", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "Filter reviews by sentiment.", "default": "all" }, "language": { "title": "Language", "type": "string", "description": "Steam language code to filter reviews by (e.g. \"english\", \"schinese\", \"german\"), or \"all\" for every language.", "default": "all" }, "filter": { "title": "Sort order", "enum": [ "recent", "updated", "all" ], "type": "string", "description": "How Steam sorts the reviews returned. \"Recent\" and \"Updated\" reliably terminate when reviews run out. \"All\" (sorted by helpfulness) is more prone to a known Steam API pagination quirk on very large review sets; this actor guards against it, but \"Recent\" is recommended for full, reliable extraction.", "default": "recent" }, "dayRange": { "title": "Day range (only used when Sort order = \"All\")", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many days back to look for helpful reviews. Only applies when Sort order is \"all\". Maximum 365.", "default": 365 }, "purchaseType": { "title": "Purchase type", "enum": [ "all", "steam", "non_steam_purchase" ], "type": "string", "description": "Filter reviews by whether the reviewer purchased the game on Steam.", "default": "all" }, "includeOffTopicActivity": { "title": "Include off-topic activity (\"review bombs\")", "type": "boolean", "description": "By default Steam filters out reviews flagged as off-topic review-bomb activity. Enable this to include them.", "default": false }, "summaryOnly": { "title": "Summary only (no individual reviews)", "type": "boolean", "description": "If enabled, skips saving individual review records and only outputs one aggregate rating-summary record per game. Useful for fast sentiment overviews across many games.", "default": false }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "type": "integer", "description": "Polite delay between consecutive Steam API requests, to keep request rates reasonable.", "default": 350 } } }, "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 } } }, "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 } } } } } } } } } }