kalshi-typescript 2.1.3 → 3.3.0

package/docs/CreateOrderRequest.md

@@ -1,44 +0,0 @@
-# CreateOrderRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** |  | [default to undefined]
-**client_order_id** | **string** |  | [optional] [default to undefined]
-**side** | **string** |  | [default to undefined]
-**action** | **string** |  | [default to undefined]
-**count** | **number** |  | [default to undefined]
-**type** | **string** |  | [default to undefined]
-**yes_price** | **number** |  | [optional] [default to undefined]
-**no_price** | **number** |  | [optional] [default to undefined]
-**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-typescript';
-
-const instance: CreateOrderRequest = {
-    ticker,
-    client_order_id,
-    side,
-    action,
-    count,
-    type,
-    yes_price,
-    no_price,
-    expiration_ts,
-    sell_position_floor,
-    buy_max_cost,
-    post_only,
-    order_group_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/CreateOrderResponse.md

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

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

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

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

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

@@ -1,22 +0,0 @@
-# DailySchedule
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**open_time** | **string** |  | [optional] [default to undefined]
-**close_time** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { DailySchedule } from 'kalshi-typescript';
-
-const instance: DailySchedule = {
-    open_time,
-    close_time,
-};
-```
-
-[[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/DecreaseOrderRequest.md

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

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

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

@@ -1,24 +0,0 @@
-# ErrorResponseError
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **string** | Error code | [default to undefined]
-**message** | **string** | Error message | [default to undefined]
-**details** | **string** | Additional error details | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ErrorResponseError } from 'kalshi-typescript';
-
-const instance: ErrorResponseError = {
-    code,
-    message,
-    details,
-};
-```
-
-[[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/Event.md

@@ -1,30 +0,0 @@
-# Event
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**event_ticker** | **string** |  | [optional] [default to undefined]
-**series_ticker** | **string** |  | [optional] [default to undefined]
-**sub_title** | **string** |  | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**markets** | [**Array<Market>**](Market.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Event } from 'kalshi-typescript';
-
-const instance: Event = {
-    event_ticker,
-    series_ticker,
-    sub_title,
-    title,
-    status,
-    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/EventPosition.md

@@ -1,38 +0,0 @@
-# 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

@@ -1,199 +0,0 @@
-# EventsApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getEvent**](#getevent) | **GET** /events/{event_ticker} | Get Event|
-|[**getEventMetadata**](#geteventmetadata) | **GET** /events/{event_ticker}/metadata | Get Event Metadata|
-|[**getEvents**](#getevents) | **GET** /events | Get Events|
-
-# **getEvent**
-> GetEventResponse getEvent()
-
-Get data about an event by its ticker.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes. 
-
-### Example
-
-```typescript
-import {
-    EventsApi,
-    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 EventsApi(configuration);
-
-let eventTicker: string; //Event ticker (default to undefined)
-let withNestedMarkets: boolean; //If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. (optional) (default to false)
-
-const { status, data } = await apiInstance.getEvent(
-    eventTicker,
-    withNestedMarkets
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **eventTicker** | [**string**] | Event ticker | defaults to undefined|
-| **withNestedMarkets** | [**boolean**] | If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. | (optional) defaults to false|
-
-
-### Return type
-
-**GetEventResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Event 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)
-
-# **getEventMetadata**
-> GetEventMetadataResponse getEventMetadata()
-
-Get metadata about an event by its ticker
-
-### Example
-
-```typescript
-import {
-    EventsApi,
-    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 EventsApi(configuration);
-
-let eventTicker: string; //Event ticker (default to undefined)
-
-const { status, data } = await apiInstance.getEventMetadata(
-    eventTicker
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **eventTicker** | [**string**] | Event ticker | defaults to undefined|
-
-
-### Return type
-
-**GetEventMetadataResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Event metadata 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)
-
-# **getEvents**
-> GetEventsResponse getEvents()
-
-Get data about all events.  An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release. Events contain one or more markets where users can place trades on different outcomes.  This endpoint returns a paginated response. Use the \'limit\' parameter to control page size (1-200, 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 {
-    EventsApi,
-    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 EventsApi(configuration);
-
-let limit: number; //Number of results per page. Defaults to 100. Maximum value is 200. (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 withNestedMarkets: boolean; //If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. (optional) (default to false)
-let status: string; //Filter by status. Possible values depend on the endpoint. (optional) (default to undefined)
-let seriesTicker: string; //Filter by series ticker (optional) (default to undefined)
-let minCloseTs: number; //Filter items that close after this Unix timestamp (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getEvents(
-    limit,
-    cursor,
-    withNestedMarkets,
-    status,
-    seriesTicker,
-    minCloseTs
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **limit** | [**number**] | Number of results per page. Defaults to 100. Maximum value is 200. | (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|
-| **withNestedMarkets** | [**boolean**] | If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. | (optional) defaults to false|
-| **status** | [**string**] | Filter by status. Possible values depend on the endpoint. | (optional) defaults to undefined|
-| **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
-| **minCloseTs** | [**number**] | Filter items that close after this Unix timestamp | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetEventsResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Events 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)
-