{ "openapi": "3.0.1", "info": { "title": "Steam Workshop Scraper", "description": "Scrape Steam Workshop mods, creators, ratings, subscribers, tags, dependencies, comments, and change links for game intelligence.", "version": "0.1", "x-build-id": "XeS428mECbQ9fu7p7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~steam-workshop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-steam-workshop-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/automation-lab~steam-workshop-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-steam-workshop-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/automation-lab~steam-workshop-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-steam-workshop-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": { "startUrls": { "title": "Steam Workshop URLs", "type": "array", "description": "Optional Steam Workshop browse/search URLs or sharedfiles/filedetails item URLs. If empty, the actor uses appIds.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "appIds": { "title": "Steam app IDs", "type": "array", "description": "Steam game/app IDs to browse. Example: 730 for Counter-Strike 2, 4000 for Garry's Mod, 108600 for Project Zomboid.", "items": { "type": "string" } }, "query": { "title": "Search query", "type": "string", "description": "Optional Workshop search text, such as map, skin, realism, or a creator/product keyword." }, "browseSort": { "title": "Browse sort", "enum": [ "trend", "mostrecent", "lastupdated", "totaluniquesubscribers", "totaluniquevisitors", "toprated" ], "type": "string", "description": "Steam Workshop sort order for generated browse URLs.", "default": "trend" }, "section": { "title": "Workshop section", "enum": [ "readytouseitems", "collections", "discussions", "guides" ], "type": "string", "description": "Steam Workshop section to browse. Most users should keep ready-to-use items.", "default": "readytouseitems" }, "requiredTags": { "title": "Required tags", "type": "array", "description": "Optional Steam Workshop tags to filter generated browse URLs, e.g. Map or CS2.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum Workshop items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum item detail records to save. Keep the prefill low for quick tests; raise it for trend monitoring.", "default": 50 }, "includeComments": { "title": "Include public comments", "type": "boolean", "description": "Fetch recent public comments from each item comment tab. This adds one extra request per item.", "default": false }, "maxCommentsPerItem": { "title": "Maximum comments per item", "minimum": 0, "maximum": 50, "type": "integer", "description": "Maximum comments saved per Workshop item when comments are enabled.", "default": 5 }, "includeDependencies": { "title": "Include dependencies and linked collections", "type": "boolean", "description": "Extract visible required items and collection links when Steam renders them on the item page.", "default": false }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of item detail pages fetched at once. Conservative defaults reduce Steam rate-limit risk.", "default": 5 } } }, "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 } } } } } } } } } }