kalshi-typescript/dist/api/live-data-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 { GetGameStatsResponse } from '../models';
import type { GetLiveDataResponse } from '../models';
import type { GetLiveDatasResponse } from '../models';
/**
 * LiveDataApi - axios parameter creator
 */
export declare const LiveDataApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men\'s Basketball, College Women\'s Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
     * @summary Get Game Stats
     * @param {string} milestoneId Milestone ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGameStats: (milestoneId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
     * @summary Get Live Data (with type)
     * @param {string} type Type of live data
     * @param {string} milestoneId Milestone ID
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveData: (type: string, milestoneId: string, includePlayerStats?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get live data for a specific milestone.
     * @summary Get Live Data
     * @param {string} milestoneId Milestone ID
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveDataByMilestone: (milestoneId: string, includePlayerStats?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get live data for multiple milestones
     * @summary Get Multiple Live Data
     * @param {Array<string>} milestoneIds Array of milestone IDs
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveDatas: (milestoneIds: Array<string>, includePlayerStats?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * LiveDataApi - functional programming interface
 */
export declare const LiveDataApiFp: (configuration?: Configuration) => {
    /**
     * Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men\'s Basketball, College Women\'s Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
     * @summary Get Game Stats
     * @param {string} milestoneId Milestone ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGameStats(milestoneId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetGameStatsResponse>>;
    /**
     * Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
     * @summary Get Live Data (with type)
     * @param {string} type Type of live data
     * @param {string} milestoneId Milestone ID
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveData(type: string, milestoneId: string, includePlayerStats?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLiveDataResponse>>;
    /**
     * Get live data for a specific milestone.
     * @summary Get Live Data
     * @param {string} milestoneId Milestone ID
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveDataByMilestone(milestoneId: string, includePlayerStats?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLiveDataResponse>>;
    /**
     * Get live data for multiple milestones
     * @summary Get Multiple Live Data
     * @param {Array<string>} milestoneIds Array of milestone IDs
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveDatas(milestoneIds: Array<string>, includePlayerStats?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLiveDatasResponse>>;
};
/**
 * LiveDataApi - factory interface
 */
export declare const LiveDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men\'s Basketball, College Women\'s Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
     * @summary Get Game Stats
     * @param {string} milestoneId Milestone ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGameStats(milestoneId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetGameStatsResponse>;
    /**
     * Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
     * @summary Get Live Data (with type)
     * @param {string} type Type of live data
     * @param {string} milestoneId Milestone ID
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveData(type: string, milestoneId: string, includePlayerStats?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetLiveDataResponse>;
    /**
     * Get live data for a specific milestone.
     * @summary Get Live Data
     * @param {string} milestoneId Milestone ID
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveDataByMilestone(milestoneId: string, includePlayerStats?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetLiveDataResponse>;
    /**
     * Get live data for multiple milestones
     * @summary Get Multiple Live Data
     * @param {Array<string>} milestoneIds Array of milestone IDs
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveDatas(milestoneIds: Array<string>, includePlayerStats?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<GetLiveDatasResponse>;
};
/**
 * LiveDataApi - object-oriented interface
 */
export declare class LiveDataApi extends BaseAPI {
    /**
     * Get play-by-play game statistics for a specific milestone. Supported sports: Pro Football, College Football, Pro Basketball, College Men\'s Basketball, College Women\'s Basketball, WNBA, Soccer, Pro Hockey, and Pro Baseball. Returns null for unsupported milestone types or milestones without a Sportradar ID.
     * @summary Get Game Stats
     * @param {string} milestoneId Milestone ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGameStats(milestoneId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetGameStatsResponse, any, {}>>;
    /**
     * Get live data for a specific milestone. This is the legacy endpoint that requires a type path parameter. Prefer using `/live_data/milestone/{milestone_id}` instead.
     * @summary Get Live Data (with type)
     * @param {string} type Type of live data
     * @param {string} milestoneId Milestone ID
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveData(type: string, milestoneId: string, includePlayerStats?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLiveDataResponse, any, {}>>;
    /**
     * Get live data for a specific milestone.
     * @summary Get Live Data
     * @param {string} milestoneId Milestone ID
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveDataByMilestone(milestoneId: string, includePlayerStats?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLiveDataResponse, any, {}>>;
    /**
     * Get live data for multiple milestones
     * @summary Get Multiple Live Data
     * @param {Array<string>} milestoneIds Array of milestone IDs
     * @param {boolean} [includePlayerStats] When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\&#39;s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getLiveDatas(milestoneIds: Array<string>, includePlayerStats?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLiveDatasResponse, any, {}>>;
}