{ "openapi": "3.0.1", "info": { "title": "Steam Review Scraper & Analyzer", "description": "Scrape Steam game reviews with optional Claude AI analysis, get the top praised and criticized aspects per game, keyword sentiment breakdowns, and playtime-based sentiment trends.", "version": "0.0", "x-build-id": "kMohXeCa89FLCwNBy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alex_lavricheva~SteamScrape/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alex_lavricheva-SteamScrape", "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/alex_lavricheva~SteamScrape/runs": { "post": { "operationId": "runs-sync-alex_lavricheva-SteamScrape", "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/alex_lavricheva~SteamScrape/run-sync": { "post": { "operationId": "run-sync-alex_lavricheva-SteamScrape", "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": { "category": { "title": "Category", "type": "string", "description": "Steam category or tag to scrape (e.g. 'RPG', 'Souls-like')" }, "gameId": { "title": "Game IDs", "type": "array", "description": "One or more Steam App IDs to target (e.g. '730', '570')", "default": [], "items": { "type": "string" } }, "countryCode": { "title": "Country Code", "type": "string", "description": "Two-letter country code used for localized pricing and game availability (e.g. 'US', 'GB', 'DE').", "default": "US" }, "maxGames": { "title": "Max Games", "minimum": 1, "type": "integer", "description": "Maximum number of games to scrape from the category. Leave empty for no limit." }, "maxReviewsPerGame": { "title": "Max Reviews per Game", "minimum": 1, "type": "integer", "description": "Stop collecting reviews for a game after this many reviews. Leave empty for no limit. Keeping this low reduces run time and storage." }, "onSaleOnly": { "title": "On Sale Only", "type": "boolean", "description": "Only include games currently on sale. Only applies in Category mode. If no games in the category are on sale, the dataset will be empty.", "default": false }, "reviewSentiment": { "title": "Review Sentiment", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "Filter reviews by sentiment.", "default": "all" }, "minHoursPlayed": { "title": "Minimum Hours Played", "minimum": 0, "type": "number", "description": "Only include reviews from players with at least this many hours played.", "default": 0 }, "language": { "title": "Review Language", "type": "string", "description": "Only fetch reviews written in this language. Uses Steam language names: 'english', 'french', 'german', 'spanish', 'russian', 'schinese', 'tchinese', 'japanese', 'korean', 'brazilian', 'polish', etc. Defaults to 'all'.", "default": "all" }, "reviewsAfterDate": { "title": "Reviews After Date", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only include reviews posted after this date (YYYY-MM-DD). Useful for post-patch or post-launch analysis." }, "devReplied": { "title": "Developer Replied Only", "type": "boolean", "description": "If enabled, only include reviews where the developer has replied. The developer reply will be included in the output.", "default": false }, "keyword": { "title": "Keyword", "type": "string", "description": "Only include reviews that mention this keyword.", "default": "" }, "keywordSentiment": { "title": "Keyword Sentiment", "enum": [ "none", "positive", "negative" ], "type": "string", "description": "When set to positive or negative, only counts reviews where the keyword is used in that context — and skips the AI breakdown (it would be 100% trivial). Leave as 'Any' to get the full praised/criticized % breakdown via AI.", "default": "none" }, "anthropicApiKey": { "title": "Anthropic API Key", "type": "string", "description": "Your personal Anthropic API key for AI features (AI Sentiment Summary, Keyword Sentiment). If provided, takes priority over the ANTHROPIC_API_KEY preset." }, "usePresetKey": { "title": "Use preset key for AI", "type": "boolean", "description": "Use the preset key on Actor. At least one of this or the Anthropic API Key field above must be set for AI features to work.", "default": false }, "getMostCommon": { "title": "AI Sentiment Summary", "type": "boolean", "description": "Use Claude AI to analyze reviews and output a summary of the most praised and most criticised aspects per game.", "default": false }, "includeReviewsInOutput": { "title": "Include Reviews in Output", "type": "boolean", "description": "When enabled, saves all scraped reviews as OUTPUT.csv to the key-value store. Columns: gameId, gameTitle, votedUp, hoursAtReview, timestamp, devReply, text.", "default": false }, "groupByHours": { "title": "Group by Hours Played", "type": "boolean", "description": "Group reviews into hours-played brackets and show how the positive/negative sentiment split changes with playtime.", "default": false }, "groupByHoursMin": { "title": "Min Hours", "minimum": 0, "type": "number", "description": "Lower bound of the hours-played range.", "default": 0 }, "groupByHoursMax": { "title": "Max Hours", "minimum": 0, "type": "number", "description": "Upper bound of the hours-played range. Leave empty for no upper limit." } } }, "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 } } } } } } } } } }