All URIs are relative to https://api.elections.kalshi.com/trade-api/v2
MethodHTTP requestDescription
getExchangeAnnouncementsGET /exchange/announcementsGet Exchange Announcements
getExchangeScheduleGET /exchange/scheduleGet Exchange Schedule
getExchangeStatusGET /exchange/statusGet Exchange Status
getUserDataTimestampGET /exchange/user_data_timestampGet User Data Timestamp

​
getExchangeAnnouncements

GetExchangeAnnouncementsResponse getExchangeAnnouncements()
Get all exchange-wide announcements

​
Example

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

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

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

​
Parameters

This endpoint does not have any parameters.

​
Return type

GetExchangeAnnouncementsResponse

​
Authorization

No authorization required

​
HTTP request headers

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

​
HTTP response details

Status codeDescriptionResponse headers
200Announcements retrieved successfully-
500Internal server error-
[Back to top] [Back to API list] [Back to Model list] [Back to README]

​
getExchangeSchedule

GetExchangeScheduleResponse getExchangeSchedule()
Get the exchange schedule

​
Example

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

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

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

​
Parameters

This endpoint does not have any parameters.

​
Return type

GetExchangeScheduleResponse

​
Authorization

No authorization required

​
HTTP request headers

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

​
HTTP response details

Status codeDescriptionResponse headers
200Schedule retrieved successfully-
500Internal server error-
[Back to top] [Back to API list] [Back to Model list] [Back to README]

​
getExchangeStatus

ExchangeStatus getExchangeStatus()
Get the exchange status

​
Example

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

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

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

​
Parameters

This endpoint does not have any parameters.

​
Return type

ExchangeStatus

​
Authorization

No authorization required

​
HTTP request headers

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

​
HTTP response details

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

​
getUserDataTimestamp

GetUserDataTimestampResponse getUserDataTimestamp()
There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions

​
Example

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

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

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

​
Parameters

This endpoint does not have any parameters.

​
Return type

GetUserDataTimestampResponse

​
Authorization

bearerAuth

​
HTTP request headers

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

​
HTTP response details

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