kalshi-typescript

# LiveDataApi All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**getGameStats**](#getgamestats) | **GET** /live_data/milestone/{milestone_id}/game_stats | Get Game Stats| |[**getLiveData**](#getlivedata) | **GET** /live_data/{type}/milestone/{milestone_id} | Get Live Data (with type)| |[**getLiveDataByMilestone**](#getlivedatabymilestone) | **GET** /live_data/milestone/{milestone_id} | Get Live Data| |[**getLiveDatas**](#getlivedatas) | **GET** /live_data/batch | Get Multiple Live Data| # **getGameStats** > GetGameStatsResponse getGameStats() 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. ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **milestoneId** | [**string**] | Milestone ID | defaults to undefined| ### Return type **GetGameStatsResponse** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Game stats retrieved successfully | - | |**404** | Game stats not found | - | |**500** | Internal server error | - | # **getLiveData** > GetLiveDataResponse getLiveData() 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. ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **type** | [**string**] | Type of live data | defaults to undefined| | **milestoneId** | [**string**] | Milestone ID | defaults to undefined| | **includePlayerStats** | [**boolean**] | When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\'s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings. | (optional) defaults to false| ### Return type **GetLiveDataResponse** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Live data retrieved successfully | - | |**404** | Live data not found | - | |**500** | Internal server error | - | # **getLiveDataByMilestone** > GetLiveDataResponse getLiveDataByMilestone() Get live data for a specific milestone. ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **milestoneId** | [**string**] | Milestone ID | defaults to undefined| | **includePlayerStats** | [**boolean**] | When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\'s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings. | (optional) defaults to false| ### Return type **GetLiveDataResponse** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Live data retrieved successfully | - | |**404** | Live data not found | - | |**500** | Internal server error | - | # **getLiveDatas** > GetLiveDatasResponse getLiveDatas() Get live data for multiple milestones ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **milestoneIds** | **Array<string>** | Array of milestone IDs | defaults to undefined| | **includePlayerStats** | [**boolean**] | When true, includes player-level statistics in the live data response. Supported for Pro Football, Pro Basketball, and College Men\'s Basketball milestones that have player ID mappings configured. Has no effect for other sports or milestones without player mappings. | (optional) defaults to false| ### Return type **GetLiveDatasResponse** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Live data retrieved successfully | - | |**500** | Internal server error | - |