kalshi-typescript 3.0.0 → 3.3.0

package/docs/MarketsApi.md

@@ -1,344 +0,0 @@
-# MarketsApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getMarket**](#getmarket) | **GET** /markets/{ticker} | Get Market|
-|[**getMarketCandlesticks**](#getmarketcandlesticks) | **GET** /series/{ticker}/markets/{market_ticker}/candlesticks | Get Market Candlesticks|
-|[**getMarketOrderbook**](#getmarketorderbook) | **GET** /markets/{ticker}/orderbook | Get Market Orderbook|
-|[**getMarkets**](#getmarkets) | **GET** /markets | Get Markets|
-|[**getTrades**](#gettrades) | **GET** /markets/trades | Get Trades|
-
-# **getMarket**
-> GetMarketResponse getMarket()
-
-Get a single market by its ticker.  A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules.
-
-### Example
-
-```typescript
-import {
-    MarketsApi,
-    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 MarketsApi(configuration);
-
-let ticker: string; //Market ticker (default to undefined)
-
-const { status, data } = await apiInstance.getMarket(
-    ticker
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **ticker** | [**string**] | Market ticker | defaults to undefined|
-
-
-### Return type
-
-**GetMarketResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Market 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)
-
-# **getMarketCandlesticks**
-> GetMarketCandlesticksResponse getMarketCandlesticks()
-
-Get candlestick data for a market within a series
-
-### Example
-
-```typescript
-import {
-    MarketsApi,
-    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 MarketsApi(configuration);
-
-let ticker: string; //The series ticker (default to undefined)
-let marketTicker: string; //The market ticker (default to undefined)
-let startTs: number; //Start timestamp for the range (optional) (default to undefined)
-let endTs: number; //End timestamp for the range (optional) (default to undefined)
-let periodInterval: string; //Period interval for candlesticks (e.g., 1m, 5m, 1h, 1d) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getMarketCandlesticks(
-    ticker,
-    marketTicker,
-    startTs,
-    endTs,
-    periodInterval
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **ticker** | [**string**] | The series ticker | defaults to undefined|
-| **marketTicker** | [**string**] | The market ticker | defaults to undefined|
-| **startTs** | [**number**] | Start timestamp for the range | (optional) defaults to undefined|
-| **endTs** | [**number**] | End timestamp for the range | (optional) defaults to undefined|
-| **periodInterval** | [**string**] | Period interval for candlesticks (e.g., 1m, 5m, 1h, 1d) | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetMarketCandlesticksResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Candlesticks retrieved 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)
-
-# **getMarketOrderbook**
-> GetMarketOrderbookResponse getMarketOrderbook()
-
-Get the orderbook for a market
-
-### Example
-
-```typescript
-import {
-    MarketsApi,
-    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 MarketsApi(configuration);
-
-let ticker: string; //Market ticker (default to undefined)
-let depth: number; //Depth of the orderbook to retrieve (optional) (default to 10)
-
-const { status, data } = await apiInstance.getMarketOrderbook(
-    ticker,
-    depth
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **ticker** | [**string**] | Market ticker | defaults to undefined|
-| **depth** | [**number**] | Depth of the orderbook to retrieve | (optional) defaults to 10|
-
-
-### Return type
-
-**GetMarketOrderbookResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Orderbook 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)
-
-# **getMarkets**
-> GetMarketsResponse getMarkets()
-
-List and discover markets on Kalshi.  A market represents a specific binary outcome within an event that users can trade on (e.g., \"Will candidate X win?\"). Markets have yes/no positions, current prices, volume, and settlement rules.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
-
-### Example
-
-```typescript
-import {
-    MarketsApi,
-    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 MarketsApi(configuration);
-
-let limit: number; //Number of results per page. Defaults to 100. Maximum value is 1000. (optional) (default to 100)
-let cursor: string; //Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. (optional) (default to undefined)
-let eventTicker: string; //Filter by event ticker (optional) (default to undefined)
-let seriesTicker: string; //Filter by series ticker (optional) (default to undefined)
-let maxCloseTs: number; //Filter items that close before this Unix timestamp (optional) (default to undefined)
-let minCloseTs: number; //Filter items that close after this Unix timestamp (optional) (default to undefined)
-let status: string; //Filter by market status. Comma-separated list. Possible values are \'initialized\', \'open\', \'closed\', \'settled\', \'determined\'. Note that the API accepts \'open\' for filtering but returns \'active\' in the response. Leave empty to return markets with any status. (optional) (default to undefined)
-let tickers: string; //Filter by specific market tickers. Comma-separated list of market tickers to retrieve. (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getMarkets(
-    limit,
-    cursor,
-    eventTicker,
-    seriesTicker,
-    maxCloseTs,
-    minCloseTs,
-    status,
-    tickers
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 1000. | (optional) defaults to 100|
-| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
-| **eventTicker** | [**string**] | Filter by event ticker | (optional) defaults to undefined|
-| **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
-| **maxCloseTs** | [**number**] | Filter items that close before this Unix timestamp | (optional) defaults to undefined|
-| **minCloseTs** | [**number**] | Filter items that close after this Unix timestamp | (optional) defaults to undefined|
-| **status** | [**string**] | Filter by market status. Comma-separated list. Possible values are \'initialized\', \'open\', \'closed\', \'settled\', \'determined\'. Note that the API accepts \'open\' for filtering but returns \'active\' in the response. Leave empty to return markets with any status. | (optional) defaults to undefined|
-| **tickers** | [**string**] | Filter by specific market tickers. Comma-separated list of market tickers to retrieve. | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetMarketsResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Markets retrieved 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)
-
-# **getTrades**
-> GetTradesResponse getTrades()
-
-Get all trades for all markets.  A trade represents a completed transaction between two users on a specific market. Each trade includes the market ticker, price, quantity, and timestamp information.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-1000, defaults to 100). The response includes a \'cursor\' field - pass this value in the \'cursor\' parameter of your next request to get the next page. An empty cursor indicates no more pages are available.
-
-### Example
-
-```typescript
-import {
-    MarketsApi,
-    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 MarketsApi(configuration);
-
-let limit: number; //Number of results per page. Defaults to 100. Maximum value is 1000. (optional) (default to 100)
-let cursor: string; //Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. (optional) (default to undefined)
-let ticker: string; //Filter by market ticker (optional) (default to undefined)
-let minTs: number; //Filter items after this Unix timestamp (optional) (default to undefined)
-let maxTs: number; //Filter items before this Unix timestamp (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getTrades(
-    limit,
-    cursor,
-    ticker,
-    minTs,
-    maxTs
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 1000. | (optional) defaults to 100|
-| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page. | (optional) defaults to undefined|
-| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
-| **minTs** | [**number**] | Filter items after this Unix timestamp | (optional) defaults to undefined|
-| **maxTs** | [**number**] | Filter items before this Unix timestamp | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetTradesResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Trades 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)

package/docs/Milestone.md

@@ -1,42 +0,0 @@
-# Milestone
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | Unique identifier for the milestone. | [default to undefined]
-**category** | **string** | Category of the milestone. | [default to undefined]
-**type** | **string** | Type of the milestone. | [default to undefined]
-**start_date** | **string** | Start date of the milestone. | [default to undefined]
-**end_date** | **string** | End date of the milestone, if any. | [optional] [default to undefined]
-**related_event_tickers** | **Array<string>** | List of event tickers related to this milestone. | [default to undefined]
-**title** | **string** | Title of the milestone. | [default to undefined]
-**notification_message** | **string** | Notification message for the milestone. | [default to undefined]
-**source_id** | **string** | Source id of milestone if available. | [optional] [default to undefined]
-**details** | **{ [key: string]: any; }** | Additional details about the milestone. | [default to undefined]
-**primary_event_tickers** | **Array<string>** | List of event tickers directly related to the outcome of this milestone. | [default to undefined]
-**last_updated_ts** | **string** | Last time this structured target was updated. | [default to undefined]
-
-## Example
-
-```typescript
-import { Milestone } from 'kalshi-typescript';
-
-const instance: Milestone = {
-    id,
-    category,
-    type,
-    start_date,
-    end_date,
-    related_event_tickers,
-    title,
-    notification_message,
-    source_id,
-    details,
-    primary_event_tickers,
-    last_updated_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/MilestoneApi.md

@@ -1,85 +0,0 @@
-# MilestoneApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getMilestone**](#getmilestone) | **GET** /milestones/{milestone_id} | Get Milestone|
-|[**getMilestones**](#getmilestones) | **GET** /milestones | Get Milestones|
-
-# **getMilestone**
-> GetMilestoneResponse getMilestone()
-
- Endpoint for getting data about a specific milestone by its ID.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **milestoneId** | [**string**] | Milestone ID | defaults to undefined|
-
-
-### Return type
-
-**GetMilestoneResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Milestone retrieved successfully |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorized |  -  |
-|**404** | Not Found |  -  |
-|**500** | Internal Server Error |  -  |
-
-# **getMilestones**
-> GetMilestonesResponse getMilestones()
-
-Minimum start date to filter milestones. Format: RFC3339 timestamp
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **limit** | [**number**] | Number of milestones to return per page | defaults to undefined|
-| **minimumStartDate** | [**string**] | Minimum start date to filter milestones. Format RFC3339 timestamp | (optional) defaults to undefined|
-| **category** | [**string**] | Filter by milestone category | (optional) defaults to undefined|
-| **competition** | [**string**] | Filter by competition | (optional) defaults to undefined|
-| **sourceId** | [**string**] | Filter by source id | (optional) defaults to undefined|
-| **type** | [**string**] | Filter by milestone type | (optional) defaults to undefined|
-| **relatedEventTicker** | [**string**] | Filter by related event ticker | (optional) defaults to undefined|
-| **cursor** | [**string**] | Pagination cursor. Use the cursor value returned from the previous response to get the next page of results | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetMilestonesResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Milestones retrieved successfully |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorized |  -  |
-|**500** | Internal Server Error |  -  |
-

package/docs/MilestonesApi.md

@@ -1,124 +0,0 @@
-# MilestonesApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getMilestone**](#getmilestone) | **GET** /milestones/{milestone_id} | Get Milestone|
-|[**getMilestones**](#getmilestones) | **GET** /milestones | Get Milestones|
-
-# **getMilestone**
-> GetMilestoneResponse getMilestone()
-
-Get a single milestone by ID
-
-### Example
-
-```typescript
-import {
-    MilestonesApi,
-    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 MilestonesApi(configuration);
-
-let milestoneId: string; //Milestone ID (default to undefined)
-
-const { status, data } = await apiInstance.getMilestone(
-    milestoneId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **milestoneId** | [**string**] | Milestone ID | defaults to undefined|
-
-
-### Return type
-
-**GetMilestoneResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Milestone 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)
-
-# **getMilestones**
-> GetMilestonesResponse getMilestones()
-
-Get all milestones
-
-### Example
-
-```typescript
-import {
-    MilestonesApi,
-    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 MilestonesApi(configuration);
-
-let status: string; //Filter by milestone status (optional) (default to undefined)
-let limit: number; //Number of items per page (minimum 1, maximum 500) (optional) (default to 100)
-
-const { status, data } = await apiInstance.getMilestones(
-    status,
-    limit
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **status** | [**string**] | Filter by milestone status | (optional) defaults to undefined|
-| **limit** | [**number**] | Number of items per page (minimum 1, maximum 500) | (optional) defaults to 100|
-
-
-### Return type
-
-**GetMilestonesResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Milestones 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)