kalshi-typescript 2.1.3 → 3.3.0

package/docs/GetMilestonesResponse.md

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

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

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

@@ -1,22 +0,0 @@
-# GetOrderGroupResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [optional] [default to undefined]
-**orders** | **Array<string>** | List of order IDs that belong to this order group | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetOrderGroupResponse } from 'kalshi-typescript';
-
-const instance: GetOrderGroupResponse = {
-    is_auto_cancel_enabled,
-    orders,
-};
-```
-
-[[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

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

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

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

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

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

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

@@ -1,20 +0,0 @@
-# GetQueuePositionsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**queue_positions** | **{ [key: string]: number; }** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetQueuePositionsResponse } from 'kalshi-typescript';
-
-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)

package/docs/GetQuoteResponse.md

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,22 +0,0 @@
-# LookupBundleRequestBundleInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** |  | [optional] [default to undefined]
-**markets** | **Array<string>** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { LookupBundleRequestBundleInner } from 'kalshi-typescript';
-
-const instance: LookupBundleRequestBundleInner = {
-    ticker,
-    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/LookupBundleResponse.md

@@ -1,22 +0,0 @@
-# LookupBundleResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bundle_id** | **string** |  | [optional] [default to undefined]
-**price** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { LookupBundleResponse } from 'kalshi-typescript';
-
-const instance: LookupBundleResponse = {
-    bundle_id,
-    price,
-};
-```
-
-[[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/Market.md

@@ -1,56 +0,0 @@
-# Market
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** |  | [optional] [default to undefined]
-**series_ticker** | **string** | The series this market belongs to | [optional] [default to undefined]
-**event_ticker** | **string** |  | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to undefined]
-**subtitle** | **string** |  | [optional] [default to undefined]
-**open_time** | **string** |  | [optional] [default to undefined]
-**close_time** | **string** |  | [optional] [default to undefined]
-**expiration_time** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**yes_bid** | **number** |  | [optional] [default to undefined]
-**yes_ask** | **number** |  | [optional] [default to undefined]
-**no_bid** | **number** |  | [optional] [default to undefined]
-**no_ask** | **number** |  | [optional] [default to undefined]
-**last_price** | **number** |  | [optional] [default to undefined]
-**volume** | **number** |  | [optional] [default to undefined]
-**volume_24h** | **number** |  | [optional] [default to undefined]
-**result** | **string** |  | [optional] [default to undefined]
-**can_close_early** | **boolean** |  | [optional] [default to undefined]
-**cap_count** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Market } from 'kalshi-typescript';
-
-const instance: Market = {
-    ticker,
-    series_ticker,
-    event_ticker,
-    title,
-    subtitle,
-    open_time,
-    close_time,
-    expiration_time,
-    status,
-    yes_bid,
-    yes_ask,
-    no_bid,
-    no_ask,
-    last_price,
-    volume,
-    volume_24h,
-    result,
-    can_close_early,
-    cap_count,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)