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

getSeries

GetSeriesResponse getSeries()
Get all market series

Example

import {
    SeriesApi,
    Configuration
} from '@kalshi/trading-api';

const configuration = new Configuration();
const apiInstance = new SeriesApi(configuration);

let status: string; //Filter by series status (optional) (default to undefined)

const { status, data } = await apiInstance.getSeries(
    status
);

Parameters

NameTypeDescriptionNotes
status[string]Filter by series status(optional) defaults to undefined

Return type

GetSeriesResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

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

getSeriesByTicker

GetSeriesByTickerResponse getSeriesByTicker()
Get a single series by its ticker

Example

import {
    SeriesApi,
    Configuration
} from '@kalshi/trading-api';

const configuration = new Configuration();
const apiInstance = new SeriesApi(configuration);

let ticker: string; //The series ticker (default to undefined)

const { status, data } = await apiInstance.getSeriesByTicker(
    ticker
);

Parameters

NameTypeDescriptionNotes
ticker[string]The series tickerdefaults to undefined

Return type

GetSeriesByTickerResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
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]