kalshi-typescript 3.0.0 → 3.3.0

package/docs/GetMarketCandlesticksResponse.md

@@ -1,22 +0,0 @@
-# GetMarketCandlesticksResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** | Unique identifier for the market. | [default to undefined]
-**candlesticks** | [**Array<MarketCandlestick>**](MarketCandlestick.md) | Array of candlestick data points for the specified time range. | [default to undefined]
-
-## Example
-
-```typescript
-import { GetMarketCandlesticksResponse } from 'kalshi-typescript';
-
-const instance: GetMarketCandlesticksResponse = {
-    ticker,
-    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** | [**Orderbook**](Orderbook.md) |  | [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) |  | [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) |  | [default to undefined]
-**cursor** | **string** |  | [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) |  | [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)

package/docs/GetMilestonesResponse.md

@@ -1,22 +0,0 @@
-# GetMilestonesResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**milestones** | [**Array<Milestone>**](Milestone.md) | List of milestones. | [default to undefined]
-**cursor** | **string** | Cursor for pagination. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetMilestonesResponse } from 'kalshi-typescript';
-
-const instance: GetMilestonesResponse = {
-    milestones,
-    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/GetMultivariateEventCollectionLookupHistoryResponse.md

@@ -1,20 +0,0 @@
-# GetMultivariateEventCollectionLookupHistoryResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**lookup_points** | [**Array<LookupPoint>**](LookupPoint.md) | List of recent lookup points in the collection. | [default to undefined]
-
-## Example
-
-```typescript
-import { GetMultivariateEventCollectionLookupHistoryResponse } from 'kalshi-typescript';
-
-const instance: GetMultivariateEventCollectionLookupHistoryResponse = {
-    lookup_points,
-};
-```
-
-[[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
------------- | ------------- | ------------- | -------------
-**multivariate_contract** | [**MultivariateEventCollection**](MultivariateEventCollection.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { GetMultivariateEventCollectionResponse } from 'kalshi-typescript';
-
-const instance: GetMultivariateEventCollectionResponse = {
-    multivariate_contract,
-};
-```
-
-[[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,22 +0,0 @@
-# GetMultivariateEventCollectionsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**multivariate_contracts** | [**Array<MultivariateEventCollection>**](MultivariateEventCollection.md) | List of multivariate event collections. | [default to undefined]
-**cursor** | **string** | The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetMultivariateEventCollectionsResponse } from 'kalshi-typescript';
-
-const instance: GetMultivariateEventCollectionsResponse = {
-    multivariate_contracts,
-    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/GetMultivariateEventsResponse.md

@@ -1,22 +0,0 @@
-# GetMultivariateEventsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**events** | [**Array<EventData>**](EventData.md) | Array of multivariate events matching the query criteria. | [default to undefined]
-**cursor** | **string** | Pagination cursor for the next page. Empty if there are no more results. | [default to undefined]
-
-## Example
-
-```typescript
-import { GetMultivariateEventsResponse } from 'kalshi-typescript';
-
-const instance: GetMultivariateEventsResponse = {
-    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/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 | [default to undefined]
-**orders** | **Array<string>** | List of order IDs that belong to this order group | [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,20 +0,0 @@
-# GetOrderGroupsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order_groups** | [**Array<OrderGroup>**](OrderGroup.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetOrderGroupsResponse } from 'kalshi-typescript';
-
-const instance: GetOrderGroupsResponse = {
-    order_groups,
-};
-```
-
-[[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** | The position of the order in the queue | [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/GetOrderQueuePositionsResponse.md

@@ -1,20 +0,0 @@
-# GetOrderQueuePositionsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**queue_positions** | [**Array<OrderQueuePosition>**](OrderQueuePosition.md) | Queue positions for all matching orders | [default to undefined]
-
-## Example
-
-```typescript
-import { GetOrderQueuePositionsResponse } from 'kalshi-typescript';
-
-const instance: GetOrderQueuePositionsResponse = {
-    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/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) |  | [default to undefined]
-**cursor** | **string** |  | [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/GetPortfolioRestingOrderTotalValueResponse.md

@@ -1,20 +0,0 @@
-# GetPortfolioRestingOrderTotalValueResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**total_resting_order_value** | **number** | Total value of resting orders in cents | [default to undefined]
-
-## Example
-
-```typescript
-import { GetPortfolioRestingOrderTotalValueResponse } from 'kalshi-typescript';
-
-const instance: GetPortfolioRestingOrderTotalValueResponse = {
-    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/GetPositionsResponse.md

@@ -1,24 +0,0 @@
-# GetPositionsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cursor** | **string** | The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page. | [optional] [default to undefined]
-**market_positions** | [**Array<MarketPosition>**](MarketPosition.md) | List of market positions | [optional] [default to undefined]
-**event_positions** | [**Array<EventPosition>**](EventPosition.md) | List of event positions | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetPositionsResponse } from 'kalshi-typescript';
-
-const instance: GetPositionsResponse = {
-    cursor,
-    market_positions,
-    event_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/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) |  | [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,22 +0,0 @@
-# GetQuotesResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quotes** | [**Array<Quote>**](Quote.md) | List of quotes matching the query criteria | [default to undefined]
-**cursor** | **string** | Cursor for pagination to get the next page of results | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetQuotesResponse } from 'kalshi-typescript';
-
-const instance: GetQuotesResponse = {
-    quotes,
-    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/GetRFQResponse.md

@@ -1,20 +0,0 @@
-# GetRFQResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rfq** | [**RFQ**](RFQ.md) |  | [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,22 +0,0 @@
-# GetRFQsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rfqs** | [**Array<RFQ>**](RFQ.md) | List of RFQs matching the query criteria | [default to undefined]
-**cursor** | **string** | Cursor for pagination to get the next page of results | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GetRFQsResponse } from 'kalshi-typescript';
-
-const instance: GetRFQsResponse = {
-    rfqs,
-    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/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/GetSeriesFeeChangesResponse.md

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

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