kalshi.MarketApi

All URIs are relative to https://trading-api.kalshi.com/v1

Method	HTTP request	Description
get_market	GET /markets/{market_id}	GetMarket
get_market_by_ticker	GET /markets_by_ticker/{ticker_name}	GetMarketByTicker
get_market_by_ticker_cached	GET /cached/markets_by_ticker/{ticker_name}	GetMarketByTickerCached
get_market_cached	GET /cached/markets/{market_id}	GetMarketCached
get_market_history	GET /markets/{market_id}/stats_history	GetMarketHistory
get_market_history_cached	GET /cached/markets/{market_id}/stats_history	GetMarketHistoryCached
get_market_order_book_cached	GET /markets/{market_id}/order_book	GetMarketOrderBookCached
get_markets	GET /markets	GetMarkets
get_markets_cached	GET /cached/markets	GetMarketsCached

get_market

UserGetMarketResponse get_market(market_id)

GetMarket

End-point for getting data about a specific market. The value for the market_id path parameter should match the id value of the target market.

Example

import time
import kalshi
from kalshi.api import market_api
from kalshi.model.user_get_market_response import UserGetMarketResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = market_api.MarketApi(api_client)
    market_id = "market_id_example" # str | Should be filled with the id of the target market

    # example passing only required values which don't have defaults set
    try:
        # GetMarket
        api_response = api_instance.get_market(market_id)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_market: %s\n" % e)

Parameters

Name	Type	Description	Notes
market_id	str	Should be filled with the id of the target market

Return type

UserGetMarketResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
401	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
403	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
404	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
500	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_market_by_ticker

UserGetMarketResponse get_market_by_ticker(ticker_name)

GetMarketByTicker

End-point for getting data about a specific market based on its ticker. The value for the ticker_name path parameter should match the ticker_name value of the target market.

Example

import time
import kalshi
from kalshi.api import market_api
from kalshi.model.user_get_market_response import UserGetMarketResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = market_api.MarketApi(api_client)
    ticker_name = "ticker_name_example" # str | Should be filled with the ticker name of the target market

    # example passing only required values which don't have defaults set
    try:
        # GetMarketByTicker
        api_response = api_instance.get_market_by_ticker(ticker_name)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_market_by_ticker: %s\n" % e)

Parameters

Name	Type	Description	Notes
ticker_name	str	Should be filled with the ticker name of the target market

Return type

UserGetMarketResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
401	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
403	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
404	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
500	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_market_by_ticker_cached

UserGetMarketResponse get_market_by_ticker_cached(ticker_name)

GetMarketByTickerCached

End-point for getting data about a specific market with data that is cached and so slightly lagged. The value for the ticker_name path parameter should match the ticker_name value of the target market.

Example

import time
import kalshi
from kalshi.api import market_api
from kalshi.model.user_get_market_response import UserGetMarketResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = market_api.MarketApi(api_client)
    ticker_name = "ticker_name_example" # str | Should be filled with the ticker name of the target market

    # example passing only required values which don't have defaults set
    try:
        # GetMarketByTickerCached
        api_response = api_instance.get_market_by_ticker_cached(ticker_name)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_market_by_ticker_cached: %s\n" % e)

Parameters

Name	Type	Description	Notes
ticker_name	str	Should be filled with the ticker name of the target market

Return type

UserGetMarketResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
401	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
403	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
404	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
500	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_market_cached

UserGetMarketResponse get_market_cached(market_id)

GetMarketCached

End-point for getting data about a specific market with data that is cached and so slightly lagged. The value for the market_id path parameter should match the id value of the target market.

Example

import time
import kalshi
from kalshi.api import market_api
from kalshi.model.user_get_market_response import UserGetMarketResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = market_api.MarketApi(api_client)
    market_id = "market_id_example" # str | Should be filled with the id of the target market

    # example passing only required values which don't have defaults set
    try:
        # GetMarketCached
        api_response = api_instance.get_market_cached(market_id)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_market_cached: %s\n" % e)

Parameters

Name	Type	Description	Notes
market_id	str	Should be filled with the id of the target market

Return type

UserGetMarketResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
401	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
403	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
404	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
500	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_market_history

GetMarketHistoryResponse get_market_history(market_id)

GetMarketHistory

End-point for getting the statistics history for a market. The value for the market_id path parameter should match the id value of the target market. The last_seen_ts parameter is optional, and will restrict statistics to those after provided timestamp. The last_seen_ts is inclusive, which means a market history point at last_seen_ts will be returned

Example

import time
import kalshi
from kalshi.api import market_api
from kalshi.model.get_market_history_response import GetMarketHistoryResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = market_api.MarketApi(api_client)
    market_id = "market_id_example" # str | Should be filled with the id of the target market
    last_seen_ts = 1 # int | If provided, restricts history to trades starting from lastSeenTs (optional)

    # example passing only required values which don't have defaults set
    try:
        # GetMarketHistory
        api_response = api_instance.get_market_history(market_id)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_market_history: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # GetMarketHistory
        api_response = api_instance.get_market_history(market_id, last_seen_ts=last_seen_ts)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_market_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
market_id	str	Should be filled with the id of the target market
last_seen_ts	int	If provided, restricts history to trades starting from lastSeenTs	[optional]

Return type

GetMarketHistoryResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
401	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
403	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
404	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
500	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_market_history_cached

GetMarketHistoryResponse get_market_history_cached(market_id)

GetMarketHistoryCached

End-point for getting the statistics history for a market with data that is cached and so slightly lagged. The value for the market_id path parameter should match the id value of the target market. The last_seen_ts parameter is optional, and will restrict statistics to those after provided timestamp. The last_seen_ts is inclusive, which means a market history point at last_seen_ts will be returned

Example

import time
import kalshi
from kalshi.api import market_api
from kalshi.model.get_market_history_response import GetMarketHistoryResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = market_api.MarketApi(api_client)
    market_id = "market_id_example" # str | Should be filled with the id of the target market
    last_seen_ts = 1 # int | If provided, restricts history to trades starting from lastSeenTs (optional)

    # example passing only required values which don't have defaults set
    try:
        # GetMarketHistoryCached
        api_response = api_instance.get_market_history_cached(market_id)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_market_history_cached: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # GetMarketHistoryCached
        api_response = api_instance.get_market_history_cached(market_id, last_seen_ts=last_seen_ts)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_market_history_cached: %s\n" % e)

Parameters

Name	Type	Description	Notes
market_id	str	Should be filled with the id of the target market
last_seen_ts	int	If provided, restricts history to trades starting from lastSeenTs	[optional]

Return type

GetMarketHistoryResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
401	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
403	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
404	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
500	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_market_order_book_cached

GetMarketOrderBookResponse get_market_order_book_cached(market_id)

GetMarketOrderBookCached

End-point for getting the orderbook for a market with data that is cached and so slightly lagged. The value for the market_id path parameter should match the id value of the target market.

Example

import time
import kalshi
from kalshi.api import market_api
from kalshi.model.get_market_order_book_response import GetMarketOrderBookResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = market_api.MarketApi(api_client)
    market_id = "market_id_example" # str | Should be filled with the id of the target market

    # example passing only required values which don't have defaults set
    try:
        # GetMarketOrderBookCached
        api_response = api_instance.get_market_order_book_cached(market_id)
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_market_order_book_cached: %s\n" % e)

Parameters

Name	Type	Description	Notes
market_id	str	Should be filled with the id of the target market

Return type

GetMarketOrderBookResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
401	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
403	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
500	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_markets

UserGetMarketsResponse get_markets()

GetMarkets

End-point for listing / discovering markets on Kalshi.

Example

import time
import kalshi
from kalshi.api import market_api
from kalshi.model.user_get_markets_response import UserGetMarketsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = market_api.MarketApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # GetMarkets
        api_response = api_instance.get_markets()
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_markets: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

UserGetMarketsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
401	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
403	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
500	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_markets_cached

UserGetMarketsResponse get_markets_cached()

GetMarketsCached

End-point for listing / discovering markets on Kalshi with data that is cached and so slightly lagged.

Example

import time
import kalshi
from kalshi.api import market_api
from kalshi.model.user_get_markets_response import UserGetMarketsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://trading-api.kalshi.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi.Configuration(
    host = "https://trading-api.kalshi.com/v1"
)


# Enter a context with an instance of the API client
with kalshi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = market_api.MarketApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # GetMarketsCached
        api_response = api_instance.get_markets_cached()
        pprint(api_response)
    except kalshi.ApiException as e:
        print("Exception when calling MarketApi->get_markets_cached: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

UserGetMarketsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
401	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
403	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -
500	JSONError is a generic structure for API error responses.	* code - * details - * message - * service -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MarketApi.md

Latest commit

History

MarketApi.md

File metadata and controls

kalshi.MarketApi

get_market

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_market_by_ticker

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_market_by_ticker_cached

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_market_cached

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_market_history

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_market_history_cached

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_market_order_book_cached

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_markets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_markets_cached

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details