Python SDK methods for Markets operations
Method | HTTP request | Description |
---|---|---|
get_market | GET /markets/ | Get Market |
get_market_candlesticks | GET /series//markets//candlesticks | Get Market Candlesticks |
get_market_orderbook | GET /markets//orderbook | Get Market Orderbook |
get_markets | GET /markets | Get Markets |
get_trades | GET /markets/trades | Get Trades |
GetMarketResponse get_market(ticker)Get Market 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.
Name | Type | Description | Notes |
---|---|---|---|
ticker | str | Market ticker |
Status code | Description |
---|---|
200 | Market retrieved successfully |
401 | Unauthorized - authentication required |
404 | Resource not found |
500 | Internal server error |
GetMarketCandlesticksResponse get_market_candlesticks(ticker, market_ticker, start_ts=start_ts, end_ts=end_ts, period_interval=period_interval)Get Market Candlesticks Get candlestick data for a market within a series
Name | Type | Description | Notes |
---|---|---|---|
ticker | str | The series ticker | |
market_ticker | str | The market ticker | |
start_ts | int | Start timestamp for the range | [optional] |
end_ts | int | End timestamp for the range | [optional] |
period_interval | str | Period interval for candlesticks (e.g., 1m, 5m, 1h, 1d) | [optional] |
Status code | Description |
---|---|
200 | Candlesticks retrieved successfully |
400 | Bad request - invalid input |
401 | Unauthorized - authentication required |
404 | Resource not found |
500 | Internal server error |
GetMarketOrderbookResponse get_market_orderbook(ticker, depth=depth)Get Market Orderbook Get the orderbook for a market
Name | Type | Description | Notes |
---|---|---|---|
ticker | str | Market ticker | |
depth | int | Depth of the orderbook to retrieve | [optional] [default to 10] |
Status code | Description |
---|---|
200 | Orderbook retrieved successfully |
401 | Unauthorized - authentication required |
404 | Resource not found |
500 | Internal server error |
GetMarketsResponse get_markets(limit=limit, cursor=cursor, event_ticker=event_ticker, series_ticker=series_ticker, max_close_ts=max_close_ts, min_close_ts=min_close_ts, status=status, tickers=tickers)Get Markets 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.
Name | Type | Description | Notes |
---|---|---|---|
limit | int | Number of results per page. Defaults to 100. Maximum value is 1000. | [optional] [default to 100] |
cursor | str | 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] |
event_ticker | str | Filter by event ticker | [optional] |
series_ticker | str | Filter by series ticker | [optional] |
max_close_ts | int | Filter items that close before this Unix timestamp | [optional] |
min_close_ts | int | Filter items that close after this Unix timestamp | [optional] |
status | str | 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] |
tickers | str | Filter by specific market tickers. Comma-separated list of market tickers to retrieve. | [optional] |
Status code | Description |
---|---|
200 | Markets retrieved successfully |
400 | Bad request - invalid input |
401 | Unauthorized - authentication required |
500 | Internal server error |
GetTradesResponse get_trades(limit=limit, cursor=cursor, ticker=ticker, min_ts=min_ts, max_ts=max_ts)Get Trades 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.
Name | Type | Description | Notes |
---|---|---|---|
limit | int | Number of results per page. Defaults to 100. Maximum value is 1000. | [optional] [default to 100] |
cursor | str | 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] |
ticker | str | Filter by market ticker | [optional] |
min_ts | int | Filter items after this Unix timestamp | [optional] |
max_ts | int | Filter items before this Unix timestamp | [optional] |
Status code | Description |
---|---|
200 | Trades retrieved successfully |
400 | Bad request - invalid input |
500 | Internal server error |