kalshi-typescript 3.0.0 → 3.4.0

package/docs/BatchCreateOrdersIndividualResponse.md

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

@@ -1,20 +0,0 @@
-# BatchGetMarketCandlesticksResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**markets** | [**Array<MarketCandlesticksResponse>**](MarketCandlesticksResponse.md) | Array of market candlestick data, one entry per requested market. | [default to undefined]
-
-## Example
-
-```typescript
-import { BatchGetMarketCandlesticksResponse } from 'kalshi-typescript';
-
-const instance: BatchGetMarketCandlesticksResponse = {
-    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/BidAskDistribution.md

@@ -1,34 +0,0 @@
-# BidAskDistribution
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**open** | **number** | Offer price on the market at the start of the candlestick period (in cents). | [default to undefined]
-**open_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**low** | **number** | Lowest offer price on the market during the candlestick period (in cents). | [default to undefined]
-**low_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**high** | **number** | Highest offer price on the market during the candlestick period (in cents). | [default to undefined]
-**high_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**close** | **number** | Offer price on the market at the end of the candlestick period (in cents). | [default to undefined]
-**close_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-
-## Example
-
-```typescript
-import { BidAskDistribution } from 'kalshi-typescript';
-
-const instance: BidAskDistribution = {
-    open,
-    open_dollars,
-    low,
-    low_dollars,
-    high,
-    high_dollars,
-    close,
-    close_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/CancelOrderResponse.md

@@ -1,22 +0,0 @@
-# CancelOrderResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order** | [**Order**](Order.md) |  | [default to undefined]
-**reduced_by** | **number** |  | [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)

package/docs/CollectionApi.md

@@ -1,318 +0,0 @@
-# CollectionApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createMarketInMultivariateEventCollection**](#createmarketinmultivariateeventcollection) | **POST** /multivariate_event_collections/{collection_ticker} | Create Market In Multivariate Event Collection|
-|[**getMultivariateEventCollection**](#getmultivariateeventcollection) | **GET** /multivariate_event_collections/{collection_ticker} | Get Multivariate Event Collection|
-|[**getMultivariateEventCollectionLookupHistory**](#getmultivariateeventcollectionlookuphistory) | **GET** /multivariate_event_collections/{collection_ticker}/lookup | Get Multivariate Event Collection Lookup History|
-|[**getMultivariateEventCollections**](#getmultivariateeventcollections) | **GET** /multivariate_event_collections | Get Multivariate Event Collections|
-|[**lookupTickersForMarketInMultivariateEventCollection**](#lookuptickersformarketinmultivariateeventcollection) | **PUT** /multivariate_event_collections/{collection_ticker}/lookup | Lookup Tickers For Market In Multivariate Event Collection|
-
-# **createMarketInMultivariateEventCollection**
-> CreateMarketInMultivariateEventCollectionResponse createMarketInMultivariateEventCollection(createMarketInMultivariateEventCollectionRequest)
-
- Endpoint for looking up an individual market in a multivariate event collection. This endpoint must be hit at least once before trading or looking up a market.
-
-### Example
-
-```typescript
-import {
-    CollectionApi,
-    Configuration,
-    CreateMarketInMultivariateEventCollectionRequest
-} 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 CollectionApi(configuration);
-
-let collectionTicker: string; //Collection ticker (default to undefined)
-let createMarketInMultivariateEventCollectionRequest: CreateMarketInMultivariateEventCollectionRequest; //
-
-const { status, data } = await apiInstance.createMarketInMultivariateEventCollection(
-    collectionTicker,
-    createMarketInMultivariateEventCollectionRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createMarketInMultivariateEventCollectionRequest** | **CreateMarketInMultivariateEventCollectionRequest**|  | |
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-
-
-### Return type
-
-**CreateMarketInMultivariateEventCollectionResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Market created 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)
-
-# **getMultivariateEventCollection**
-> GetMultivariateEventCollectionResponse getMultivariateEventCollection()
-
- Endpoint for getting data about a multivariate event collection by its ticker.
-
-### Example
-
-```typescript
-import {
-    CollectionApi,
-    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 CollectionApi(configuration);
-
-let collectionTicker: string; //Collection ticker (default to undefined)
-
-const { status, data } = await apiInstance.getMultivariateEventCollection(
-    collectionTicker
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-
-
-### Return type
-
-**GetMultivariateEventCollectionResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Collection retrieved successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**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)
-
-# **getMultivariateEventCollectionLookupHistory**
-> GetMultivariateEventCollectionLookupHistoryResponse getMultivariateEventCollectionLookupHistory()
-
- Endpoint for retrieving which markets in an event collection were recently looked up.
-
-### Example
-
-```typescript
-import {
-    CollectionApi,
-    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 CollectionApi(configuration);
-
-let collectionTicker: string; //Collection ticker (default to undefined)
-let lookbackSeconds: 10 | 60 | 300 | 3600; //Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600. (default to undefined)
-
-const { status, data } = await apiInstance.getMultivariateEventCollectionLookupHistory(
-    collectionTicker,
-    lookbackSeconds
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-| **lookbackSeconds** | [**10 | 60 | 300 | 3600**]**Array<10 &#124; 60 &#124; 300 &#124; 3600>** | Number of seconds to look back for lookup history. Must be one of 10, 60, 300, or 3600. | defaults to undefined|
-
-
-### Return type
-
-**GetMultivariateEventCollectionLookupHistoryResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Lookup history retrieved successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**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)
-
-# **getMultivariateEventCollections**
-> GetMultivariateEventCollectionsResponse getMultivariateEventCollections()
-
- Endpoint for getting data about multivariate event collections.
-
-### Example
-
-```typescript
-import {
-    CollectionApi,
-    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 CollectionApi(configuration);
-
-let status: 'unopened' | 'open' | 'closed'; //Only return collections of a certain status. Can be unopened, open, or closed. (optional) (default to undefined)
-let associatedEventTicker: string; //Only return collections associated with a particular event ticker. (optional) (default to undefined)
-let seriesTicker: string; //Only return collections with a particular series ticker. (optional) (default to undefined)
-let limit: number; //Specify the maximum number of results. (optional) (default to undefined)
-let cursor: string; //The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point. (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getMultivariateEventCollections(
-    status,
-    associatedEventTicker,
-    seriesTicker,
-    limit,
-    cursor
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **status** | [**&#39;unopened&#39; | &#39;open&#39; | &#39;closed&#39;**]**Array<&#39;unopened&#39; &#124; &#39;open&#39; &#124; &#39;closed&#39;>** | Only return collections of a certain status. Can be unopened, open, or closed. | (optional) defaults to undefined|
-| **associatedEventTicker** | [**string**] | Only return collections associated with a particular event ticker. | (optional) defaults to undefined|
-| **seriesTicker** | [**string**] | Only return collections with a particular series ticker. | (optional) defaults to undefined|
-| **limit** | [**number**] | Specify the maximum number of results. | (optional) defaults to undefined|
-| **cursor** | [**string**] | The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point. | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetMultivariateEventCollectionsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Collections retrieved successfully |  -  |
-|**400** | Bad request - invalid input |  -  |
-|**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)
-
-# **lookupTickersForMarketInMultivariateEventCollection**
-> LookupTickersForMarketInMultivariateEventCollectionResponse lookupTickersForMarketInMultivariateEventCollection(lookupTickersForMarketInMultivariateEventCollectionRequest)
-
- Endpoint for looking up an individual market in a multivariate event collection. If CreateMarketInMultivariateEventCollection has never been hit with that variable combination before, this will return a 404.
-
-### Example
-
-```typescript
-import {
-    CollectionApi,
-    Configuration,
-    LookupTickersForMarketInMultivariateEventCollectionRequest
-} 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 CollectionApi(configuration);
-
-let collectionTicker: string; //Collection ticker (default to undefined)
-let lookupTickersForMarketInMultivariateEventCollectionRequest: LookupTickersForMarketInMultivariateEventCollectionRequest; //
-
-const { status, data } = await apiInstance.lookupTickersForMarketInMultivariateEventCollection(
-    collectionTicker,
-    lookupTickersForMarketInMultivariateEventCollectionRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **lookupTickersForMarketInMultivariateEventCollectionRequest** | **LookupTickersForMarketInMultivariateEventCollectionRequest**|  | |
-| **collectionTicker** | [**string**] | Collection ticker | defaults to undefined|
-
-
-### Return type
-
-**LookupTickersForMarketInMultivariateEventCollectionResponse**
-
-### Authorization
-
-[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Market looked up successfully |  -  |
-|**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)