{ "openapi": "3.0.1", "info": { "title": "Steam Concurrent Players Monitor - Live Counts & History", "description": "Track Steam player counts: live top 100, daily peak chart, live count for any game, monthly and hourly history, a 12,700-game long-tail ranking and total Steam users online. Built-in change detection for scheduled monitoring.", "version": "0.0", "x-build-id": "kljTxcP3guEDK95Vk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fanndev~steam-concurrent-players-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fanndev-steam-concurrent-players-monitor", "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/fanndev~steam-concurrent-players-monitor/runs": { "post": { "operationId": "runs-sync-fanndev-steam-concurrent-players-monitor", "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/fanndev~steam-concurrent-players-monitor/run-sync": { "post": { "operationId": "run-sync-fanndev-steam-concurrent-players-monitor", "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": "What to collect", "enum": [ "topConcurrent", "topDailyPeak", "appsCurrent", "appHistory", "steamchartsTop", "steamOnline" ], "type": "string", "description": "topConcurrent = Steam's live top 100 games by players right now (+ today's peak). topDailyPeak = Steam's top 100 by yesterday's peak, with last week's rank. appsCurrent = live player count for the games you list. appHistory = player history for the games you list (monthly average/peak since launch + daily and hourly points). steamchartsTop = the long tail: up to ~12,700 games ranked by current players with 30-day peak and hours played. steamOnline = total Steam users online, last 48 hours.", "default": "topConcurrent" }, "apps": { "title": "Games (for appsCurrent / appHistory)", "type": "array", "description": "One per line: a Steam appid (730), a Steam store / SteamCharts / SteamDB app URL, or a game name (resolved through Steam store search; an exact title match wins). Only used by the appsCurrent and appHistory modes.", "items": { "type": "string" } }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 15000, "type": "integer", "description": "Maximum ranked games to return. The two official Steam charts stop at 100; steamchartsTop goes up to ~12,700.", "default": 100 }, "minPlayers": { "title": "Minimum players", "minimum": 0, "type": "integer", "description": "Skip games below this many players (current players for live charts, daily peak for topDailyPeak). 0 = no filter. In steamchartsTop the run stops at the first game below the threshold, so a high value is also a cheap way to cap the run.", "default": 0 }, "compareWithPrevious": { "title": "Compare with previous run (monitoring)", "type": "boolean", "description": "Remember each game's player count between runs and add previousPlayers, playersChange, playersChangePct, previousRank and rankChange. Schedule the actor (e.g. hourly) to turn it into a monitor. Snapshots are kept per mode in the named key-value store 'steam-players-monitor-snapshots'.", "default": true }, "alertChangePct": { "title": "Alert threshold (%)", "minimum": 0, "type": "integer", "description": "When comparing with the previous run, mark records whose player count moved by at least this percentage (up or down) with alert: true. 0 = off.", "default": 0 }, "includeStoreDetails": { "title": "Include game details", "type": "boolean", "description": "Add name, store URL, developers, publishers, release date and the raw Steam store item. Costs one extra request per 100 games for appsCurrent; free for the two official charts.", "default": true }, "includeSteamchartsStats": { "title": "Add 24h peak & all-time peak (appsCurrent)", "type": "boolean", "description": "appsCurrent only: also read SteamCharts for each game's 24-hour peak, all-time peak and last-30-days average (one extra request per game). Games SteamCharts does not track keep their live count and get steamchartsError.", "default": false }, "includeSeries": { "title": "Include time series points", "type": "boolean", "description": "appHistory: add every player-count point (monthly since launch, then daily, then hourly for the last ~30 days). steamOnline: add the 48-hour series at ~5-minute steps. Turn off to get only the summary.", "default": true }, "historyDays": { "title": "History window (days)", "minimum": 0, "type": "integer", "description": "appHistory only: keep only points and months from the last N days. 0 = full history since launch.", "default": 0 }, "country": { "title": "Store country", "type": "string", "description": "Two-letter country code used for game details (store URL, availability). Player counts are global and do not change with it.", "default": "US" }, "language": { "title": "Store language", "type": "string", "description": "Steam language name for game names and descriptions (english, german, japanese, koreana, schinese, ...).", "default": "english" }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 16, "type": "integer", "description": "Parallel requests for per-game modes and steamchartsTop pages.", "default": 5 }, "maxRetries": { "title": "Max retries per request", "minimum": 1, "maximum": 10, "type": "integer", "description": "Attempts per request with exponential backoff before a game is reported as an error.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed: none of the Steam or SteamCharts endpoints used is blocked or rate-limited for normal volumes. Turn on Apify Proxy (Residential) only if you run very large, very frequent jobs and start seeing errors.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }