Method | HTTP request | Description |
---|---|---|
getMarket | GET /markets/ | Get Market |
getMarketCandlesticks | GET /series//markets//candlesticks | Get Market Candlesticks |
getMarketOrderbook | GET /markets//orderbook | Get Market Orderbook |
getMarkets | GET /markets | Get Markets |
getTrades | GET /markets/trades | Get Trades |
getMarket
GetMarketResponse getMarket()Get a single market by its ticker. A market represents a specific binary outcome within an event that users can trade on (e.g., “Will candidate X win?”). Markets have yes/no positions, current prices, volume, and settlement rules.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ticker | [string] | Market ticker | defaults to undefined |
Return type
GetMarketResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Market retrieved successfully | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
getMarketCandlesticks
GetMarketCandlesticksResponse getMarketCandlesticks()Get candlestick data for a market within a series
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ticker | [string] | The series ticker | defaults to undefined |
marketTicker | [string] | The market ticker | defaults to undefined |
startTs | [number] | Start timestamp for the range | (optional) defaults to undefined |
endTs | [number] | End timestamp for the range | (optional) defaults to undefined |
periodInterval | [string] | Period interval for candlesticks (e.g., 1m, 5m, 1h, 1d) | (optional) defaults to undefined |
Return type
GetMarketCandlesticksResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Candlesticks retrieved successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
getMarketOrderbook
GetMarketOrderbookResponse getMarketOrderbook()Get the orderbook for a market
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ticker | [string] | Market ticker | defaults to undefined |
depth | [number] | Depth of the orderbook to retrieve | (optional) defaults to 10 |
Return type
GetMarketOrderbookResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Orderbook retrieved successfully | - |
401 | Unauthorized - authentication required | - |
404 | Resource not found | - |
500 | Internal server error | - |
getMarkets
GetMarketsResponse getMarkets()List and discover markets on Kalshi. A market represents a specific binary outcome within an event that users can trade on (e.g., “Will candidate X win?”). Markets have yes/no positions, current prices, volume, and settlement rules. This endpoint returns a paginated response. Use the ‘limit’ parameter to control page size (1-1000, defaults to 100). The response includes a ‘cursor’ field - pass this value in the ‘cursor’ parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
limit | [number] | Number of results per page. Defaults to 100. Maximum value is 1000. | (optional) defaults to 100 |
cursor | [string] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined |
eventTicker | [string] | Filter by event ticker | (optional) defaults to undefined |
seriesTicker | [string] | Filter by series ticker | (optional) defaults to undefined |
maxCloseTs | [number] | Filter items that close before this Unix timestamp | (optional) defaults to undefined |
minCloseTs | [number] | Filter items that close after this Unix timestamp | (optional) defaults to undefined |
status | [string] | Filter by market status. Comma-separated list. Possible values are 'initialized', 'open', 'closed', 'settled', 'determined'. Note that the API accepts 'open' for filtering but returns 'active' in the response. Leave empty to return markets with any status. | (optional) defaults to undefined |
tickers | [string] | Filter by specific market tickers. Comma-separated list of market tickers to retrieve. | (optional) defaults to undefined |
Return type
GetMarketsResponseAuthorization
bearerAuthHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Markets retrieved successfully | - |
400 | Bad request - invalid input | - |
401 | Unauthorized - authentication required | - |
500 | Internal server error | - |
getTrades
GetTradesResponse getTrades()Get all trades for all markets. A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information. This endpoint returns a paginated response. Use the ‘limit’ parameter to control page size (1-1000, defaults to 100). The response includes a ‘cursor’ field - pass this value in the ‘cursor’ parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
limit | [number] | Number of results per page. Defaults to 100. Maximum value is 1000. | (optional) defaults to 100 |
cursor | [string] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined |
ticker | [string] | Filter by market ticker | (optional) defaults to undefined |
minTs | [number] | Filter items after this Unix timestamp | (optional) defaults to undefined |
maxTs | [number] | Filter items before this Unix timestamp | (optional) defaults to undefined |
Return type
GetTradesResponseAuthorization
No authorization requiredHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Trades retrieved successfully | - |
400 | Bad request - invalid input | - |
500 | Internal server error | - |