{ "openapi": "3.0.1", "info": { "title": "Steam Reviews Scraper", "description": "Collect public Steam reviews from multiple games with language, sentiment, and date filters-without exposing reviewer identities.", "version": "0.1", "x-build-id": "LBQpSI4iwNFhTUqhR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/huggable_quote~steam-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-huggable_quote-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/huggable_quote~steam-reviews-scraper/runs": { "post": { "operationId": "runs-sync-huggable_quote-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/huggable_quote~steam-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-huggable_quote-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": [ "games" ], "properties": { "games": { "title": "Games (Steam URLs or app IDs)", "type": "array", "description": "One or more Steam store URLs (https://store.steampowered.com/app/1245620/...) or numeric app IDs (\"1245620\"). Invalid entries produce error records instead of failing the run.", "items": { "type": "string" } }, "maxReviewsPerGame": { "title": "Max reviews per game", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of reviews collected per game.", "default": 1000 }, "maxTotalReviews": { "title": "Max total reviews", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of reviews collected across all games in one run.", "default": 10000 }, "languages": { "title": "Review languages", "type": "array", "description": "Steam language codes (e.g. english, koreana, japanese) or [\"all\"].", "default": [ "all" ], "items": { "type": "string" } }, "reviewType": { "title": "Review type", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "Collect all, only positive, or only negative reviews.", "default": "all" }, "sortBy": { "title": "Sort order", "enum": [ "recent", "helpful" ], "type": "string", "description": "recent = newest first (required for date filtering). helpful = most helpful first.", "default": "recent" }, "dateFrom": { "title": "Date from (YYYY-MM-DD, UTC, inclusive)", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Only reviews created on or after this date. Requires sortBy=recent." }, "dateTo": { "title": "Date to (YYYY-MM-DD, UTC, inclusive)", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Only reviews created on or before this date. Requires sortBy=recent." }, "purchaseType": { "title": "Purchase type", "enum": [ "all", "steam", "non_steam_purchase" ], "type": "string", "description": "Filter by how the reviewer obtained the game.", "default": "all" }, "includeGameSummary": { "title": "Include one game summary record per game", "type": "boolean", "description": "Adds a game_summary record with review score, totals and collection stats.", "default": true }, "includePlaytimeStats": { "title": "Include anonymous reviewer playtime stats", "type": "boolean", "description": "Playtime and games-owned statistics without any author identity fields.", "default": true }, "debugLog": { "title": "Verbose page-level diagnostics", "type": "boolean", "description": "Logs one line per fetched review page (counts and anonymized cursor hashes). For troubleshooting only.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Steam works without proxies from most environments; enable datacenter proxies only if you see blocking." } } }, "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 } } } } } } } } } }