kalshi-typescript 2.1.0

package/docs/GetQuoteResponse.md

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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