kalshi-typescript/dist/api/exchange-api.d.ts

OpenAPI client for kalshi-typescript

/**
 * Kalshi Trade API Manual Endpoints
 * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
 *
 * The version of the OpenAPI document: 3.11.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { ExchangeStatus } from '../models';
import type { GetExchangeAnnouncementsResponse } from '../models';
import type { GetExchangeScheduleResponse } from '../models';
import type { GetSeriesFeeChangesResponse } from '../models';
import type { GetUserDataTimestampResponse } from '../models';
/**
 * ExchangeApi - axios parameter creator
 */
export declare const ExchangeApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *  Endpoint for getting all exchange-wide announcements.
     * @summary Get Exchange Announcements
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeAnnouncements: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *  Endpoint for getting the exchange schedule.
     * @summary Get Exchange Schedule
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeSchedule: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *  Endpoint for getting the exchange status.
     * @summary Get Exchange Status
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get Series Fee Changes
     * @param {string} [seriesTicker]
     * @param {boolean} [showHistorical]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSeriesFeeChanges: (seriesTicker?: string, showHistorical?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *  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
     * @summary Get User Data Timestamp
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUserDataTimestamp: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ExchangeApi - functional programming interface
 */
export declare const ExchangeApiFp: (configuration?: Configuration) => {
    /**
     *  Endpoint for getting all exchange-wide announcements.
     * @summary Get Exchange Announcements
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeAnnouncements(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExchangeAnnouncementsResponse>>;
    /**
     *  Endpoint for getting the exchange schedule.
     * @summary Get Exchange Schedule
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeSchedule(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExchangeScheduleResponse>>;
    /**
     *  Endpoint for getting the exchange status.
     * @summary Get Exchange Status
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeStatus>>;
    /**
     *
     * @summary Get Series Fee Changes
     * @param {string} [seriesTicker]
     * @param {boolean} [showHistorical]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSeriesFeeChanges(seriesTicker?: string, showHistorical?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesFeeChangesResponse>>;
    /**
     *  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
     * @summary Get User Data Timestamp
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUserDataTimestamp(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserDataTimestampResponse>>;
};
/**
 * ExchangeApi - factory interface
 */
export declare const ExchangeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *  Endpoint for getting all exchange-wide announcements.
     * @summary Get Exchange Announcements
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeAnnouncements(options?: RawAxiosRequestConfig): AxiosPromise<GetExchangeAnnouncementsResponse>;
    /**
     *  Endpoint for getting the exchange schedule.
     * @summary Get Exchange Schedule
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeSchedule(options?: RawAxiosRequestConfig): AxiosPromise<GetExchangeScheduleResponse>;
    /**
     *  Endpoint for getting the exchange status.
     * @summary Get Exchange Status
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeStatus(options?: RawAxiosRequestConfig): AxiosPromise<ExchangeStatus>;
    /**
     *
     * @summary Get Series Fee Changes
     * @param {string} [seriesTicker]
     * @param {boolean} [showHistorical]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSeriesFeeChanges(seriesTicker?: string, showHistorical?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesFeeChangesResponse>;
    /**
     *  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
     * @summary Get User Data Timestamp
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUserDataTimestamp(options?: RawAxiosRequestConfig): AxiosPromise<GetUserDataTimestampResponse>;
};
/**
 * ExchangeApi - object-oriented interface
 */
export declare class ExchangeApi extends BaseAPI {
    /**
     *  Endpoint for getting all exchange-wide announcements.
     * @summary Get Exchange Announcements
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeAnnouncements(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExchangeAnnouncementsResponse, any, {}>>;
    /**
     *  Endpoint for getting the exchange schedule.
     * @summary Get Exchange Schedule
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeSchedule(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExchangeScheduleResponse, any, {}>>;
    /**
     *  Endpoint for getting the exchange status.
     * @summary Get Exchange Status
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getExchangeStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeStatus, any, {}>>;
    /**
     *
     * @summary Get Series Fee Changes
     * @param {string} [seriesTicker]
     * @param {boolean} [showHistorical]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSeriesFeeChanges(seriesTicker?: string, showHistorical?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesFeeChangesResponse, any, {}>>;
    /**
     *  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
     * @summary Get User Data Timestamp
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUserDataTimestamp(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserDataTimestampResponse, any, {}>>;
}