kalshi-typescript
Version:
Official TypeScript SDK for the Kalshi API
101 lines (100 loc) • 3.99 kB
TypeScript
/**
* Kalshi Trading API
* Complete API for the Kalshi trading platform including all handlers for SDK generation
*
* The version of the OpenAPI document: 2.0.0
* Contact: support@kalshi.com
*
* 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 { GetSeriesByTickerResponse } from '../models';
import type { GetSeriesResponse } from '../models';
/**
* SeriesApi - axios parameter creator
*/
export declare const SeriesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get all market series
* @summary Get Series
* @param {string} [status] Filter by series status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSeries: (status?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get a single series by its ticker
* @summary Get Series by Ticker
* @param {string} ticker The series ticker
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSeriesByTicker: (ticker: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* SeriesApi - functional programming interface
*/
export declare const SeriesApiFp: (configuration?: Configuration) => {
/**
* Get all market series
* @summary Get Series
* @param {string} [status] Filter by series status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSeries(status?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesResponse>>;
/**
* Get a single series by its ticker
* @summary Get Series by Ticker
* @param {string} ticker The series ticker
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSeriesByTicker(ticker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSeriesByTickerResponse>>;
};
/**
* SeriesApi - factory interface
*/
export declare const SeriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get all market series
* @summary Get Series
* @param {string} [status] Filter by series status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSeries(status?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesResponse>;
/**
* Get a single series by its ticker
* @summary Get Series by Ticker
* @param {string} ticker The series ticker
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSeriesByTicker(ticker: string, options?: RawAxiosRequestConfig): AxiosPromise<GetSeriesByTickerResponse>;
};
/**
* SeriesApi - object-oriented interface
*/
export declare class SeriesApi extends BaseAPI {
/**
* Get all market series
* @summary Get Series
* @param {string} [status] Filter by series status
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSeries(status?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesResponse, any, {}>>;
/**
* Get a single series by its ticker
* @summary Get Series by Ticker
* @param {string} ticker The series ticker
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSeriesByTicker(ticker: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSeriesByTickerResponse, any, {}>>;
}