{ "openapi": "3.0.1", "info": { "title": "Kalshi Prediction Markets Scraper", "description": "Scrapes Kalshi prediction markets by category, series, event, ticker or kalshi.com link: YES/NO bid, ask and last prices with implied probability, volume, open interest, status, close and settlement times, plus optional trades and price history.", "version": "0.0", "x-build-id": "xQyNou2DLQtmqmjgK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mina_safwat~kalshi-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mina_safwat-kalshi-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/mina_safwat~kalshi-scraper/runs": { "post": { "operationId": "runs-sync-mina_safwat-kalshi-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/mina_safwat~kalshi-scraper/run-sync": { "post": { "operationId": "run-sync-mina_safwat-kalshi-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": [ "sources" ], "properties": { "sources": { "title": "Kalshi links, tickers or categories", "type": "array", "description": "One per line. Paste a kalshi.com link to a category (https://kalshi.com/category/economics, or a sub-category such as https://kalshi.com/category/economics/fed), a series (https://kalshi.com/markets/kxfeddecision) or an event (https://kalshi.com/markets/kxfeddecision/fed-meeting/kxfeddecision-26oct). You can also type a ticker (series KXFEDDECISION, event KXFEDDECISION-26OCT or market KXFEDDECISION-26OCT-H0) or a category name (Politics, Elections, Sports, Culture, Crypto, Climate, Economics, Mentions, Companies, Financials, Science, Commodities, Health, World). Categories read their most traded series first.", "items": { "type": "string" } }, "status": { "title": "Market status", "enum": [ "open", "closed", "settled", "all" ], "type": "string", "description": "Which markets of a category, series or event to save. A market ticker you paste is always saved, whatever its status.", "default": "open" }, "max_markets": { "title": "Max markets per source", "minimum": 1, "type": "integer", "description": "Stops after this many markets for each line in Kalshi links, tickers or categories. A category reads its series with the most total volume first; for open markets, each series gives its markets traded most in the last 24 hours first. With the closed status, a category gives the markets that closed most recently first.", "default": 200 }, "include_trades": { "title": "Add recent trades", "type": "boolean", "description": "Adds the newest trades of every saved market as rows with type \"trade\": price, number of contracts, taker side and time.", "default": false }, "max_trades_per_market": { "title": "Trades per market", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many of the newest trades to save for each market, when trades are on.", "default": 100 }, "include_price_history": { "title": "Add price history", "type": "boolean", "description": "Adds price history (candlesticks) of every saved market as rows with type \"candle\": open, high, low, close and mean traded price, closing bid and ask, volume and open interest per period. Kalshi skips periods in which nothing changed.", "default": false }, "price_history_interval": { "title": "Price history interval", "enum": [ "day", "hour", "minute" ], "type": "string", "description": "Length of one price-history period. Shorter periods mean many more rows: 30 days is up to 30 daily rows, 720 hourly rows or 43,200 minute rows per market.", "default": "day" }, "price_history_days": { "title": "Price history days", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many days of price history to save, counting back from now, or from the close for a market that has already closed.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave this empty: Kalshi's public API answers the Actor directly, and if it ever refuses, the Actor retries through Apify Proxy on its own. Choose a proxy here only to send every request through it.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }