kalshi-typescript 2.1.0 → 2.1.2

package/docs/BatchCancelOrdersResponseResponsesInner.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { BatchCancelOrdersResponseResponsesInner } from '@kalshi/trading-api';
+import { BatchCancelOrdersResponseResponsesInner } from 'kalshi-typescript';
 
 const instance: BatchCancelOrdersResponseResponsesInner = {
     order_id,

package/docs/BatchCreateOrdersRequest.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { BatchCreateOrdersRequest } from '@kalshi/trading-api';
+import { BatchCreateOrdersRequest } from 'kalshi-typescript';
 
 const instance: BatchCreateOrdersRequest = {
     orders,

package/docs/BatchCreateOrdersResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { BatchCreateOrdersResponse } from '@kalshi/trading-api';
+import { BatchCreateOrdersResponse } from 'kalshi-typescript';
 
 const instance: BatchCreateOrdersResponse = {
     responses,

package/docs/BatchCreateOrdersResponseResponsesInner.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { BatchCreateOrdersResponseResponsesInner } from '@kalshi/trading-api';
+import { BatchCreateOrdersResponseResponsesInner } from 'kalshi-typescript';
 
 const instance: BatchCreateOrdersResponseResponsesInner = {
     order,

package/docs/CancelOrderResponse.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { CancelOrderResponse } from '@kalshi/trading-api';
+import { CancelOrderResponse } from 'kalshi-typescript';
 
 const instance: CancelOrderResponse = {
     order,

package/docs/Candlestick.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { Candlestick } from '@kalshi/trading-api';
+import { Candlestick } from 'kalshi-typescript';
 
 const instance: Candlestick = {
     start_ts,

package/docs/CommunicationsApi.md

@@ -28,9 +28,12 @@ import {
     CommunicationsApi,
     Configuration,
     AcceptQuoteRequest
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 let quoteId: string; //Quote ID (default to undefined)
@@ -86,9 +89,12 @@ Confirm a quote. This will start a timer for order execution
 import {
     CommunicationsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 let quoteId: string; //Quote ID (default to undefined)
@@ -141,9 +147,12 @@ import {
     CommunicationsApi,
     Configuration,
     CreateQuoteRequest
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 let createQuoteRequest: CreateQuoteRequest; //
@@ -196,9 +205,12 @@ import {
     CommunicationsApi,
     Configuration,
     CreateRFQRequest
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 let createRFQRequest: CreateRFQRequest; //
@@ -250,9 +262,12 @@ Delete a quote, which means it can no longer be accepted
 import {
     CommunicationsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 let quoteId: string; //Quote ID (default to undefined)
@@ -304,9 +319,12 @@ Delete an RFQ by ID
 import {
     CommunicationsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 let rfqId: string; //RFQ ID (default to undefined)
@@ -358,9 +376,12 @@ Get the communications ID of the logged-in user
 import {
     CommunicationsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 const { status, data } = await apiInstance.getCommunicationsID();
@@ -404,9 +425,12 @@ Get a particular quote by ID
 import {
     CommunicationsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 let quoteId: string; //Quote ID (default to undefined)
@@ -458,9 +482,12 @@ Retrieve all quotes
 import {
     CommunicationsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 const { status, data } = await apiInstance.getQuotes();
@@ -504,9 +531,12 @@ Get a single RFQ by ID
 import {
     CommunicationsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 let rfqId: string; //RFQ ID (default to undefined)
@@ -558,9 +588,12 @@ Retrieve all RFQs
 import {
     CommunicationsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new CommunicationsApi(configuration);
 
 const { status, data } = await apiInstance.getRFQs();

package/docs/CreateApiKeyRequest.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { CreateApiKeyRequest } from '@kalshi/trading-api';
+import { CreateApiKeyRequest } from 'kalshi-typescript';
 
 const instance: CreateApiKeyRequest = {
     name,

package/docs/CreateApiKeyResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { CreateApiKeyResponse } from '@kalshi/trading-api';
+import { CreateApiKeyResponse } from 'kalshi-typescript';
 
 const instance: CreateApiKeyResponse = {
     api_key_id,

package/docs/CreateOrderGroupRequest.md

@@ -5,15 +5,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** |  | [default to undefined]
+**contracts_limit** | **number** | Specifies the maximum number of contracts that can be matched within this group. | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { CreateOrderGroupRequest } from '@kalshi/trading-api';
+import { CreateOrderGroupRequest } from 'kalshi-typescript';
 
 const instance: CreateOrderGroupRequest = {
-    name,
+    contracts_limit,
 };
 ```
 

package/docs/CreateOrderGroupResponse.md

@@ -5,15 +5,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**order_group** | [**OrderGroup**](OrderGroup.md) |  | [optional] [default to undefined]
+**order_group_id** | **string** | The unique identifier for the created order group | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { CreateOrderGroupResponse } from '@kalshi/trading-api';
+import { CreateOrderGroupResponse } from 'kalshi-typescript';
 
 const instance: CreateOrderGroupResponse = {
-    order_group,
+    order_group_id,
 };
 ```
 

package/docs/CreateOrderRequest.md

@@ -16,11 +16,13 @@ Name | Type | Description | Notes
 **expiration_ts** | **number** |  | [optional] [default to undefined]
 **sell_position_floor** | **number** |  | [optional] [default to undefined]
 **buy_max_cost** | **number** |  | [optional] [default to undefined]
+**post_only** | **boolean** | If set to true, the order will be rejected if it crosses the spread and executes immediately | [optional] [default to undefined]
+**order_group_id** | **string** | OrderGroupId specifies the order group this order is part of | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { CreateOrderRequest } from '@kalshi/trading-api';
+import { CreateOrderRequest } from 'kalshi-typescript';
 
 const instance: CreateOrderRequest = {
     ticker,
@@ -34,6 +36,8 @@ const instance: CreateOrderRequest = {
     expiration_ts,
     sell_position_floor,
     buy_max_cost,
+    post_only,
+    order_group_id,
 };
 ```
 

package/docs/CreateOrderResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { CreateOrderResponse } from '@kalshi/trading-api';
+import { CreateOrderResponse } from 'kalshi-typescript';
 
 const instance: CreateOrderResponse = {
     order,

package/docs/CreateQuoteRequest.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { CreateQuoteRequest } from '@kalshi/trading-api';
+import { CreateQuoteRequest } from 'kalshi-typescript';
 
 const instance: CreateQuoteRequest = {
     rfq_id,

package/docs/CreateQuoteResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { CreateQuoteResponse } from '@kalshi/trading-api';
+import { CreateQuoteResponse } from 'kalshi-typescript';
 
 const instance: CreateQuoteResponse = {
     quote,

package/docs/CreateRFQRequest.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { CreateRFQRequest } from '@kalshi/trading-api';
+import { CreateRFQRequest } from 'kalshi-typescript';
 
 const instance: CreateRFQRequest = {
     ticker,

package/docs/CreateRFQResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { CreateRFQResponse } from '@kalshi/trading-api';
+import { CreateRFQResponse } from 'kalshi-typescript';
 
 const instance: CreateRFQResponse = {
     rfq,

package/docs/DailySchedule.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { DailySchedule } from '@kalshi/trading-api';
+import { DailySchedule } from 'kalshi-typescript';
 
 const instance: DailySchedule = {
     open_time,

package/docs/DecreaseOrderRequest.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { DecreaseOrderRequest } from '@kalshi/trading-api';
+import { DecreaseOrderRequest } from 'kalshi-typescript';
 
 const instance: DecreaseOrderRequest = {
     reduce_by,

package/docs/DecreaseOrderResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { DecreaseOrderResponse } from '@kalshi/trading-api';
+import { DecreaseOrderResponse } from 'kalshi-typescript';
 
 const instance: DecreaseOrderResponse = {
     order,

package/docs/ErrorResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { ErrorResponse } from '@kalshi/trading-api';
+import { ErrorResponse } from 'kalshi-typescript';
 
 const instance: ErrorResponse = {
     error,

package/docs/ErrorResponseError.md

@@ -7,12 +7,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** | Error code | [default to undefined]
 **message** | **string** | Error message | [default to undefined]
-**details** | **object** | Additional error details | [optional] [default to undefined]
+**details** | **string** | Additional error details | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { ErrorResponseError } from '@kalshi/trading-api';
+import { ErrorResponseError } from 'kalshi-typescript';
 
 const instance: ErrorResponseError = {
     code,

package/docs/Event.md

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { Event } from '@kalshi/trading-api';
+import { Event } from 'kalshi-typescript';
 
 const instance: Event = {
     event_ticker,

package/docs/EventPosition.md

@@ -0,0 +1,38 @@
+# EventPosition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_ticker** | **string** | Unique identifier for events. | [optional] [default to undefined]
+**total_cost** | **number** | Total spent on this event in cents. | [optional] [default to undefined]
+**total_cost_dollars** | **string** | Total spent on this event in dollars. | [optional] [default to undefined]
+**event_exposure** | **number** | Cost of the aggregate event position in cents. | [optional] [default to undefined]
+**event_exposure_dollars** | **string** | Cost of the aggregate event position in dollars. | [optional] [default to undefined]
+**realized_pnl** | **number** | Locked in profit and loss, in cents. | [optional] [default to undefined]
+**realized_pnl_dollars** | **string** | Locked in profit and loss, in dollars. | [optional] [default to undefined]
+**resting_order_count** | **number** | Aggregate size of resting orders in contract units. | [optional] [default to undefined]
+**fees_paid** | **number** | Fees paid on fill orders, in cents. | [optional] [default to undefined]
+**fees_paid_dollars** | **string** | Fees paid on fill orders, in dollars. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventPosition } from 'kalshi-typescript';
+
+const instance: EventPosition = {
+    event_ticker,
+    total_cost,
+    total_cost_dollars,
+    event_exposure,
+    event_exposure_dollars,
+    realized_pnl,
+    realized_pnl_dollars,
+    resting_order_count,
+    fees_paid,
+    fees_paid_dollars,
+};
+```
+
+[[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/EventsApi.md

@@ -19,9 +19,12 @@ Get data about an event by its ticker.  An event represents a real-world occurre
 import {
     EventsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new EventsApi(configuration);
 
 let eventTicker: string; //Event ticker (default to undefined)
@@ -76,9 +79,12 @@ Get metadata about an event by its ticker
 import {
     EventsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new EventsApi(configuration);
 
 let eventTicker: string; //Event ticker (default to undefined)
@@ -130,9 +136,12 @@ Get data about all events.  An event represents a real-world occurrence that can
 import {
     EventsApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new EventsApi(configuration);
 
 let limit: number; //Number of results per page. Defaults to 100. Maximum value is 200. (optional) (default to 100)

package/docs/ExchangeApi.md

@@ -20,9 +20,12 @@ Get all exchange-wide announcements
 import {
     ExchangeApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new ExchangeApi(configuration);
 
 const { status, data } = await apiInstance.getExchangeAnnouncements();
@@ -65,9 +68,12 @@ Get the exchange schedule
 import {
     ExchangeApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new ExchangeApi(configuration);
 
 const { status, data } = await apiInstance.getExchangeSchedule();
@@ -110,9 +116,12 @@ Get the exchange status
 import {
     ExchangeApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new ExchangeApi(configuration);
 
 const { status, data } = await apiInstance.getExchangeStatus();
@@ -147,7 +156,7 @@ No authorization required
 # **getUserDataTimestamp**
 > GetUserDataTimestampResponse getUserDataTimestamp()
 
-There is typically a short delay before exchange events are reflected in the API endpoints.  Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state.  This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions 
+There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions 
 
 ### Example
 
@@ -155,9 +164,12 @@ There is typically a short delay before exchange events are reflected in the API
 import {
     ExchangeApi,
     Configuration
-} from '@kalshi/trading-api';
+} from 'kalshi-typescript';
 
-const configuration = new Configuration();
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
 const apiInstance = new ExchangeApi(configuration);
 
 const { status, data } = await apiInstance.getUserDataTimestamp();

package/docs/ExchangeStatus.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { ExchangeStatus } from '@kalshi/trading-api';
+import { ExchangeStatus } from 'kalshi-typescript';
 
 const instance: ExchangeStatus = {
     exchange_active,

package/docs/Fill.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { Fill } from '@kalshi/trading-api';
+import { Fill } from 'kalshi-typescript';
 
 const instance: Fill = {
     fill_id,

package/docs/GenerateApiKeyRequest.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { GenerateApiKeyRequest } from '@kalshi/trading-api';
+import { GenerateApiKeyRequest } from 'kalshi-typescript';
 
 const instance: GenerateApiKeyRequest = {
     name,

package/docs/GenerateApiKeyResponse.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { GenerateApiKeyResponse } from '@kalshi/trading-api';
+import { GenerateApiKeyResponse } from 'kalshi-typescript';
 
 const instance: GenerateApiKeyResponse = {
     api_key_id,

package/docs/GetApiKeysResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { GetApiKeysResponse } from '@kalshi/trading-api';
+import { GetApiKeysResponse } from 'kalshi-typescript';
 
 const instance: GetApiKeysResponse = {
     api_keys,

package/docs/GetBalanceResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { GetBalanceResponse } from '@kalshi/trading-api';
+import { GetBalanceResponse } from 'kalshi-typescript';
 
 const instance: GetBalanceResponse = {
     balance,

package/docs/GetCommunicationsIDResponse.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { GetCommunicationsIDResponse } from '@kalshi/trading-api';
+import { GetCommunicationsIDResponse } from 'kalshi-typescript';
 
 const instance: GetCommunicationsIDResponse = {
     communications_id,