{ "openapi": "3.0.1", "info": { "title": "Steam Store Scraper", "description": "Get structured data for Steam games and other apps from charts, keyword searches, or a list of app IDs. Each record can include descriptions, genres, tags, regional price details, review totals, and optional recent reviews. Chart and search results can include rank.", "version": "0.1", "x-build-id": "PWbgIsVOhHSs9vYms" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~steam-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-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/axiomworks~steam-store-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-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/axiomworks~steam-store-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-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", "properties": { "mode": { "title": "Mode (what to scrape)", "enum": [ "appDetails", "topSellers", "newReleases", "specials", "comingSoon", "search" ], "type": "string", "description": "Which Steam list to scrape. topSellers (default), newReleases, specials (discounted), comingSoon (upcoming) need no other field. search requires searchTerm. appDetails requires appIds or startUrls. Example: 'topSellers'. Unknown modes fail the run.", "default": "topSellers" }, "startUrls": { "title": "App URLs (appDetails mode)", "type": "array", "description": "Steam app page URLs, used only when mode is appDetails; combined with appIds. Format: https://store.steampowered.com/app//, e.g. {\"url\": \"https://store.steampowered.com/app/730/\"}. Other URLs fail the run. Unknown apps are skipped.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "appIds": { "title": "App IDs (appDetails mode)", "type": "array", "description": "Numeric Steam app IDs as strings, used only when mode is appDetails; combined with startUrls. Example: [\"730\", \"570\"]. Find the ID in the app page URL. Non-numeric values fail the run; IDs Steam does not know are skipped.", "items": { "type": "string" } }, "searchTerm": { "title": "Search term (search mode)", "type": "string", "description": "Keywords for Steam store search, used and required only when mode is search. Any language, e.g. 'strategy game' or 'ゾンビ'. No matches ends the run with 0 items and a message to change the term." }, "maxItems": { "title": "Max items (total)", "type": "integer", "description": "Maximum unique app records returned across the whole run (lists, search and all IDs share this budget), 1-1000, default 50. Example: 10. Each record is one result.", "default": 50 }, "countries": { "title": "Price countries", "type": "array", "description": "Two-letter country codes for regional prices in pricesByRegion, 1-10 codes, e.g. [\"us\", \"gb\", \"de\"]. The first code also sets the storefront for lists and search. Default us, gb, de. Invalid codes fail the run.", "items": { "type": "string" }, "default": [ "us", "gb", "de" ] }, "includeReviews": { "title": "Include review texts", "type": "boolean", "description": "If true, each record also gets recent review texts in the reviews array (up to maxReviewsPerGame). Review score summary fields are always returned. Slower when on. Default false.", "default": false }, "maxReviewsPerGame": { "title": "Reviews per app", "type": "integer", "description": "Maximum review texts per app when includeReviews is true, 0-100, default 20. Ignored when includeReviews is false.", "default": 20 }, "enrichWithAI": { "title": "Add AI market segment", "type": "boolean", "description": "If true, adds marketSegment (AAA, AA, indie, hobbyist/low-effort, free-to-play live service) to each app using a third-party AI processor; billed as an extra event per enriched result. Default false.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings for requests to Steam. Default: Apify datacenter proxy. Blocked requests are retried on a fresh proxy session.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }