{ "openapi": "3.0.1", "info": { "title": "Steam Reviews Scraper — Sentiment & Playtime", "description": "Steam reviews scraper for game intelligence. Filter by language, sentiment, purchase type, date, keywords, playtime, reviewer history, helpful votes, refunds, free copies, Early Access and developer responses; include game metadata, off-topic periods, weighted sentiment and only-new monitoring.", "version": "0.2", "x-build-id": "k1dBIH23gGV4Tah9G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zenomastro~steam-reviews-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zenomastro-steam-reviews-intelligence", "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/zenomastro~steam-reviews-intelligence/runs": { "post": { "operationId": "runs-sync-zenomastro-steam-reviews-intelligence", "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/zenomastro~steam-reviews-intelligence/run-sync": { "post": { "operationId": "run-sync-zenomastro-steam-reviews-intelligence", "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": [ "apps" ], "properties": { "apps": { "title": "Steam app IDs or store URLs", "minItems": 1, "maxItems": 50, "type": "array", "description": "Steam app IDs or store URLs. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": [ "730" ], "items": { "type": "string" } }, "language": { "title": "Review language", "type": "string", "description": "Review language. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": "all" }, "reviewType": { "title": "Sentiment", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "Sentiment. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": "all" }, "purchaseType": { "title": "Purchase type", "enum": [ "all", "steam", "non_steam_purchase" ], "type": "string", "description": "Purchase type. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": "all" }, "filter": { "title": "Steam sort/filter", "enum": [ "recent", "updated", "all" ], "type": "string", "description": "Steam sort/filter. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": "recent" }, "maxReviewsPerApp": { "title": "Max reviews per game", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Max reviews per game. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": 1000 }, "maxPagesPerApp": { "title": "Max API pages per game", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Max API pages per game. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": 100 }, "dateFrom": { "title": "Created on/after (YYYY-MM-DD)", "type": "string", "description": "Created on/after (YYYY-MM-DD). Configure this value to control the Actor run; bounded defaults are chosen for reliable production use." }, "dateTo": { "title": "Created before (YYYY-MM-DD)", "type": "string", "description": "Created before (YYYY-MM-DD). Configure this value to control the Actor run; bounded defaults are chosen for reliable production use." }, "includeGameInfo": { "title": "Include game metadata", "type": "boolean", "description": "Include game metadata. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": true }, "monitorKey": { "title": "Persistent monitor key", "type": "string", "description": "Persistent monitor key. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use." }, "onlyNew": { "title": "Emit only unseen review IDs", "type": "boolean", "description": "Emit only unseen review IDs. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": false }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Request timeout. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": 25 }, "retries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": 2 }, "keywords": { "title": "Review text keywords", "type": "array", "description": "Keep reviews containing at least one keyword (case-insensitive). Filtering happens before billing.", "default": [], "items": { "type": "string" } }, "minPlaytimeHours": { "title": "Minimum playtime at review (hours)", "minimum": 0, "maximum": 100000, "type": "number", "description": "Keep reviewers with at least this many hours played when the review was written.", "default": 0 }, "maxPlaytimeHours": { "title": "Maximum playtime at review (hours)", "minimum": 0, "maximum": 100000, "type": "number", "description": "Optional upper playtime bound. Leave empty for no maximum." }, "developerResponseMode": { "title": "Developer response filter", "enum": [ "all", "with_reply", "without_reply" ], "type": "string", "description": "Filter by whether Steam exposes a developer response.", "default": "all" }, "includeSummaryAnalytics": { "title": "Include sentiment/playtime analytics", "type": "boolean", "description": "Add raw vs playtime-weighted sentiment and credibility-band statistics to each game summary.", "default": true }, "minReviewsWritten": { "title": "Minimum reviewer review count", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Keep reviews from Steam accounts with at least this many reviews written.", "default": 0 }, "minGamesOwned": { "title": "Minimum games owned", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Keep reviews from accounts with at least this many owned games.", "default": 0 }, "minHelpfulVotes": { "title": "Minimum helpful votes", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Keep reviews with at least this many helpful/up votes.", "default": 0 }, "receivedForFreeMode": { "title": "Received for free", "enum": [ "all", "yes", "no" ], "type": "string", "description": "Filter using Steam's public received_for_free review flag.", "default": "all" }, "refundedMode": { "title": "Refunded review", "enum": [ "all", "yes", "no" ], "type": "string", "description": "Filter using Steam's public refunded flag.", "default": "all" }, "earlyAccessMode": { "title": "Early Access review", "enum": [ "all", "yes", "no" ], "type": "string", "description": "Filter reviews written during Early Access.", "default": "all" }, "includeOfftopicActivity": { "title": "Include off-topic activity", "type": "boolean", "description": "Pass Steam's filter_offtopic_activity=1 so review-bomb/off-topic periods are included when Steam exposes them.", "default": 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 } } } } } } } } } }