{ "openapi": "3.0.1", "info": { "title": "USCF Chess Scraper", "version": "1.0", "x-build-id": "1LOUheqZynOL4GPLb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/iqraa~uscf-chess-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-iqraa-uscf-chess-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/iqraa~uscf-chess-scraper/runs": { "post": { "operationId": "runs-sync-iqraa-uscf-chess-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/iqraa~uscf-chess-scraper/run-sync": { "post": { "operationId": "run-sync-iqraa-uscf-chess-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": { "uscfId": { "title": "USCF Member ID", "pattern": "^\\d{8}$", "type": "string", "description": "The 8-digit US Chess Federation member ID (e.g. 30665747). Required if playerName is not set." }, "playerName": { "title": "Player name", "type": "string", "description": "Search by player name (last, first) if USCF ID is unknown. Used when uscfId is empty." }, "bracketSize": { "title": "Rating bracket size", "minimum": 25, "maximum": 500, "type": "integer", "description": "Width of each opponent rating bucket for stats (e.g. 100 = 0-99, 100-199, etc.)", "default": 100 }, "includeQuick": { "title": "Include Quick rated games", "type": "boolean", "description": "Also scrape quick-rated (G/15–G/30) games", "default": false }, "includeBlitz": { "title": "Include Blitz rated games", "type": "boolean", "description": "Also scrape blitz-rated games", "default": false }, "includeOnline": { "title": "Include Online rated games", "type": "boolean", "description": "Also scrape online regular/quick/blitz games (from Chess.com)", "default": false }, "useModernApi": { "title": "Use modern USCF API", "type": "boolean", "description": "Use the modern ratings-api.uschess.org REST API as the primary data source. Falls back to legacy MSA if the API fails.", "default": true }, "usePlaywright": { "title": "Use Playwright (browser) for JS-rendered pages", "type": "boolean", "description": "Fall back to a headless browser when HTTP scraping finds no crosstable (legacy mode only).", "default": true }, "maxTournaments": { "title": "Max tournaments", "minimum": 0, "maximum": 200, "type": "integer", "description": "Maximum number of tournaments to process (0 = unlimited)", "default": 0 }, "crosstableSources": { "title": "Crosstable sources to try", "type": "array", "description": "Crosstable provider used for game-level details. Tournament history always comes from US Chess MSA.", "items": { "type": "string", "enum": [ "chessevents" ], "enumTitles": [ "CCA / chessevents.com" ] }, "default": [ "chessevents" ] } } }, "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 } } } } } } } } } }