kalshi-typescript 3.6.0 → 3.7.0

package/docs/GetExchangeScheduleResponse.md

@@ -0,0 +1,20 @@
+# GetExchangeScheduleResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schedule** | [**Schedule**](Schedule.md) |  | [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/GetFillsResponse.md

@@ -0,0 +1,22 @@
+# GetFillsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fills** | [**Array<Fill>**](Fill.md) |  | [default to undefined]
+**cursor** | **string** |  | [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/GetFiltersBySportsResponse.md

@@ -0,0 +1,22 @@
+# GetFiltersBySportsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filters_by_sports** | [**{ [key: string]: SportFilterDetails; }**](SportFilterDetails.md) | Mapping of sports to their filter details | [default to undefined]
+**sport_ordering** | **Array<string>** | Ordered list of sports for display | [default to undefined]
+
+## Example
+
+```typescript
+import { GetFiltersBySportsResponse } from 'kalshi-typescript';
+
+const instance: GetFiltersBySportsResponse = {
+    filters_by_sports,
+    sport_ordering,
+};
+```
+
+[[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/GetHistoricalCutoffResponse.md

@@ -0,0 +1,24 @@
+# GetHistoricalCutoffResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market_settled_ts** | **string** | Cutoff based on **market settlement time**. Markets and their candlesticks that settled before this timestamp must be accessed via `GET /historical/markets` and `GET /historical/markets/{ticker}/candlesticks`.  | [default to undefined]
+**trades_created_ts** | **string** | Cutoff based on **trade fill time**. Fills that occurred before this timestamp must be accessed via `GET /historical/fills`.  | [default to undefined]
+**orders_updated_ts** | **string** | Cutoff based on **order cancellation or execution time**. Orders canceled or fully executed before this timestamp must be accessed via `GET /historical/orders`. Resting (active) orders are always available in `GET /portfolio/orders`.  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetHistoricalCutoffResponse } from 'kalshi-typescript';
+
+const instance: GetHistoricalCutoffResponse = {
+    market_settled_ts,
+    trades_created_ts,
+    orders_updated_ts,
+};
+```
+
+[[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/GetIncentiveProgramsResponse.md

@@ -0,0 +1,22 @@
+# GetIncentiveProgramsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**incentive_programs** | [**Array<IncentiveProgram>**](IncentiveProgram.md) |  | [default to undefined]
+**next_cursor** | **string** | Cursor for pagination to get the next page of results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetIncentiveProgramsResponse } from 'kalshi-typescript';
+
+const instance: GetIncentiveProgramsResponse = {
+    incentive_programs,
+    next_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/GetLiveDataResponse.md

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

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

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

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

@@ -0,0 +1,22 @@
+# GetMarketOrderbookResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**orderbook** | [**Orderbook**](Orderbook.md) |  | [default to undefined]
+**orderbook_fp** | [**OrderbookCountFp**](OrderbookCountFp.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetMarketOrderbookResponse } from 'kalshi-typescript';
+
+const instance: GetMarketOrderbookResponse = {
+    orderbook,
+    orderbook_fp,
+};
+```
+
+[[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) |  | [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

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

@@ -0,0 +1,20 @@
+# 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

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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,20 @@
+# 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

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

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

@@ -0,0 +1,26 @@
+# GetOrderGroupResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_auto_cancel_enabled** | **boolean** | Whether auto-cancel is enabled for this order group | [default to undefined]
+**contracts_limit** | **number** | Current maximum contracts allowed over a rolling 15-second window (whole contracts only). | [optional] [default to undefined]
+**contracts_limit_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [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,
+    contracts_limit,
+    contracts_limit_fp,
+    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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,22 @@
+# GetOrderQueuePositionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**queue_position** | **number** | The position of the order in the queue | [default to undefined]
+**queue_position_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetOrderQueuePositionResponse } from 'kalshi-typescript';
+
+const instance: GetOrderQueuePositionResponse = {
+    queue_position,
+    queue_position_fp,
+};
+```
+
+[[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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,20 @@
+# 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

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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,24 @@
+# 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 | [default to undefined]
+**event_positions** | [**Array<EventPosition>**](EventPosition.md) | List of event positions | [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/GetQuoteResponse.md

@@ -0,0 +1,20 @@
+# 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

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

@@ -0,0 +1,20 @@
+# 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)