kalshi-typescript 2.1.3 → 3.3.0

package/configuration.ts

@@ -1,94 +0,0 @@
-/**
- * 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.
- */
-
-/* tslint:disable */
-/* eslint-disable */
-
-
-export interface ConfigurationParameters {
-    apiKey?: string;
-    privateKeyPath?: string;
-    privateKeyPem?: string;
-    basePath?: string;
-    serverIndex?: number;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-
-export class Configuration {
-    /**
-     * Kalshi API Key ID
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    apiKey?: string;
-    /**
-     * Path to RSA private key PEM file
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    privateKeyPath?: string;
-    /**
-     * RSA private key PEM string
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    privateKeyPem?: string;
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * override server index
-     */
-    serverIndex?: number;
-    /**
-     * base options for axios calls
-     */
-    baseOptions?: any;
-    /**
-     * The FormData constructor that will be used to create multipart form data
-     * requests.
-     */
-    formDataCtor?: new () => any;
-
-    constructor(param: ConfigurationParameters = {}) {
-        this.apiKey = param.apiKey;
-        this.privateKeyPath = param.privateKeyPath;
-        this.privateKeyPem = param.privateKeyPem;
-        this.basePath = param.basePath;
-        this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
-        this.formDataCtor = param.formDataCtor;
-    }
-
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    public isJsonMime(mime: string): boolean {
-        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
-    }
-}

package/docs/AcceptQuoteRequest.md

@@ -1,20 +0,0 @@
-# AcceptQuoteRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**size** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AcceptQuoteRequest } from 'kalshi-typescript';
-
-const instance: AcceptQuoteRequest = {
-    size,
-};
-```
-
-[[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/AmendOrderRequest.md

@@ -1,34 +0,0 @@
-# AmendOrderRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** | Market ticker | [default to undefined]
-**side** | **string** | Side of the order | [default to undefined]
-**action** | **string** | Buy or sell action | [default to undefined]
-**yes_price** | **number** |  | [optional] [default to undefined]
-**no_price** | **number** |  | [optional] [default to undefined]
-**count** | **number** |  | [optional] [default to undefined]
-**client_order_id** | **string** | Current client order ID | [default to undefined]
-**updated_client_order_id** | **string** | New client order ID after amendment | [default to undefined]
-
-## Example
-
-```typescript
-import { AmendOrderRequest } from 'kalshi-typescript';
-
-const instance: AmendOrderRequest = {
-    ticker,
-    side,
-    action,
-    yes_price,
-    no_price,
-    count,
-    client_order_id,
-    updated_client_order_id,
-};
-```
-
-[[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/AmendOrderResponse.md

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

@@ -1,26 +0,0 @@
-# Announcement
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**delivery_time** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**type** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Announcement } from 'kalshi-typescript';
-
-const instance: Announcement = {
-    delivery_time,
-    message,
-    status,
-    type,
-};
-```
-
-[[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/ApiKey.md

@@ -1,24 +0,0 @@
-# ApiKey
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**api_key_id** | **string** | Unique identifier for the API key | [default to undefined]
-**name** | **string** | User-provided name for the API key | [default to undefined]
-**created_ts** | **string** | Timestamp when the API key was created | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ApiKey } from 'kalshi-typescript';
-
-const instance: ApiKey = {
-    api_key_id,
-    name,
-    created_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/ApiKeysApi.md

@@ -1,235 +0,0 @@
-# ApiKeysApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createApiKey**](#createapikey) | **POST** /api_keys | Create API Key|
-|[**deleteApiKey**](#deleteapikey) | **DELETE** /api_keys/{api_key} | Delete API Key|
-|[**generateApiKey**](#generateapikey) | **POST** /api_keys/generate | Generate API Key|
-|[**getApiKeys**](#getapikeys) | **GET** /api_keys | Get API Keys|
-
-# **createApiKey**
-> CreateApiKeyResponse createApiKey(createApiKeyRequest)
-
-Create a new API key with a user-provided public key.  This endpoint allows users with Premier or Market Maker API usage levels to create API keys by providing their own RSA public key. The platform will use this public key to verify signatures on API requests. 
-
-### Example
-
-```typescript
-import {
-    ApiKeysApi,
-    Configuration,
-    CreateApiKeyRequest
-} 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 ApiKeysApi(configuration);
-
-let createApiKeyRequest: CreateApiKeyRequest; //
-
-const { status, data } = await apiInstance.createApiKey(
-    createApiKeyRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createApiKeyRequest** | **CreateApiKeyRequest**|  | |
-
-
-### Return type
-
-**CreateApiKeyResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | API key created successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**403** | Forbidden - insufficient permissions |  -  |
-|**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)
-
-# **deleteApiKey**
-> deleteApiKey()
-
-Delete an existing API key.  This endpoint permanently deletes an API key. Once deleted, the key can no longer be used for authentication. This action cannot be undone. 
-
-### Example
-
-```typescript
-import {
-    ApiKeysApi,
-    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 ApiKeysApi(configuration);
-
-let apiKey: string; //API key ID to delete (default to undefined)
-
-const { status, data } = await apiInstance.deleteApiKey(
-    apiKey
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **apiKey** | [**string**] | API key ID to delete | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | API key successfully deleted |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**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)
-
-# **generateApiKey**
-> GenerateApiKeyResponse generateApiKey(generateApiKeyRequest)
-
-Generate a new API key with an automatically created key pair.  This endpoint generates both a public and private RSA key pair. The public key is stored on the platform, while the private key is returned to the user and must be stored securely. The private key cannot be retrieved again. 
-
-### Example
-
-```typescript
-import {
-    ApiKeysApi,
-    Configuration,
-    GenerateApiKeyRequest
-} 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 ApiKeysApi(configuration);
-
-let generateApiKeyRequest: GenerateApiKeyRequest; //
-
-const { status, data } = await apiInstance.generateApiKey(
-    generateApiKeyRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **generateApiKeyRequest** | **GenerateApiKeyRequest**|  | |
-
-
-### Return type
-
-**GenerateApiKeyResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | API key generated successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**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)
-
-# **getApiKeys**
-> GetApiKeysResponse getApiKeys()
-
-Retrieve all API keys associated with the authenticated user.  API keys allow programmatic access to the platform without requiring username/password authentication. Each key has a unique identifier and name. 
-
-### Example
-
-```typescript
-import {
-    ApiKeysApi,
-    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 ApiKeysApi(configuration);
-
-const { status, data } = await apiInstance.getApiKeys();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**GetApiKeysResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | List of API keys retrieved successfully |  -  |
-|**401** | Unauthorized - authentication required |  -  |
-|**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)
-

package/docs/BatchCancelOrdersRequest.md

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

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

@@ -1,24 +0,0 @@
-# BatchCancelOrdersResponseResponsesInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order_id** | **string** |  | [optional] [default to undefined]
-**reduced_by** | **number** |  | [optional] [default to undefined]
-**error** | [**ErrorResponse**](ErrorResponse.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { BatchCancelOrdersResponseResponsesInner } from 'kalshi-typescript';
-
-const instance: BatchCancelOrdersResponseResponsesInner = {
-    order_id,
-    reduced_by,
-    error,
-};
-```
-
-[[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/BatchCreateOrdersRequest.md

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

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

@@ -1,22 +0,0 @@
-# BatchCreateOrdersResponseResponsesInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order** | [**Order**](Order.md) |  | [optional] [default to undefined]
-**error** | [**ErrorResponse**](ErrorResponse.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { BatchCreateOrdersResponseResponsesInner } from 'kalshi-typescript';
-
-const instance: BatchCreateOrdersResponseResponsesInner = {
-    order,
-    error,
-};
-```
-
-[[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/CancelOrderResponse.md

@@ -1,22 +0,0 @@
-# CancelOrderResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order** | [**Order**](Order.md) |  | [optional] [default to undefined]
-**reduced_by** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CancelOrderResponse } from 'kalshi-typescript';
-
-const instance: CancelOrderResponse = {
-    order,
-    reduced_by,
-};
-```
-
-[[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/Candlestick.md

@@ -1,32 +0,0 @@
-# Candlestick
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**start_ts** | **number** |  | [optional] [default to undefined]
-**end_ts** | **number** |  | [optional] [default to undefined]
-**open** | **number** |  | [optional] [default to undefined]
-**high** | **number** |  | [optional] [default to undefined]
-**low** | **number** |  | [optional] [default to undefined]
-**close** | **number** |  | [optional] [default to undefined]
-**volume** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Candlestick } from 'kalshi-typescript';
-
-const instance: Candlestick = {
-    start_ts,
-    end_ts,
-    open,
-    high,
-    low,
-    close,
-    volume,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)