{ "openapi": "3.0.1", "info": { "title": "Roblox Games Scraper - Players, Visits, Charts & Stats", "description": "Scrape Roblox charts (Top Trending, Up-and-Coming, Top Playing Now...) and any experience's live players, visits, favorites, likes, creator and genre. Country/device charts and change tracking for scheduled runs. Public APIs, no login.", "version": "0.1", "x-build-id": "1RyEh8EJloGrix5TN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rjmacarthy~roblox-games-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rjmacarthy-roblox-games-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/rjmacarthy~roblox-games-scraper/runs": { "post": { "operationId": "runs-sync-rjmacarthy-roblox-games-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/rjmacarthy~roblox-games-scraper/run-sync": { "post": { "operationId": "run-sync-rjmacarthy-roblox-games-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": "What to scrape", "enum": [ "charts", "games", "search" ], "type": "string", "description": "Charts = the games on Roblox's charts (Top Trending, Up-and-Coming, ...) with their chart position. Games = your own list of experiences (e.g. a competitor watchlist). Search = keyword search (experimental: Roblox rate-limits search hard).", "default": "charts" }, "sorts": { "title": "Charts", "type": "array", "description": "Which charts to read (Charts mode). Each chart lists up to ~100 games. Each chart is read with one request.", "items": { "type": "string", "enum": [ "top-trending", "up-and-coming", "top-playing-now", "most-popular", "top-rated", "top-earning", "top-paid-access", "top-revisited", "fun-with-friends", "trending-music-experiences" ], "enumTitles": [ "Top Trending", "Up-and-Coming", "Top Playing Now", "Most Popular", "Top Rated", "Top Earning", "Top Paid Access", "Top Revisited", "Fun with Friends", "Trending Music Experiences" ] }, "default": [ "top-trending", "up-and-coming", "top-playing-now" ] }, "country": { "title": "Chart country", "type": "string", "description": "\"all\" for the global charts, or a 2-letter country code (e.g. \"us\", \"gb\", \"br\", \"de\") for that country's charts (Charts mode).", "default": "all" }, "device": { "title": "Chart device", "enum": [ "computer", "high_end_phone", "low_end_phone", "high_end_tablet", "low_end_tablet", "console", "vr" ], "type": "string", "description": "Charts differ by the device players use (Charts mode).", "default": "computer" }, "universeIds": { "title": "Universe IDs", "type": "array", "description": "Roblox universe (experience) IDs for Games mode, e.g. 994732206 (Blox Fruits), 383310974 (Adopt Me!). Up to 50 games are read per request, so long lists are cheap and fast.", "items": { "type": "string" } }, "placeIdsOrUrls": { "title": "Place IDs or game URLs", "type": "array", "description": "Game page URLs like https://www.roblox.com/games/2753915549/Blox-Fruits, or the place ID from the URL (2753915549). Each one costs one extra request to look up its universe, so use universe IDs for big lists.", "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords for Search mode, e.g. \"tycoon\" or \"horror\". Experimental: Roblox's search API rate-limits quickly (HTTP 429); such searches are reported in RUN_SUMMARY.", "items": { "type": "string" } }, "maxItems": { "title": "Max game records", "minimum": 0, "type": "integer", "description": "Maximum records for the whole run. Charts/Search: split evenly across the charts or keywords (10 over 3 charts = top 4, 3 and 3; with fewer records than charts, the extra charts are skipped). Games: total cap. 0 = no limit (each chart has at most ~100 games).", "default": 50 }, "trackDeltas": { "title": "Track changes since the previous run", "type": "boolean", "description": "Remember each game's visits, players and favorites, and add visitsDelta, playingDelta and favoritesDelta compared with the previous run. Schedule the Actor (e.g. daily) to build a time series. The first run sets the baseline (deltas are null).", "default": false }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Runs with the same monitor name share the remembered values. Use different names for independent watchlists.", "default": "default" }, "stateStoreName": { "title": "State key-value store name", "type": "string", "description": "Named key-value store in your account where the remembered values are kept (letters, digits and dashes).", "default": "roblox-games-scraper-state" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed normally. Enable Apify Proxy (datacenter) if Roblox rate-limits your runs. Residential proxies are not supported: if you pick the RESIDENTIAL group, the Actor logs a warning and uses Apify datacenter proxy instead.", "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 } } } } } } } } } }