{ "openapi": "3.0.1", "info": { "title": "Steam Reviews Scraper", "description": "Scrape Steam player reviews and game store data to JSON/CSV: review text, playtime, recommended/not recommended, helpfulness votes, purchase type, plus prices, genres, developers and review-score summaries.", "version": "0.1", "x-build-id": "mGsNKWgFiJC5KfWwK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetchsmith~steam-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetchsmith-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/fetchsmith~steam-reviews-scraper/runs": { "post": { "operationId": "runs-sync-fetchsmith-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/fetchsmith~steam-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-fetchsmith-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": { "dataType": { "title": "What to scrape", "enum": [ "reviews", "games" ], "type": "string", "description": "reviews = player reviews for the given games; games = the store record for each game (price, genres, developer, review score summary, optional live player count).", "default": "reviews" }, "apps": { "title": "Games", "type": "array", "description": "Steam store URLs or numeric App IDs, e.g. https://store.steampowered.com/app/1145360/Hades/ or 1145360.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Find games by name instead of (or as well as) giving URLs. Each match is then scraped according to 'What to scrape'.", "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per game", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Reviews only: how many reviews to fetch per game before moving to the next one (max 5000).", "default": 200 }, "maxResults": { "title": "Max results (total)", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on rows pushed to the dataset across all games — also caps what you are charged.", "default": 2000 }, "language": { "title": "Review language", "type": "string", "description": "Steam language code for the reviews to return: english, schinese, russian, german, french, spanish, japanese, brazilian, ... or \"all\" for every language.", "default": "english" }, "reviewType": { "title": "Recommended / not recommended", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "positive = thumbs-up reviews only, negative = thumbs-down only.", "default": "all" }, "purchaseType": { "title": "Purchase type", "enum": [ "all", "steam", "non_steam_purchase" ], "type": "string", "description": "steam = reviews from players who bought the game on Steam (excludes key activations and free weekends).", "default": "all" }, "sortBy": { "title": "Sort / selection", "enum": [ "recent", "updated", "all" ], "type": "string", "description": "recent = newest first, updated = most recently edited first, all = Steam's helpfulness ranking. Note: Steam itself defaults 'all' to only the last 30 days unless you also set 'Last N days' below.", "default": "recent" }, "dayRange": { "title": "Last N days (helpfulness mode only)", "minimum": 1, "maximum": 365, "type": "integer", "description": "With Sort = Most helpful, restrict to reviews from the last N days (1-365). Steam applies a 30-day window by default in that mode if you leave this blank, so set it to 365 for a true all-time 'most helpful' pull. Ignored in the other sort modes, which are already chronological." }, "minPlaytimeHours": { "title": "Minimum playtime (hours)", "minimum": 0, "type": "integer", "description": "Keep only reviews from players with at least this many hours in the game — a cheap way to drop drive-by reviews." }, "keyword": { "title": "Keyword filter", "type": "string", "description": "Keep only reviews whose text contains this word or phrase (case-insensitive), e.g. \"crash\", \"controller\", \"price\"." }, "country": { "title": "Country / currency", "type": "string", "description": "Two-letter country code used for store prices and availability (us, gb, de, ...).", "default": "us" }, "includeGameInfo": { "title": "Attach game info to every review", "type": "boolean", "description": "Adds gameName, developers, publishers, genres, releaseDate and storeUrl to each review row (one extra request per game).", "default": true }, "includePlayerCount": { "title": "Include live player count", "type": "boolean", "description": "Game details only: also fetch the current concurrent player count for each game (one extra request per game).", "default": false }, "searchLimit": { "title": "Games per search term", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many games to take from each search term (max 50).", "default": 10 } } }, "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 } } } } } } } } } }