{ "openapi": "3.0.1", "info": { "title": "Steam Scraper", "description": "Scrape Steam game listings, details, pricing, reviews, comments in reviews, news, media, developer info, and similar games. Supports pagination, search, and flexible per-game data collection.", "version": "1.0", "x-build-id": "TAIj9FiOlAavVQU3W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sallbro~steam-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sallbro-steam-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/sallbro~steam-scraper/runs": { "post": { "operationId": "runs-sync-sallbro-steam-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/sallbro~steam-scraper/run-sync": { "post": { "operationId": "run-sync-sallbro-steam-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": { "sectionWhatToScrape": { "title": "🎮 What to scrape", "type": "object", "description": "Provide game identifiers in any format: app IDs, Steam store URLs, or search by game name. Leave all three empty to scrape the Steam popular-new catalog by page." }, "appIds": { "title": "App IDs", "type": "array", "description": "Steam App IDs to scrape. Example: [570, 730, 1091500]. If none provided, catalog pagination is used instead.", "default": [], "items": { "type": "string" } }, "steamUrls": { "title": "Steam Store URLs", "type": "array", "description": "Full Steam store URLs. The App ID is extracted automatically. Example: https://store.steampowered.com/app/1091500/Cyberpunk_2077/", "default": [], "items": { "type": "string" } }, "searchNames": { "title": "Search by game name", "type": "array", "description": "Game names to search for. The first matching result is used. Example: [\"Dota 2\", \"CS2\"]", "default": [], "items": { "type": "string" } }, "currency": { "title": "Currency", "enum": [ "US", "IN" ], "type": "string", "description": "Currency for all scraped prices.", "default": "US" }, "startPage": { "title": "Start Page", "minimum": 1, "type": "integer", "description": "Catalog page to start from. Only used when no app IDs, URLs, or names are provided. Each page returns ~50 games.", "default": 1 }, "maxPages": { "title": "Max Pages", "minimum": 1, "maximum": 200, "type": "integer", "description": "Max catalog pages to paginate. Only used when no identifiers are provided.", "default": 2 }, "freeGamesOnly": { "title": "Free Games Only", "type": "boolean", "description": "When paginating the catalog, only keep free-to-play games.", "default": false }, "includeDetails": { "title": "Include Details", "type": "boolean", "description": "Include developer info, publisher, franchise, external links (website / YouTube / X / Instagram / Facebook), supported languages, genres, and full about-the-game text.", "default": true }, "includeSystemReq": { "title": "Include System Requirements", "type": "boolean", "description": "Include minimum and recommended system requirements for Windows, Linux, and macOS.", "default": true }, "includeSimilarGames": { "title": "Include Similar Games", "type": "boolean", "description": "Scrape Steam's 'More Like This' recommendations for each game.", "default": false }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Scrape user reviews. Configure sort order, sentiment, and language below.", "default": false }, "includeNews": { "title": "Include News", "type": "boolean", "description": "Scrape news and announcements. Configure category and pages below.", "default": false }, "includeMedia": { "title": "Include Media", "type": "boolean", "description": "Scrape screenshots, videos, artwork, and broadcasts. Configure which types and how many below.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify proxy settings. Recommended for large catalog runs (500+ games).", "default": { "useApifyProxy": true } }, "sectionReviewFilters": { "title": "🔍 Review Filters", "type": "object", "description": "Controls which reviews to scrape. Only applies when Include Reviews is enabled." }, "reviewCategory": { "title": "Review Sort Order", "enum": [ "toprated", "mostrecent", "trendday", "trendweek", "trendmonth", "trendyear", "funny" ], "type": "string", "description": "How to sort the scraped reviews.", "default": "toprated" }, "reviewType": { "title": "Review Type", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "Filter reviews by sentiment.", "default": "all" }, "reviewLanguage": { "title": "Review Language", "enum": [ "english", "spanish", "french", "german", "portuguese", "russian", "japanese", "koreana", "schinese", "tchinese" ], "type": "string", "description": "Filter reviews by language.", "default": "english" }, "reviewStartPage": { "title": "Review Start Page", "minimum": 1, "type": "integer", "description": "Which review page to start from (1-based). Each page has 10 reviews.", "default": 1 }, "reviewMaxPages": { "title": "Review Max Pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of review pages to fetch. 1 page = 10 reviews.", "default": 1 }, "includeComments": { "title": "Review Filters — Include Comments", "type": "boolean", "description": "Fetch comments for each review. Adds extra requests per review — use a lower Max Pages when enabled.", "default": false }, "commentStartPage": { "title": "Review Filters — Comments Start Page", "minimum": 1, "type": "integer", "description": "Which comments page to start from (1-based). Each page has 10 comments.", "default": 1 }, "commentMaxPages": { "title": "Review Filters — Comments Max Pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of comments pages to fetch. Only applies when Include Comments is enabled. 1 page = 10 comments.", "default": 1 }, "sectionNewsFilters": { "title": "📰 News Filters", "type": "object", "description": "Controls which news to scrape. Only applies when Include News is enabled." }, "newsCategory": { "title": "News Category", "enum": [ "all", "announcements", "syndicated" ], "type": "string", "description": "Type of news articles to fetch.", "default": "all" }, "newsLanguage": { "title": "News Language", "enum": [ "english", "spanish", "french", "german", "portuguese", "russian", "japanese", "koreana", "schinese", "tchinese" ], "type": "string", "description": "Filter news articles by language.", "default": "english" }, "newsStartPage": { "title": "News Start Page", "minimum": 1, "type": "integer", "description": "Which news page to start from (1-based). Each page has 10 items.", "default": 1 }, "newsMaxPages": { "title": "News Max Pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of news pages to fetch. 1 page = 10 news items.", "default": 1 }, "sectionMediaFilters": { "title": "🖼️ Media Filters", "type": "object", "description": "Controls which media to scrape. Only applies when Include Media is enabled." }, "mediaCategory": { "title": "Media Category", "enum": [ "all", "screenshots", "videos", "artwork", "broadcasts" ], "type": "string", "description": "Which media types to fetch.", "default": "all" }, "mediaStartPage": { "title": "Media Start Page", "minimum": 1, "type": "integer", "description": "Which media page to start from (1-based). Each page has 10 items.", "default": 1 }, "mediaMaxPages": { "title": "Media Max Pages", "minimum": 1, "maximum": 5, "type": "integer", "description": "Number of media pages to fetch per type. 1 page = 10 items.", "default": 1 } } }, "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 } } } } } } } } } }