{ "openapi": "3.0.1", "info": { "title": "Steam Store Scraper: Games, Charts & Reviews", "description": "Scrape Steam games with 84-field details, multi-country prices, reviews, charts, news, similar games, and community content. No login or API key.", "version": "0.0", "x-build-id": "hqp7K9Tuncla1e9IJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapingmonkey~steam-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapingmonkey-steam-store-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/scrapingmonkey~steam-store-scraper/runs": { "post": { "operationId": "runs-sync-scrapingmonkey-steam-store-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/scrapingmonkey~steam-store-scraper/run-sync": { "post": { "operationId": "run-sync-scrapingmonkey-steam-store-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "details", "reviews", "charts", "news", "similar", "community" ], "type": "string", "description": "Choose the dataset you want to collect.", "default": "search" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search for. Used in Search mode; maxResults applies to each term and country.", "items": { "type": "string" }, "default": [ "car simulator" ] }, "appIds": { "title": "Steam App IDs or URLs", "type": "array", "description": "Numeric Steam App IDs or full Steam Store/Community URLs. Used by Details, Reviews, News, Similar, and Community modes.", "items": { "type": "string" }, "default": [] }, "maxResults": { "title": "Maximum results", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Maximum rows per term, app, chart, or community type. Use 0 to continue until the public source ends.", "default": 50 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Independent terms, apps, regions, charts, and enrichments processed simultaneously.", "default": 8 }, "country": { "title": "Primary store country", "type": "string", "description": "Two-letter Steam region such as US, DE, JP, or PH. Controls the primary price and storefront.", "default": "US" }, "countries": { "title": "Price and discovery countries", "type": "array", "description": "Optional country list for regional price comparison and country-specific Search/Charts runs. Defaults to the primary country.", "items": { "type": "string" }, "default": [] }, "allCountries": { "title": "Compare all Steam price regions", "type": "boolean", "description": "Use every supported Steam country. This can create many requests, especially in Search and Charts modes.", "default": false }, "language": { "title": "Store language", "type": "string", "description": "ISO or Steam language code such as en, de, ru, pt-BR, zh-CN, or japanese.", "default": "en" }, "searchSort": { "title": "Search sort", "enum": [ "relevance", "releaseDate", "name", "lowestPrice", "highestPrice", "userReviews", "deckCompatibility" ], "type": "string", "description": "Steam ordering for Search mode.", "default": "relevance" }, "searchSpecialsOnly": { "title": "Discounted games only", "type": "boolean", "description": "Return Search rows currently on sale.", "default": false }, "searchFreeOnly": { "title": "Free games only", "type": "boolean", "description": "Return Search rows marked free by Steam.", "default": false }, "searchMinPrice": { "title": "Minimum search price", "minimum": 0, "type": "number", "description": "Optional minimum numeric price in the selected Steam region currency." }, "searchMaxPrice": { "title": "Maximum search price", "minimum": 0, "type": "number", "description": "Optional maximum numeric price in the selected Steam region currency." }, "searchMinDiscountPercent": { "title": "Minimum discount percent", "minimum": 0, "maximum": 100, "type": "integer", "description": "Filter Search results by current discount percentage.", "default": 0 }, "searchMinReviewScore": { "title": "Minimum positive review percentage", "minimum": 0, "maximum": 100, "type": "integer", "description": "Filter Search results by Steam's displayed positive-review percentage.", "default": 0 }, "searchMinReviews": { "title": "Minimum review count", "minimum": 0, "type": "integer", "description": "Filter Search results by displayed review count.", "default": 0 }, "searchTagIds": { "title": "Steam tag IDs", "type": "array", "description": "Optional numeric Steam tag IDs used to filter Search rows.", "items": { "type": "string" }, "default": [] }, "searchTagMatch": { "title": "Tag matching", "enum": [ "any", "all" ], "type": "string", "description": "Require any or all requested tag IDs.", "default": "any" }, "searchPlatforms": { "title": "Required platforms", "type": "array", "description": "Optional values: windows, mac, linux. Every selected platform must be available.", "items": { "type": "string" }, "default": [] }, "includeReviews": { "title": "Include reviews in Details and Charts", "type": "boolean", "description": "Embed matching public reviews in each full game record. Reviews are billed as Review events.", "default": false }, "includeSteamSpy": { "title": "Include SteamSpy metrics", "type": "boolean", "description": "Add public owner range, playtime, sentiment, tags, and concurrent-user estimates from SteamSpy.", "default": true }, "includeCurrentPlayers": { "title": "Include current players", "type": "boolean", "description": "Add Steam's current live player count to Details and Charts rows.", "default": true }, "includeNews": { "title": "Include news in Details and Charts", "type": "boolean", "description": "Embed full public announcements. Embedded items are billed as News events.", "default": false }, "includeSimilarGames": { "title": "Include similar games in Details and Charts", "type": "boolean", "description": "Embed Steam's related-game recommendations. Embedded items are billed as Similar Game events.", "default": false }, "includeCommunityMedia": { "title": "Include community content in Details and Charts", "type": "boolean", "description": "Embed selected public Steam Community cards. Embedded items are billed as Community events.", "default": false }, "reviewSort": { "title": "Review sort", "enum": [ "newest", "updated", "helpful" ], "type": "string", "description": "Review order used by Reviews mode and embedded reviews.", "default": "newest" }, "reviewType": { "title": "Review recommendation", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "Return all, positive, or negative recommendations.", "default": "all" }, "purchaseType": { "title": "Review purchase type", "enum": [ "all", "steam", "nonSteam" ], "type": "string", "description": "Filter by whether the reviewer purchased on Steam.", "default": "all" }, "reviewLanguage": { "title": "Review language", "type": "string", "description": "Review language code, or all. Independent from storefront localization.", "default": "all" }, "reviewDayRange": { "title": "Helpful-review day range", "minimum": 1, "maximum": 365, "type": "integer", "description": "Steam lookback window for helpful sorting, from 1 through 365 days.", "default": 365 }, "includeOfftopicReviews": { "title": "Include off-topic review activity", "type": "boolean", "description": "Include reviews Steam normally filters as off-topic activity.", "default": false }, "reviewsSince": { "title": "Reviews since", "type": "string", "description": "Optional inclusive review creation date in YYYY-MM-DD format." }, "reviewsUntil": { "title": "Reviews until", "type": "string", "description": "Optional inclusive review creation date in YYYY-MM-DD format." }, "reviewKeywords": { "title": "Review keywords", "type": "array", "description": "Case-insensitive keywords or phrases that must occur in review text.", "items": { "type": "string" }, "default": [] }, "reviewKeywordMatch": { "title": "Keyword matching", "enum": [ "any", "all" ], "type": "string", "description": "Require any or all review keywords.", "default": "any" }, "resolveGameNames": { "title": "Resolve game names for reviews", "type": "boolean", "description": "Add gameName to every Review row.", "default": true }, "includeAuthorProfiles": { "title": "Include public reviewer profiles", "type": "boolean", "description": "Enrich reviews with public Steam Community XML profile data.", "default": false }, "includeReviewComments": { "title": "Include review comments", "type": "boolean", "description": "Collect the public comments embedded on each review page.", "default": false }, "maxCommentsPerReview": { "title": "Maximum comments per review", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum embedded public comments per review.", "default": 10 }, "chartCollections": { "title": "Chart collections", "type": "array", "description": "Collections used in Charts mode: topSellers, newReleases, specials, comingSoon, featured.", "items": { "type": "string" }, "default": [ "topSellers" ] }, "communityTypes": { "title": "Community content types", "type": "array", "description": "Used by Community mode and Details enrichment: screenshots, videos, artwork, announcements, guides, broadcasts.", "items": { "type": "string" }, "default": [ "screenshots" ] }, "communitySort": { "title": "Community sort", "enum": [ "popular", "recent" ], "type": "string", "description": "Order public community cards by popularity trend or recency.", "default": "popular" }, "monitoring": { "title": "Enable change monitoring", "type": "boolean", "description": "Compare records with a persistent named key-value store and add new, changed, or unchanged status.", "default": false }, "monitoringOnlyChanges": { "title": "Save only new and changed rows", "type": "boolean", "description": "When monitoring is enabled, omit unchanged records from the Dataset and billing.", "default": false }, "monitorStoreName": { "title": "Monitoring state store", "type": "string", "description": "Named Apify key-value store reused across scheduled runs.", "default": "steam-games-monitor" } } }, "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 } } } } } } } } } }