{ "openapi": "3.0.1", "info": { "title": "Steam Reviews Scraper", "description": "Steam Reviews Scraper is a Python tool designed to extract user reviews, playtimes, ratings, and reviewer details for any game on Steam. It exports structured review datasets into CSV or JSON formats for sentiment analysis, market research, and game analytics.", "version": "0.0", "x-build-id": "R9JuJpKycKzgLBYVc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/real-estate-api~Steam-Reviews-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-real-estate-api-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/real-estate-api~Steam-Reviews-Scraper/runs": { "post": { "operationId": "runs-sync-real-estate-api-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/real-estate-api~Steam-Reviews-Scraper/run-sync": { "post": { "operationId": "run-sync-real-estate-api-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": [ "mode" ], "properties": { "mode": { "title": "What to scrape", "enum": [ "reviews", "app_details", "search", "featured", "player_count" ], "type": "string", "description": "Choose game reviews, store details, search, featured lists (top sellers, new releases, specials, coming soon), or the live player count.", "default": "reviews" }, "apps": { "title": "App IDs or Steam store URLs", "type": "array", "description": "App ids or store URLs for reviews, app details, and player counts. Example: 730 or https://store.steampowered.com/app/730/CounterStrike_2/", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Used in search mode. Steam store search returns about 10 hits per term and does not paginate.", "items": { "type": "string" } }, "reviewFilter": { "title": "Review order", "enum": [ "recent", "updated", "all" ], "type": "string", "description": "recent is newest first. all is most helpful. updated is documented by Valve and was not rechecked in the endpoint test.", "default": "recent" }, "reviewLanguage": { "title": "Review language", "type": "string", "description": "Steam language code such as all, english, russian, schinese, or german. Review score totals change with this filter.", "default": "all" }, "reviewType": { "title": "Review type", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "Keep all reviews, or only positive (voted up) or negative (voted down) reviews.", "default": "all" }, "purchaseType": { "title": "Purchase type", "enum": [ "all", "steam", "non_steam_purchase" ], "type": "string", "description": "all, steam (bought on Steam), or non_steam_purchase (activated a key or received it outside Steam).", "default": "all" }, "dayRange": { "title": "Only reviews from last N days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Optional. Sent only when review order is all (most helpful), which is how Steam applies day_range. From 1 to 365." }, "includeSummary": { "title": "Add review score summary row per game", "type": "boolean", "description": "When on, the first reviews page also saves the score label, positive and negative totals, and the language those totals used.", "default": true }, "enrichWithDetails": { "title": "Enrich search and featured rows with app details", "type": "boolean", "description": "Off by default. When on, each search hit or featured game also requests store app details (one app id per call, spaced at least one second apart).", "default": false }, "countryCode": { "title": "Store country (prices)", "type": "string", "description": "Two-letter store country code for prices and featured lists, such as us, gb, or de. Some apps are missing in a region and come back as not found.", "default": "us" }, "maxItems": { "title": "Max results (total)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Cap on dataset rows for the whole run, including summaries and errors. Free runs stop at 10,000.", "default": 200 }, "maxReviewsPerApp": { "title": "Max reviews per game", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many review rows to keep for each app id. Pages are 100 reviews. The total run still stops at max results.", "default": 1000 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many apps to request at once, from 1 to 5. Store app details stay at 3 or fewer because that endpoint is slow and rejects multiple ids.", "default": 3 }, "timeoutSecs": { "title": "Actor timeout (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Stop scheduling new work after this many seconds and keep rows already saved. Default 300. Maximum 3600.", "default": 300 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait for one Steam response before retrying. Default 30 seconds.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Leave Apify Proxy off unless Steam blocks your IP. These public endpoints were checked without a proxy. Datacenter proxies are fastest. Residential proxies are harder to detect.", "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 } } } } } } } } } }