{ "openapi": "3.0.1", "info": { "title": "Kalshi Scraper — Markets, Odds, Volume & Order Books", "description": "Export live Kalshi prediction-market data as clean rows: title, Yes/No prices, implied probability, spread, 24h volume, open interest, category and close date. Returns actively traded markets, not dead auto-generated ones.", "version": "1.0", "x-build-id": "89IFZ0vgbZReGB4Dc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pixflor~kalshi-markets-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pixflor-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/pixflor~kalshi-markets-scraper/runs": { "post": { "operationId": "runs-sync-pixflor-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/pixflor~kalshi-markets-scraper/run-sync": { "post": { "operationId": "run-sync-pixflor-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", "required": [ "mode" ], "properties": { "mode": { "title": "What to scrape", "enum": [ "markets", "events" ], "type": "string", "description": "Markets returns one row per tradable contract. Events groups related contracts under one headline (e.g. a race with many candidates).", "default": "markets" }, "status": { "title": "Status", "enum": [ "open", "closed", "settled", "all" ], "type": "string", "description": "Open markets are still trading. Closed and settled markets are useful for backtesting.", "default": "open" }, "sortBy": { "title": "Sort by", "enum": [ "volume24h", "volume", "openInterest", "liquidity", "closeTime" ], "type": "string", "description": "Kalshi's API has no sort parameter, so results are collected and ranked before being returned. This is what puts genuinely active markets at the top.", "default": "volume24h" }, "category": { "title": "Category", "type": "string", "description": "Filter by Kalshi category, e.g. Politics, Elections, Economics, Financials, Sports, Companies, Climate and Weather, Entertainment, Health, Science and Technology." }, "searchQuery": { "title": "Search text", "type": "string", "description": "Only return markets whose title, subtitle, ticker or rules contain this text. Case-insensitive." }, "tickers": { "title": "Specific tickers", "type": "array", "description": "Fetch only these exact market tickers. When set, all other filters are ignored — this is watchlist mode.", "default": [], "items": { "type": "string" } }, "seriesTicker": { "title": "Series ticker", "type": "string", "description": "Restrict to a single Kalshi series, e.g. KXFED. Leave empty to scan all series." }, "minVolume24h": { "title": "Minimum 24h volume", "minimum": 0, "type": "integer", "description": "Only markets that actually traded in the last 24 hours. Set this to 1 to drop dormant markets entirely.", "default": 0 }, "minOpenInterest": { "title": "Minimum open interest", "minimum": 0, "type": "integer", "description": "Open interest is the better liveness signal on Kalshi — many real markets have open positions but no trades today.", "default": 0 }, "minLiquidity": { "title": "Minimum liquidity (USD)", "minimum": 0, "type": "integer", "description": "Skip thin markets. Note that open interest is usually the better liveness filter on Kalshi.", "default": 0 }, "closesBefore": { "title": "Closes before", "type": "string", "description": "Only markets closing before this date (YYYY-MM-DD)." }, "closesAfter": { "title": "Closes after", "type": "string", "description": "Only markets closing after this date (YYYY-MM-DD)." }, "includeOrderBook": { "title": "Include order book depth", "type": "boolean", "description": "Adds live Yes/No bid ladders per market. Slower and charged separately — leave off unless you need depth.", "default": false }, "orderBookDepth": { "title": "Order book levels", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many price levels per side to return when order books are enabled. Best prices first.", "default": 5 }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Hard cap on rows returned. This is your cost ceiling.", "default": 100 }, "useFlatMarketList": { "title": "Use the flat market list (advanced)", "type": "boolean", "description": "Off by default for a reason. Kalshi's flat /markets endpoint is dominated by inactive auto-generated combo markets with no volume and no category. Only enable this if you specifically need to enumerate every contract including dormant ones.", "default": 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 } } }, "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 } } } } } } } } } }