{ "openapi": "3.0.1", "info": { "title": "Kalshi Markets Scraper - Prediction Market Prices & Odds", "description": "Scrapes Kalshi prediction markets: yes/no prices, implied probability, spread, volume, open interest, close times, rules, series tags and optional orderbook and recent trades. Search by keyword, category, series, event or Kalshi URL.", "version": "1.0", "x-build-id": "BS6HgEywqHTaO8HWu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/confidential_gnat~kalshi-markets-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-confidential_gnat-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/confidential_gnat~kalshi-markets-scraper/runs": { "post": { "operationId": "runs-sync-confidential_gnat-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/confidential_gnat~kalshi-markets-scraper/run-sync": { "post": { "operationId": "run-sync-confidential_gnat-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": { "startUrls": { "title": "Kalshi URLs", "type": "array", "description": "Kalshi market pages (for example https://kalshi.com/markets/kxelonmars or https://kalshi.com/markets/kxelonmars/elon-mars/kxelonmars-99) or category pages (for example https://kalshi.com/category/crypto).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords matched against event and market titles, for example bitcoin, fed or election. Each keyword is a separate search.", "items": { "type": "string" } }, "cacheProjectName": { "title": "Cache project name", "type": "string", "description": "Use the same name on each scheduled run to get only new markets. Markets already scraped under this name are skipped and not charged, and they do not count towards Max items. Each record gets changeType: new." }, "maxItems": { "title": "Max markets per search", "minimum": 1, "type": "integer", "description": "Maximum markets saved for each URL, keyword, category, series or event.", "default": 5 }, "categories": { "title": "Categories", "type": "array", "description": "Kalshi categories, for example Politics, Economics, Crypto, Sports, Climate and Weather, Financials, Entertainment, Science and Technology.", "items": { "type": "string" } }, "seriesTickers": { "title": "Series tickers", "type": "array", "description": "Series tickers, for example KXFED or KXHIGHNY. All events of the series are scraped.", "items": { "type": "string" } }, "eventTickers": { "title": "Event tickers", "type": "array", "description": "Event tickers, for example KXELONMARS-99. All markets of the event are scraped.", "items": { "type": "string" } }, "status": { "title": "Event status", "enum": [ "open", "closed", "settled", "any" ], "type": "string", "description": "Only events with this status. Does not apply to event tickers.", "default": "open" }, "minVolume": { "title": "Minimum volume (contracts)", "minimum": 0, "type": "integer", "description": "Skip markets with lower total traded volume. 0 keeps all markets.", "default": 0 }, "includeOrderbook": { "title": "Include orderbook", "type": "boolean", "description": "Add the current yes/no bid levels (price and quantity) of each market. One extra request per market.", "default": false }, "orderbookDepth": { "title": "Orderbook depth", "minimum": 0, "type": "integer", "description": "Price levels per side when the orderbook is included. 0 returns all levels.", "default": 10 }, "tradesLimit": { "title": "Recent trades per market", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Add up to this many most recent trades of each market (max 1000). 0 turns it off.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Kalshi works without a proxy. Enable Apify Proxy only if you get blocked.", "default": { "useApifyProxy": 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 } } } } } } } } } }