{ "openapi": "3.0.1", "info": { "title": "Steam Reviews Scraper | $0.85/1K + Changes", "description": "Export public Steam game reviews with recommendations, playtime, helpfulness, purchase context, and developer responses. Track scoped new and updated reviews with stable keys.", "version": "0.4", "x-build-id": "f2Moq9bzWJOyg8IO4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luminar~steam-reviews-scraper-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luminar-steam-reviews-scraper-change-monitor", "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/luminar~steam-reviews-scraper-change-monitor/runs": { "post": { "operationId": "runs-sync-luminar-steam-reviews-scraper-change-monitor", "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/luminar~steam-reviews-scraper-change-monitor/run-sync": { "post": { "operationId": "run-sync-luminar-steam-reviews-scraper-change-monitor", "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": { "workflow": { "title": "What do you want to do?", "enum": [ "export", "monitor" ], "type": "string", "description": "Export reviews once, or keep a named watch that adds included change records on repeat runs.", "default": "export" }, "games": { "title": "Steam games: App IDs or Store URLs", "minItems": 1, "maxItems": 50, "type": "array", "description": "One game per line. Example: 730 or https://store.steampowered.com/app/730/. Up to 50 games.", "items": { "type": "string" }, "default": [ "730" ] }, "reviewOrder": { "title": "Review window", "enum": [ "recent", "updated" ], "type": "string", "description": "Choose newly created or recently updated reviews within the lookback window.", "default": "recent" }, "language": { "title": "Review language", "pattern": "^(all|[a-z_]{2,32})$", "type": "string", "description": "Use all or one Steam language code such as english, german, french, spanish, brazilian, schinese, or tchinese.", "default": "all" }, "recommendation": { "title": "Recommendation", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "Return all reviews, only recommended reviews, or only not-recommended reviews.", "default": "all" }, "purchaseType": { "title": "Purchase type", "enum": [ "all", "steam", "non_steam_purchase" ], "type": "string", "description": "Filter by the source-published Steam purchase flag.", "default": "all" }, "lookbackDays": { "title": "Lookback window in days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Review window from 1 to 3,650 days for recent or updated ordering.", "default": 365 }, "includeOffTopicActivity": { "title": "Include off-topic review activity", "type": "boolean", "description": "Include periods Steam may identify as off-topic review activity. Leave off for the standard review window.", "default": false }, "maxReviewsPerGame": { "title": "Maximum reviews per game", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum current reviews to deliver for each game. Reaching this limit is reported as CAPPED.", "default": 100 }, "maxReviews": { "title": "Maximum reviews in this run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Total current-review limit across every game. Start with 100; raise it for larger exports up to 5,000.", "default": 100 }, "maxBuyerChargeUsd": { "title": "Maximum buyer charge (USD)", "minimum": 0, "maximum": 100, "type": "number", "description": "The run checks that this can cover all requested game checks and the review limit before collection. Also set Apify maximum total charge.", "default": 1 }, "maxRuntimeSecs": { "title": "Maximum collection time (seconds)", "minimum": 10, "maximum": 60, "type": "integer", "description": "Limits source collection to 10–60 seconds, with at least 60 additional seconds reserved for safe delivery and state commit.", "default": 60 }, "firstRunBehavior": { "title": "First monitoring run", "enum": [ "emit_current_as_new", "seed_only" ], "type": "string", "description": "Both options export and bill verified current reviews. This setting only changes whether the first run also returns included NEW records.", "default": "emit_current_as_new" }, "stateNamespace": { "title": "Watch name", "pattern": "^[A-Za-z0-9_-]{1,50}$", "type": "string", "description": "Keep this name and the same review scope on repeat runs. Use a new name for a separate watch. Up to 25,000 review fingerprints are retained.", "default": "default" } } }, "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 } } } } } } } } } }