kalshi-typescript 2.1.3 → 3.3.0

package/docs/ExchangeApi.md

@@ -1,204 +0,0 @@
-# ExchangeApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getExchangeAnnouncements**](#getexchangeannouncements) | **GET** /exchange/announcements | Get Exchange Announcements|
-|[**getExchangeSchedule**](#getexchangeschedule) | **GET** /exchange/schedule | Get Exchange Schedule|
-|[**getExchangeStatus**](#getexchangestatus) | **GET** /exchange/status | Get Exchange Status|
-|[**getUserDataTimestamp**](#getuserdatatimestamp) | **GET** /exchange/user_data_timestamp | Get User Data Timestamp|
-
-# **getExchangeAnnouncements**
-> GetExchangeAnnouncementsResponse getExchangeAnnouncements()
-
-Get all exchange-wide announcements
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-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 code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Announcements retrieved successfully |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getExchangeSchedule**
-> GetExchangeScheduleResponse getExchangeSchedule()
-
-Get the exchange schedule
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-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 code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Schedule retrieved successfully |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getExchangeStatus**
-> ExchangeStatus getExchangeStatus()
-
-Get the exchange status
-
-### Example
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-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 code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Status retrieved successfully |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **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
-
-```typescript
-import {
-    ExchangeApi,
-    Configuration
-} from 'kalshi-typescript';
-
-const configuration = new Configuration({
-    apiKey: 'your-api-key-id',
-    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
-});
-const apiInstance = new ExchangeApi(configuration);
-
-const { status, data } = await apiInstance.getUserDataTimestamp();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**GetUserDataTimestampResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Timestamp retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**500** | Internal server error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/ExchangeStatus.md

@@ -1,22 +0,0 @@
-# ExchangeStatus
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**exchange_active** | **boolean** |  | [optional] [default to undefined]
-**trading_active** | **boolean** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ExchangeStatus } from 'kalshi-typescript';
-
-const instance: ExchangeStatus = {
-    exchange_active,
-    trading_active,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Fill.md

@@ -1,36 +0,0 @@
-# Fill
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**fill_id** | **string** |  | [optional] [default to undefined]
-**order_id** | **string** |  | [optional] [default to undefined]
-**ticker** | **string** |  | [optional] [default to undefined]
-**side** | **string** |  | [optional] [default to undefined]
-**action** | **string** |  | [optional] [default to undefined]
-**count** | **number** |  | [optional] [default to undefined]
-**price** | **number** |  | [optional] [default to undefined]
-**is_taker** | **boolean** |  | [optional] [default to undefined]
-**created_time** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Fill } from 'kalshi-typescript';
-
-const instance: Fill = {
-    fill_id,
-    order_id,
-    ticker,
-    side,
-    action,
-    count,
-    price,
-    is_taker,
-    created_time,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GenerateApiKeyRequest.md

@@ -1,20 +0,0 @@
-# GenerateApiKeyRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** | Name for the API key. This helps identify the key\'s purpose | [default to undefined]
-
-## Example
-
-```typescript
-import { GenerateApiKeyRequest } from 'kalshi-typescript';
-
-const instance: GenerateApiKeyRequest = {
-    name,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GenerateApiKeyResponse.md

@@ -1,22 +0,0 @@
-# GenerateApiKeyResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**api_key_id** | **string** | Unique identifier for the newly generated API key | [default to undefined]
-**private_key** | **string** | RSA private key in PEM format. This must be stored securely and cannot be retrieved again after this response | [default to undefined]
-
-## Example
-
-```typescript
-import { GenerateApiKeyResponse } from 'kalshi-typescript';
-
-const instance: GenerateApiKeyResponse = {
-    api_key_id,
-    private_key,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetApiKeysResponse.md

@@ -1,20 +0,0 @@
-# GetApiKeysResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**api_keys** | [**Array<ApiKey>**](ApiKey.md) | List of all API keys associated with the user | [default to undefined]
-
-## Example
-
-```typescript
-import { GetApiKeysResponse } from 'kalshi-typescript';
-
-const instance: GetApiKeysResponse = {
-    api_keys,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetBalanceResponse.md

@@ -1,20 +0,0 @@
-# GetBalanceResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**balance** | **number** | Current account balance in cents | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetBalanceResponse } from 'kalshi-typescript';
-
-const instance: GetBalanceResponse = {
-    balance,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetCommunicationsIDResponse.md

@@ -1,20 +0,0 @@
-# GetCommunicationsIDResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**communications_id** | **string** | Communications ID of the user | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetCommunicationsIDResponse } from 'kalshi-typescript';
-
-const instance: GetCommunicationsIDResponse = {
-    communications_id,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetEventMetadataResponse.md

@@ -1,20 +0,0 @@
-# GetEventMetadataResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**metadata** | **object** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetEventMetadataResponse } from 'kalshi-typescript';
-
-const instance: GetEventMetadataResponse = {
-    metadata,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetEventResponse.md

@@ -1,22 +0,0 @@
-# GetEventResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**event** | [**Event**](Event.md) |  | [optional] [default to undefined]
-**markets** | [**Array<Market>**](Market.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetEventResponse } from 'kalshi-typescript';
-
-const instance: GetEventResponse = {
-    event,
-    markets,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetEventsResponse.md

@@ -1,22 +0,0 @@
-# GetEventsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**events** | [**Array<Event>**](Event.md) |  | [optional] [default to undefined]
-**cursor** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetEventsResponse } from 'kalshi-typescript';
-
-const instance: GetEventsResponse = {
-    events,
-    cursor,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetExchangeAnnouncementsResponse.md

@@ -1,20 +0,0 @@
-# GetExchangeAnnouncementsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**announcements** | [**Array<Announcement>**](Announcement.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetExchangeAnnouncementsResponse } from 'kalshi-typescript';
-
-const instance: GetExchangeAnnouncementsResponse = {
-    announcements,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetExchangeScheduleResponse.md

@@ -1,20 +0,0 @@
-# GetExchangeScheduleResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**schedule** | [**GetExchangeScheduleResponseSchedule**](GetExchangeScheduleResponseSchedule.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetExchangeScheduleResponse } from 'kalshi-typescript';
-
-const instance: GetExchangeScheduleResponse = {
-    schedule,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetExchangeScheduleResponseSchedule.md

@@ -1,32 +0,0 @@
-# GetExchangeScheduleResponseSchedule
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**monday** | [**DailySchedule**](DailySchedule.md) |  | [optional] [default to undefined]
-**tuesday** | [**DailySchedule**](DailySchedule.md) |  | [optional] [default to undefined]
-**wednesday** | [**DailySchedule**](DailySchedule.md) |  | [optional] [default to undefined]
-**thursday** | [**DailySchedule**](DailySchedule.md) |  | [optional] [default to undefined]
-**friday** | [**DailySchedule**](DailySchedule.md) |  | [optional] [default to undefined]
-**saturday** | [**DailySchedule**](DailySchedule.md) |  | [optional] [default to undefined]
-**sunday** | [**DailySchedule**](DailySchedule.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetExchangeScheduleResponseSchedule } from 'kalshi-typescript';
-
-const instance: GetExchangeScheduleResponseSchedule = {
-    monday,
-    tuesday,
-    wednesday,
-    thursday,
-    friday,
-    saturday,
-    sunday,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetFillsResponse.md

@@ -1,22 +0,0 @@
-# GetFillsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**fills** | [**Array<Fill>**](Fill.md) |  | [optional] [default to undefined]
-**cursor** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetFillsResponse } from 'kalshi-typescript';
-
-const instance: GetFillsResponse = {
-    fills,
-    cursor,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetMarketCandlesticksResponse.md

@@ -1,20 +0,0 @@
-# GetMarketCandlesticksResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**candlesticks** | [**Array<Candlestick>**](Candlestick.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetMarketCandlesticksResponse } from 'kalshi-typescript';
-
-const instance: GetMarketCandlesticksResponse = {
-    candlesticks,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetMarketOrderbookResponse.md

@@ -1,20 +0,0 @@
-# GetMarketOrderbookResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orderbook** | [**GetMarketOrderbookResponseOrderbook**](GetMarketOrderbookResponseOrderbook.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetMarketOrderbookResponse } from 'kalshi-typescript';
-
-const instance: GetMarketOrderbookResponse = {
-    orderbook,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetMarketOrderbookResponseOrderbook.md

@@ -1,22 +0,0 @@
-# GetMarketOrderbookResponseOrderbook
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_true** | [**Array<OrderbookLevel>**](OrderbookLevel.md) |  | [optional] [default to undefined]
-**_false** | [**Array<OrderbookLevel>**](OrderbookLevel.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetMarketOrderbookResponseOrderbook } from 'kalshi-typescript';
-
-const instance: GetMarketOrderbookResponseOrderbook = {
-    _true,
-    _false,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetMarketResponse.md

@@ -1,20 +0,0 @@
-# GetMarketResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**market** | [**Market**](Market.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetMarketResponse } from 'kalshi-typescript';
-
-const instance: GetMarketResponse = {
-    market,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetMarketsResponse.md

@@ -1,22 +0,0 @@
-# GetMarketsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**markets** | [**Array<Market>**](Market.md) |  | [optional] [default to undefined]
-**cursor** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetMarketsResponse } from 'kalshi-typescript';
-
-const instance: GetMarketsResponse = {
-    markets,
-    cursor,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetMilestoneResponse.md

@@ -1,20 +0,0 @@
-# GetMilestoneResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**milestone** | [**Milestone**](Milestone.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetMilestoneResponse } from 'kalshi-typescript';
-
-const instance: GetMilestoneResponse = {
-    milestone,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)