{ "openapi": "3.0.1", "info": { "title": "Kalshi Prediction Markets Scraper — CFTC Regulated Odds, Spr", "description": "Extract CFTC-regulated prediction markets and event contracts from Kalshi. Captures YES/NO bid and ask prices, implied probabilities, bid-ask spreads, 24h and total contract volume, open interest, settlement sources, and expiration rules.", "version": "0.1", "x-build-id": "rI3KXLqke8yrdbRHm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spotless_studios~kalshi-markets-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spotless_studios-kalshi-markets-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/spotless_studios~kalshi-markets-scraper/runs": { "post": { "operationId": "runs-sync-spotless_studios-kalshi-markets-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/spotless_studios~kalshi-markets-scraper/run-sync": { "post": { "operationId": "run-sync-spotless_studios-kalshi-markets-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": { "searchQuery": { "title": "Search Keyword", "type": "string", "description": "Filter Kalshi events and markets by keyword (e.g. \"Fed\", \"Inflation\", \"Bitcoin\", \"AI\", \"Mars\", \"GDP\")." }, "category": { "title": "Category Filter", "type": "string", "description": "Filter by Kalshi event category (e.g. \"Economics\", \"Financials\", \"Politics\", \"Science and Technology\", \"Climate and Weather\"). Leave empty for all.", "default": "" }, "status": { "title": "Market Status", "enum": [ "open", "closed", "settled" ], "type": "string", "description": "Lifecycle status of Kalshi events to query.", "default": "open" }, "minVolume": { "title": "Minimum Total Volume (Contracts)", "minimum": 0, "type": "number", "description": "Only keep markets with total volume >= this number of contracts (0 = no minimum).", "default": 0 }, "minOpenInterest": { "title": "Minimum Open Interest (Contracts)", "minimum": 0, "type": "number", "description": "Only keep markets with open interest >= this number of contracts (0 = no minimum).", "default": 0 }, "seriesTickers": { "title": "Specific Series or Event Tickers (Optional)", "type": "array", "description": "Specific Kalshi series or event tickers (e.g. \"KXELONMARS-99\").", "default": [], "items": { "type": "string" } }, "includeKeywords": { "title": "Include keywords", "type": "array", "description": "Keep items whose text fields contain these words. /regex/ supported.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop items containing any of these words or /regex/.", "items": { "type": "string" } }, "keywordMatch": { "title": "Include keyword logic", "enum": [ "any", "all" ], "type": "string", "description": "Require any or all include keywords.", "default": "any" }, "onlyNewItems": { "title": "Only new items (monitoring mode)", "type": "boolean", "description": "Remember items from previous runs and save only ones not seen before.", "default": false }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Separate memory per saved search.", "default": "default" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after saving this many items.", "default": 50 }, "outputPreset": { "title": "Data preset", "enum": [ "full", "lean", "contacts" ], "type": "string", "description": "Quickly choose how much data to save per record: full record, lean summary, or contacts & links only.", "default": "full" }, "outputFields": { "title": "Output fields", "type": "array", "description": "Save only these fields, in this order. Supports nested dot-paths. Empty keeps all fields from the selected preset.", "items": { "type": "string" } }, "excludeFields": { "title": "Exclude fields", "type": "array", "description": "Remove specific fields from each saved record to keep datasets compact.", "items": { "type": "string" } }, "includeEmptyFields": { "title": "Keep empty / null fields", "type": "boolean", "description": "When turned off, strips null, empty strings, empty arrays, and empty objects from every saved record.", "default": true }, "requiredFields": { "title": "Required non-empty fields", "type": "array", "description": "Only save (and only pay for) records where every listed field has a non-empty value.", "items": { "type": "string" } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Requests fetched in parallel.", "default": 6 }, "maxRequestRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries per request.", "default": 4 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Timeout per request.", "default": 45 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional; direct connection is tried first.", "default": { "useApifyProxy": false } }, "proxyEscalation": { "title": "Auto-escalate proxies when blocked", "type": "boolean", "description": "If the site blocks the run, automatically step up from direct to Apify datacenter, then residential proxy.", "default": true } } }, "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 } } } } } } } } } }