All URIs are relative to https://api.elections.kalshi.com/trade-api/v2
MethodHTTP requestDescription
get_seriesGET /seriesGet Series
get_series_by_tickerGET /series/Get Series by Ticker

get_series

GetSeriesResponse get_series(status=status)
Get Series Get all market series

Example

import kalshi_python
from kalshi_python.models.get_series_response import GetSeriesResponse
from kalshi_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elections.kalshi.com/trade-api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi_python.Configuration(
    host = "https://api.elections.kalshi.com/trade-api/v2"
)

# Read private key from file
with open('path/to/private_key.pem', 'r') as f:
    private_key = f.read()

# Configure API key authentication
configuration.api_key_id = "your-api-key-id"
configuration.private_key_pem = private_key

# Initialize the Kalshi client
client = kalshi_python.KalshiClient(configuration)

status = 'status_example' # str | Filter by series status (optional)

try:
    # Get Series
    api_response = client.get_series(status=status)
    print("The response of SeriesApi->get_series:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling SeriesApi->get_series: %s\n" % e)

Parameters

NameTypeDescriptionNotes
statusstrFilter by series status[optional]

Return type

GetSeriesResponse

HTTP response details

Status codeDescription
200Series retrieved successfully
401Unauthorized - authentication required
500Internal server error
[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_series_by_ticker

GetSeriesByTickerResponse get_series_by_ticker(ticker)
Get Series by Ticker Get a single series by its ticker

Example

import kalshi_python
from kalshi_python.models.get_series_by_ticker_response import GetSeriesByTickerResponse
from kalshi_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.elections.kalshi.com/trade-api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = kalshi_python.Configuration(
    host = "https://api.elections.kalshi.com/trade-api/v2"
)

# Read private key from file
with open('path/to/private_key.pem', 'r') as f:
    private_key = f.read()

# Configure API key authentication
configuration.api_key_id = "your-api-key-id"
configuration.private_key_pem = private_key

# Initialize the Kalshi client
client = kalshi_python.KalshiClient(configuration)

ticker = 'ticker_example' # str | The series ticker

try:
    # Get Series by Ticker
    api_response = client.get_series_by_ticker(ticker)
    print("The response of SeriesApi->get_series_by_ticker:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling SeriesApi->get_series_by_ticker: %s\n" % e)

Parameters

NameTypeDescriptionNotes
tickerstrThe series ticker

Return type

GetSeriesByTickerResponse

HTTP response details

Status codeDescription
200Series retrieved successfully
401Unauthorized - authentication required
404Resource not found
500Internal server error
[Back to top] [Back to API list] [Back to Model list] [Back to README]