Live Data API
Access real-time market data and milestones
Live Data API
The Live Data API provides access to real-time milestone and progress data for prediction markets. These endpoints relay data directly from the Kalshi API.
Access
Methods
getLiveData
Get live data for specific milestones.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
milestoneIds | string[] | Yes | Array of milestone identifiers (max 100) |
Returns: LiveData[]
getLiveDataByEvent
Get live data for an event by ticker. Fetches all live data for an event by automatically looking up related milestones.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
eventTicker | string | Yes | The event ticker |
params.minimumStartDate | string | No | Minimum start date (RFC3339 format) |
params.category | string | No | Filter by milestone category |
params.competition | string | No | Filter by competition |
params.sourceId | string | No | Filter by source ID |
params.type | string | No | Filter by milestone type |
Returns: LiveData
getLiveDataByMint
Get live data by market mint address.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
mintAddress | string | Yes | Market mint address (ledger or outcome mint) |
params.minimumStartDate | string | No | Minimum start date (RFC3339 format) |
params.category | string | No | Filter by milestone category |
params.competition | string | No | Filter by competition |
params.sourceId | string | No | Filter by source ID |
params.type | string | No | Filter by milestone type |
Returns: LiveData
Examples
Monitor Event Live Data
Get Live Data with Filters
Get Live Data by Market Mint
WebSocket for Real-time Updates
For continuous real-time updates, consider using the WebSocket API:
See the WebSocket API for more details.