kalshi-typescript 2.1.1 → 2.1.2

package/docs/PortfolioApi.md

@@ -15,6 +15,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
 |[**getBalance**](#getbalance) | **GET** /portfolio/balance | Get Balance|
 |[**getFills**](#getfills) | **GET** /portfolio/fills | Get Fills|
 |[**getOrder**](#getorder) | **GET** /portfolio/orders/{order_id} | Get Order|
+|[**getOrderGroup**](#getordergroup) | **GET** /portfolio/order_groups/{order_group_id} | Get Order Group|
 |[**getOrderGroups**](#getordergroups) | **GET** /portfolio/order_groups | Get Order Groups|
 |[**getOrderQueuePosition**](#getorderqueueposition) | **GET** /portfolio/orders/{order_id}/queue_position | Get Order Queue Position|
 |[**getOrders**](#getorders) | **GET** /portfolio/orders | Get Orders|
@@ -22,7 +23,7 @@ All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
 |[**getQueuePositions**](#getqueuepositions) | **POST** /portfolio/orders/queue_positions | Get Queue Positions|
 |[**getSettlements**](#getsettlements) | **GET** /portfolio/settlements | Get Settlements|
 |[**getTotalRestingOrderValue**](#gettotalrestingordervalue) | **GET** /portfolio/summary/total_resting_order_value | Get Total Resting Order Value|
-|[**resetOrderGroup**](#resetordergroup) | **POST** /portfolio/order_groups/{order_group_id}/reset | Reset Order Group|
+|[**resetOrderGroup**](#resetordergroup) | **PUT** /portfolio/order_groups/{order_group_id}/reset | Reset Order Group|
 
 # **amendOrder**
 > AmendOrderResponse amendOrder(amendOrderRequest)
@@ -36,9 +37,12 @@ import {
     PortfolioApi,
     Configuration,
     AmendOrderRequest
-} 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 PortfolioApi(configuration);
 
 let orderId: string; //Order ID (default to undefined)
@@ -95,9 +99,12 @@ import {
     PortfolioApi,
     Configuration,
     BatchCancelOrdersRequest
-} 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 PortfolioApi(configuration);
 
 let batchCancelOrdersRequest: BatchCancelOrdersRequest; //
@@ -150,9 +157,12 @@ import {
     PortfolioApi,
     Configuration,
     BatchCreateOrdersRequest
-} 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 PortfolioApi(configuration);
 
 let batchCreateOrdersRequest: BatchCreateOrdersRequest; //
@@ -204,9 +214,12 @@ Cancel an order
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let orderId: string; //Order ID (default to undefined)
@@ -259,9 +272,12 @@ import {
     PortfolioApi,
     Configuration,
     CreateOrderRequest
-} 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 PortfolioApi(configuration);
 
 let createOrderRequest: CreateOrderRequest; //
@@ -315,9 +331,12 @@ import {
     PortfolioApi,
     Configuration,
     CreateOrderGroupRequest
-} 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 PortfolioApi(configuration);
 
 let createOrderGroupRequest: CreateOrderGroupRequest; //
@@ -370,9 +389,12 @@ import {
     PortfolioApi,
     Configuration,
     DecreaseOrderRequest
-} 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 PortfolioApi(configuration);
 
 let orderId: string; //Order ID (default to undefined)
@@ -428,9 +450,12 @@ Delete an order group
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let orderGroupId: string; //Order group ID (default to undefined)
@@ -482,9 +507,12 @@ Get the user\'s current balance
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 const { status, data } = await apiInstance.getBalance();
@@ -528,9 +556,12 @@ Get fills for the logged-in user.  A fill represents a partial or complete execu
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let ticker: string; //Filter by market ticker (optional) (default to undefined)
@@ -597,9 +628,12 @@ Get a single order by ID
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let orderId: string; //Order ID (default to undefined)
@@ -640,6 +674,63 @@ const { status, data } = await apiInstance.getOrder(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getOrderGroup**
+> GetOrderGroupResponse getOrderGroup()
+
+Get details of a specific order group
+
+### Example
+
+```typescript
+import {
+    PortfolioApi,
+    Configuration
+} from 'kalshi-typescript';
+
+const configuration = new Configuration({
+    apiKey: 'your-api-key-id',
+    privateKeyPath: '/path/to/private-key.pem'  // or privateKeyPem: 'PEM string'
+});
+const apiInstance = new PortfolioApi(configuration);
+
+let orderGroupId: string; //Order group ID (default to undefined)
+
+const { status, data } = await apiInstance.getOrderGroup(
+    orderGroupId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderGroupId** | [**string**] | Order group ID | defaults to undefined|
+
+
+### Return type
+
+**GetOrderGroupResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order group retrieved successfully |  -  |
+|**401** | Unauthorized - authentication required |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getOrderGroups**
 > GetOrderGroupsResponse getOrderGroups()
 
@@ -651,9 +742,12 @@ Get order groups for the logged-in user
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let status: string; //Filter by status. Possible values depend on the endpoint. (optional) (default to undefined)
@@ -711,9 +805,12 @@ Get the queue position for an order
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let orderId: string; //Order ID (default to undefined)
@@ -765,9 +862,12 @@ Get orders for the logged-in user
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let ticker: string; //Filter by market ticker (optional) (default to undefined)
@@ -837,9 +937,12 @@ Get positions for the logged-in user
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let ticker: string; //Filter by market ticker (optional) (default to undefined)
@@ -907,9 +1010,12 @@ import {
     PortfolioApi,
     Configuration,
     GetQueuePositionsRequest
-} 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 PortfolioApi(configuration);
 
 let getQueuePositionsRequest: GetQueuePositionsRequest; //
@@ -961,9 +1067,12 @@ Get settlements for the logged-in user
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let limit: number; //Number of results per page. Defaults to 100. Maximum value is 200. (optional) (default to 100)
@@ -1018,9 +1127,12 @@ Get the total value of all resting orders
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 const { status, data } = await apiInstance.getTotalRestingOrderValue();
@@ -1064,9 +1176,12 @@ Reset an order group
 import {
     PortfolioApi,
     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 PortfolioApi(configuration);
 
 let orderGroupId: string; //Order group ID (default to undefined)

package/docs/Position.md

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

package/docs/Quote.md

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

package/docs/RFQ.md

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

package/docs/Series.md

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

package/docs/SeriesApi.md

@@ -18,9 +18,12 @@ Get all market series
 import {
     SeriesApi,
     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 SeriesApi(configuration);
 
 let status: string; //Filter by series status (optional) (default to undefined)
@@ -71,9 +74,12 @@ Get a single series by its ticker
 import {
     SeriesApi,
     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 SeriesApi(configuration);
 
 let ticker: string; //The series ticker (default to undefined)

package/docs/Settlement.md

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

package/docs/StructuredTarget.md

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

package/docs/StructuredTargetsApi.md

@@ -18,9 +18,12 @@ Get a single structured target by ID
 import {
     StructuredTargetsApi,
     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 StructuredTargetsApi(configuration);
 
 let structuredTargetId: string; //Structured target ID (default to undefined)
@@ -72,9 +75,12 @@ Get all structured targets
 import {
     StructuredTargetsApi,
     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 StructuredTargetsApi(configuration);
 
 let status: string; //Filter by structured target status (optional) (default to undefined)

package/docs/Trade.md

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

package/models/amend-order-request.ts

@@ -15,8 +15,42 @@
 
 
 export interface AmendOrderRequest {
+    /**
+     * Market ticker
+     */
+    'ticker': string;
+    /**
+     * Side of the order
+     */
+    'side': AmendOrderRequestSideEnum;
+    /**
+     * Buy or sell action
+     */
+    'action': AmendOrderRequestActionEnum;
     'yes_price'?: number;
     'no_price'?: number;
     'count'?: number;
+    /**
+     * Current client order ID
+     */
+    'client_order_id': string;
+    /**
+     * New client order ID after amendment
+     */
+    'updated_client_order_id': string;
 }
 
+export const AmendOrderRequestSideEnum = {
+    Yes: 'yes',
+    No: 'no'
+} as const;
+
+export type AmendOrderRequestSideEnum = typeof AmendOrderRequestSideEnum[keyof typeof AmendOrderRequestSideEnum];
+export const AmendOrderRequestActionEnum = {
+    Buy: 'buy',
+    Sell: 'sell'
+} as const;
+
+export type AmendOrderRequestActionEnum = typeof AmendOrderRequestActionEnum[keyof typeof AmendOrderRequestActionEnum];
+
+

package/models/create-order-group-request.ts

@@ -15,6 +15,9 @@
 
 
 export interface CreateOrderGroupRequest {
-    'name': string;
+    /**
+     * Specifies the maximum number of contracts that can be matched within this group.
+     */
+    'contracts_limit'?: number;
 }
 

package/models/create-order-group-response.ts

@@ -13,11 +13,11 @@
  */
 
 
-// May contain unused imports in some cases
-// @ts-ignore
-import type { OrderGroup } from './order-group';
 
 export interface CreateOrderGroupResponse {
-    'order_group'?: OrderGroup;
+    /**
+     * The unique identifier for the created order group
+     */
+    'order_group_id'?: string;
 }
 

package/models/create-order-request.ts

@@ -26,6 +26,14 @@ export interface CreateOrderRequest {
     'expiration_ts'?: number;
     'sell_position_floor'?: number;
     'buy_max_cost'?: number;
+    /**
+     * If set to true, the order will be rejected if it crosses the spread and executes immediately
+     */
+    'post_only'?: boolean;
+    /**
+     * OrderGroupId specifies the order group this order is part of
+     */
+    'order_group_id'?: string;
 }
 
 export const CreateOrderRequestSideEnum = {

package/models/error-response-error.ts

@@ -26,6 +26,6 @@ export interface ErrorResponseError {
     /**
      * Additional error details
      */
-    'details'?: object;
+    'details'?: string;
 }
 

package/models/event-position.ts

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Kalshi Trading API
+ * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@kalshi.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface EventPosition {
+    /**
+     * Unique identifier for events.
+     */
+    'event_ticker'?: string;
+    /**
+     * Total spent on this event in cents.
+     */
+    'total_cost'?: number;
+    /**
+     * Total spent on this event in dollars.
+     */
+    'total_cost_dollars'?: string;
+    /**
+     * Cost of the aggregate event position in cents.
+     */
+    'event_exposure'?: number;
+    /**
+     * Cost of the aggregate event position in dollars.
+     */
+    'event_exposure_dollars'?: string;
+    /**
+     * Locked in profit and loss, in cents.
+     */
+    'realized_pnl'?: number;
+    /**
+     * Locked in profit and loss, in dollars.
+     */
+    'realized_pnl_dollars'?: string;
+    /**
+     * Aggregate size of resting orders in contract units.
+     */
+    'resting_order_count'?: number;
+    /**
+     * Fees paid on fill orders, in cents.
+     */
+    'fees_paid'?: number;
+    /**
+     * Fees paid on fill orders, in dollars.
+     */
+    'fees_paid_dollars'?: string;
+}
+

package/models/get-order-group-response.ts

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Kalshi Trading API
+ * Complete API for the Kalshi trading platform including all handlers for SDK generation
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@kalshi.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface GetOrderGroupResponse {
+    /**
+     * Whether auto-cancel is enabled for this order group
+     */
+    'is_auto_cancel_enabled'?: boolean;
+    /**
+     * List of order IDs that belong to this order group
+     */
+    'orders'?: Array<string>;
+}
+