kalshi-typescript 2.1.0

package/docs/Fill.md

@@ -0,0 +1,36 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,22 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# GetBalanceResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balance** | **number** | Current account balance in cents | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetBalanceResponse } from '@kalshi/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# GetCommunicationsIDResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**communications_id** | **string** | Communications ID of the user | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetCommunicationsIDResponse } from '@kalshi/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# GetEventMetadataResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **object** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventMetadataResponse } from '@kalshi/trading-api';
+
+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

@@ -0,0 +1,22 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,22 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# GetExchangeAnnouncementsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**announcements** | [**Array<Announcement>**](Announcement.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetExchangeAnnouncementsResponse } from '@kalshi/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# GetExchangeScheduleResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schedule** | [**GetExchangeScheduleResponseSchedule**](GetExchangeScheduleResponseSchedule.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetExchangeScheduleResponse } from '@kalshi/trading-api';
+
+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

@@ -0,0 +1,32 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,22 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# GetMarketCandlesticksResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**candlesticks** | [**Array<Candlestick>**](Candlestick.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetMarketCandlesticksResponse } from '@kalshi/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# GetMarketOrderbookResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**orderbook** | [**GetMarketOrderbookResponseOrderbook**](GetMarketOrderbookResponseOrderbook.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetMarketOrderbookResponse } from '@kalshi/trading-api';
+
+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

@@ -0,0 +1,22 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# GetMarketResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market** | [**Market**](Market.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetMarketResponse } from '@kalshi/trading-api';
+
+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

@@ -0,0 +1,22 @@
+# 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/trading-api';
+
+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

@@ -0,0 +1,20 @@
+# GetMilestoneResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**milestone** | [**Milestone**](Milestone.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetMilestoneResponse } from '@kalshi/trading-api';
+
+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)

package/docs/GetMilestonesResponse.md

@@ -0,0 +1,20 @@
+# GetMilestonesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**milestones** | [**Array<Milestone>**](Milestone.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetMilestonesResponse } from '@kalshi/trading-api';
+
+const instance: GetMilestonesResponse = {
+    milestones,
+};
+```
+
+[[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/GetMultivariateEventCollectionResponse.md

@@ -0,0 +1,20 @@
+# GetMultivariateEventCollectionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**collection** | [**MultivariateEventCollection**](MultivariateEventCollection.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetMultivariateEventCollectionResponse } from '@kalshi/trading-api';
+
+const instance: GetMultivariateEventCollectionResponse = {
+    collection,
+};
+```
+
+[[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/GetMultivariateEventCollectionsResponse.md

@@ -0,0 +1,20 @@
+# GetMultivariateEventCollectionsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**collections** | [**Array<MultivariateEventCollection>**](MultivariateEventCollection.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetMultivariateEventCollectionsResponse } from '@kalshi/trading-api';
+
+const instance: GetMultivariateEventCollectionsResponse = {
+    collections,
+};
+```
+
+[[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/GetOrderGroupsResponse.md

@@ -0,0 +1,22 @@
+# GetOrderGroupsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_groups** | [**Array<OrderGroup>**](OrderGroup.md) |  | [optional] [default to undefined]
+**cursor** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetOrderGroupsResponse } from '@kalshi/trading-api';
+
+const instance: GetOrderGroupsResponse = {
+    order_groups,
+    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/GetOrderQueuePositionResponse.md

@@ -0,0 +1,20 @@
+# GetOrderQueuePositionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**queue_position** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetOrderQueuePositionResponse } from '@kalshi/trading-api';
+
+const instance: GetOrderQueuePositionResponse = {
+    queue_position,
+};
+```
+
+[[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/GetOrderResponse.md

@@ -0,0 +1,20 @@
+# GetOrderResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | [**Order**](Order.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetOrderResponse } from '@kalshi/trading-api';
+
+const instance: GetOrderResponse = {
+    order,
+};
+```
+
+[[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/GetOrdersResponse.md

@@ -0,0 +1,22 @@
+# GetOrdersResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**orders** | [**Array<Order>**](Order.md) |  | [optional] [default to undefined]
+**cursor** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetOrdersResponse } from '@kalshi/trading-api';
+
+const instance: GetOrdersResponse = {
+    orders,
+    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/GetPositionsResponse.md

@@ -0,0 +1,22 @@
+# GetPositionsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**positions** | [**Array<Position>**](Position.md) |  | [optional] [default to undefined]
+**cursor** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetPositionsResponse } from '@kalshi/trading-api';
+
+const instance: GetPositionsResponse = {
+    positions,
+    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/GetQueuePositionsRequest.md

@@ -0,0 +1,20 @@
+# GetQueuePositionsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_ids** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetQueuePositionsRequest } from '@kalshi/trading-api';
+
+const instance: GetQueuePositionsRequest = {
+    order_ids,
+};
+```
+
+[[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/GetQueuePositionsResponse.md

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