{ "openapi": "3.0.1", "info": { "title": "BoardGameGeek Scraper — games, rankings, ratings & reviews", "description": "Scrape BoardGameGeek (BGG) board game data without an API key: rank, Geek rating, average rating, number of ratings, weight, player counts, play time, designers, publishers, mechanics and user reviews. Get the Hotness list, top-ranked games and games by designer or mechanic.", "version": "0.1", "x-build-id": "4QHTRmjeEu7meSkVn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/istmobot~boardgamegeek-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-istmobot-boardgamegeek-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/istmobot~boardgamegeek-scraper/runs": { "post": { "operationId": "runs-sync-istmobot-boardgamegeek-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/istmobot~boardgamegeek-scraper/run-sync": { "post": { "operationId": "run-sync-istmobot-boardgamegeek-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": [ "games", "hotness", "topRanked", "linkedItems" ], "type": "string", "description": "\"games\": the game IDs / URLs you list. \"hotness\": BGG's current Hotness list (max 50). \"topRanked\": the overall BGG ranking from #1. \"linkedItems\": all games of a designer, artist, publisher, mechanic, category or family, best-ranked first.", "default": "games" }, "gameIds": { "title": "Game IDs or BGG URLs", "type": "array", "description": "Used in \"games\" mode. Numeric IDs (174430) or URLs like https://boardgamegeek.com/boardgame/13/catan.", "items": { "type": "string" } }, "linkType": { "title": "Link type", "enum": [ "designer", "artist", "publisher", "mechanic", "category", "family" ], "type": "string", "description": "Used in \"linkedItems\" mode together with Link ID. Not needed if Link ID is a full BGG URL.", "default": "designer" }, "linkId": { "title": "Link ID or URL", "type": "string", "description": "Used in \"linkedItems\" mode. Numeric ID (2023 = Cooperative Game mechanic) or a BGG URL like https://boardgamegeek.com/boardgamedesigner/69802/isaac-childres." }, "maxItems": { "title": "Max games (listing modes)", "minimum": 1, "type": "integer", "description": "How many games to return in hotness / topRanked / linkedItems mode. Ignored in \"games\" mode.", "default": 50 }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Add the newest written user comments (username, rating, text, date) to each game.", "default": false }, "maxReviewsPerGame": { "title": "Max reviews per game", "minimum": 1, "type": "integer", "description": "Number of reviews per game when reviews are included.", "default": 20 } } }, "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 } } } } } } } } } }