kalshi-typescript 3.0.0 → 3.3.0

package/docs/SeriesApi.md

@@ -1,121 +0,0 @@
-# SeriesApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getSeries**](#getseries) | **GET** /series | Get Series|
-|[**getSeriesByTicker**](#getseriesbyticker) | **GET** /series/{ticker} | Get Series by Ticker|
-
-# **getSeries**
-> GetSeriesResponse getSeries()
-
-Get all market series
-
-### Example
-
-```typescript
-import {
-    SeriesApi,
-    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 SeriesApi(configuration);
-
-let status: string; //Filter by series status (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getSeries(
-    status
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **status** | [**string**] | Filter by series status | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetSeriesResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Series 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)
-
-# **getSeriesByTicker**
-> GetSeriesByTickerResponse getSeriesByTicker()
-
-Get a single series by its ticker
-
-### Example
-
-```typescript
-import {
-    SeriesApi,
-    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 SeriesApi(configuration);
-
-let ticker: string; //The series ticker (default to undefined)
-
-const { status, data } = await apiInstance.getSeriesByTicker(
-    ticker
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **ticker** | [**string**] | The series ticker | defaults to undefined|
-
-
-### Return type
-
-**GetSeriesByTickerResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Series 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)

package/docs/SeriesFeeChange.md

@@ -1,28 +0,0 @@
-# SeriesFeeChange
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | Unique identifier for this fee change | [default to undefined]
-**series_ticker** | **string** | Series ticker this fee change applies to | [default to undefined]
-**fee_type** | **string** | New fee type for the series | [default to undefined]
-**fee_multiplier** | **number** | New fee multiplier for the series | [default to undefined]
-**scheduled_ts** | **string** | Timestamp when this fee change is scheduled to take effect | [default to undefined]
-
-## Example
-
-```typescript
-import { SeriesFeeChange } from 'kalshi-typescript';
-
-const instance: SeriesFeeChange = {
-    id,
-    series_ticker,
-    fee_type,
-    fee_multiplier,
-    scheduled_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/Settlement.md

@@ -1,38 +0,0 @@
-# Settlement
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ticker** | **string** | The ticker symbol of the market that was settled. | [default to undefined]
-**market_result** | **string** | The outcome of the market settlement. \'yes\' = market resolved to YES, \'no\' = market resolved to NO, \'scalar\' = scalar market settled at a specific value, \'void\' = market was voided/cancelled and all positions returned at original cost. | [default to undefined]
-**yes_count** | **number** | Number of YES contracts owned at the time of settlement. | [default to undefined]
-**yes_total_cost** | **number** | Total cost basis of all YES contracts in cents. | [default to undefined]
-**no_count** | **number** | Number of NO contracts owned at the time of settlement. | [default to undefined]
-**no_total_cost** | **number** | Total cost basis of all NO contracts in cents. | [default to undefined]
-**revenue** | **number** | Total revenue earned from this settlement in cents (winning contracts pay out 100 cents each). | [default to undefined]
-**settled_time** | **string** | Timestamp when the market was settled and payouts were processed. | [default to undefined]
-**fee_cost** | **string** | Total fees paid in fixed point dollars. | [default to undefined]
-**value** | **number** | Payout of a single yes contract in cents. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Settlement } from 'kalshi-typescript';
-
-const instance: Settlement = {
-    ticker,
-    market_result,
-    yes_count,
-    yes_total_cost,
-    no_count,
-    no_total_cost,
-    revenue,
-    settled_time,
-    fee_cost,
-    value,
-};
-```
-
-[[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/SettlementSource.md

@@ -1,22 +0,0 @@
-# SettlementSource
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** | Name of the settlement source | [optional] [default to undefined]
-**url** | **string** | URL to the settlement source | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SettlementSource } from 'kalshi-typescript';
-
-const instance: SettlementSource = {
-    name,
-    url,
-};
-```
-
-[[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/SportFilterDetails.md

@@ -1,22 +0,0 @@
-# SportFilterDetails
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**scopes** | **Array<string>** | List of scopes available for this sport | [default to undefined]
-**competitions** | [**{ [key: string]: ScopeList; }**](ScopeList.md) | Mapping of competitions to their scope lists | [default to undefined]
-
-## Example
-
-```typescript
-import { SportFilterDetails } from 'kalshi-typescript';
-
-const instance: SportFilterDetails = {
-    scopes,
-    competitions,
-};
-```
-
-[[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/StructuredTarget.md

@@ -1,30 +0,0 @@
-# StructuredTarget
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | Unique identifier for the structured target. | [optional] [default to undefined]
-**name** | **string** | Name of the structured target. | [optional] [default to undefined]
-**type** | **string** | Type of the structured target. | [optional] [default to undefined]
-**details** | **object** | Additional details about the structured target. Contains flexible JSON data specific to the target type. | [optional] [default to undefined]
-**source_id** | **string** | External source identifier for the structured target, if available (e.g., third-party data provider ID). | [optional] [default to undefined]
-**last_updated_ts** | **string** | Timestamp when this structured target was last updated. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { StructuredTarget } from 'kalshi-typescript';
-
-const instance: StructuredTarget = {
-    id,
-    name,
-    type,
-    details,
-    source_id,
-    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/StructuredTargetsApi.md

@@ -1,79 +0,0 @@
-# StructuredTargetsApi
-
-All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getStructuredTarget**](#getstructuredtarget) | **GET** /structured_targets/{structured_target_id} | Get Structured Target|
-|[**getStructuredTargets**](#getstructuredtargets) | **GET** /structured_targets | Get Structured Targets|
-
-# **getStructuredTarget**
-> GetStructuredTargetResponse getStructuredTarget()
-
- Endpoint for getting data about a specific structured target by its ID.
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **structuredTargetId** | [**string**] | Structured target ID | defaults to undefined|
-
-
-### Return type
-
-**GetStructuredTargetResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Structured target retrieved successfully |  -  |
-|**401** | Unauthorized |  -  |
-|**404** | Not found |  -  |
-|**500** | Internal server error |  -  |
-
-# **getStructuredTargets**
-> GetStructuredTargetsResponse getStructuredTargets()
-
-Page size (min: 1, max: 2000)
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **type** | [**string**] | Filter by structured target type | (optional) defaults to undefined|
-| **competition** | [**string**] | Filter by competition | (optional) defaults to undefined|
-| **pageSize** | [**number**] | Number of items per page (min 1, max 2000, default 100) | (optional) defaults to 100|
-| **cursor** | [**string**] | Pagination cursor | (optional) defaults to undefined|
-
-
-### Return type
-
-**GetStructuredTargetsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Structured targets retrieved successfully |  -  |
-|**401** | Unauthorized |  -  |
-|**500** | Internal server error |  -  |
-

package/docs/TickerPair.md

@@ -1,24 +0,0 @@
-# TickerPair
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**market_ticker** | **string** | Market ticker identifier. | [default to undefined]
-**event_ticker** | **string** | Event ticker identifier. | [default to undefined]
-**side** | **string** | Side of the market (yes or no). | [default to undefined]
-
-## Example
-
-```typescript
-import { TickerPair } from 'kalshi-typescript';
-
-const instance: TickerPair = {
-    market_ticker,
-    event_ticker,
-    side,
-};
-```
-
-[[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/Trade.md

@@ -1,38 +0,0 @@
-# Trade
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**trade_id** | **string** | Unique identifier for this trade | [default to undefined]
-**ticker** | **string** | Unique identifier for the market | [default to undefined]
-**price** | **number** | Trade price (deprecated - use yes_price or no_price) | [default to undefined]
-**count** | **number** | Number of contracts bought or sold in this trade | [default to undefined]
-**yes_price** | **number** | Yes price for this trade in cents | [default to undefined]
-**no_price** | **number** | No price for this trade in cents | [default to undefined]
-**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with exactly 4 decimal places | [default to undefined]
-**taker_side** | **string** | Side for the taker of this trade | [default to undefined]
-**created_time** | **string** | Timestamp when this trade was executed | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Trade } from 'kalshi-typescript';
-
-const instance: Trade = {
-    trade_id,
-    ticker,
-    price,
-    count,
-    yes_price,
-    no_price,
-    yes_price_dollars,
-    no_price_dollars,
-    taker_side,
-    created_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/WeeklySchedule.md

@@ -1,36 +0,0 @@
-# WeeklySchedule
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**start_time** | **string** | Start date and time for when this weekly schedule is effective. | [default to undefined]
-**end_time** | **string** | End date and time for when this weekly schedule is no longer effective. | [default to undefined]
-**monday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Monday. May contain multiple sessions. | [default to undefined]
-**tuesday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Tuesday. May contain multiple sessions. | [default to undefined]
-**wednesday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Wednesday. May contain multiple sessions. | [default to undefined]
-**thursday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Thursday. May contain multiple sessions. | [default to undefined]
-**friday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Friday. May contain multiple sessions. | [default to undefined]
-**saturday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Saturday. May contain multiple sessions. | [default to undefined]
-**sunday** | [**Array<DailySchedule>**](DailySchedule.md) | Trading hours for Sunday. May contain multiple sessions. | [default to undefined]
-
-## Example
-
-```typescript
-import { WeeklySchedule } from 'kalshi-typescript';
-
-const instance: WeeklySchedule = {
-    start_time,
-    end_time,
-    monday,
-    tuesday,
-    wednesday,
-    thursday,
-    friday,
-    saturday,
-    sunday,
-};
-```
-
-[[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/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -1,18 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Kalshi Trade API Manual Endpoints
- * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
- *
- * The version of the OpenAPI document: 3.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-export * from "./api";
-export * from "./configuration";
-export * from "./models";

package/models/accept-quote-request.ts

@@ -1,31 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Kalshi Trade API Manual Endpoints
- * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
- *
- * The version of the OpenAPI document: 3.0.0
- * 
- *
- * 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 AcceptQuoteRequest {
-    /**
-     * The side of the quote to accept (yes or no)
-     */
-    'accepted_side': AcceptQuoteRequestAcceptedSideEnum;
-}
-
-export const AcceptQuoteRequestAcceptedSideEnum = {
-    True: 'true',
-    False: 'false'
-} as const;
-
-export type AcceptQuoteRequestAcceptedSideEnum = typeof AcceptQuoteRequestAcceptedSideEnum[keyof typeof AcceptQuoteRequestAcceptedSideEnum];
-
-

package/models/amend-order-request.ts

@@ -1,73 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Kalshi Trade API Manual Endpoints
- * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
- *
- * The version of the OpenAPI document: 3.0.0
- * 
- *
- * 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 AmendOrderRequest {
-    /**
-     * Market ticker
-     */
-    'ticker': string;
-    /**
-     * Side of the order
-     */
-    'side': AmendOrderRequestSideEnum;
-    /**
-     * Action of the order
-     */
-    'action': AmendOrderRequestActionEnum;
-    /**
-     * The original client-specified order ID to be amended
-     */
-    'client_order_id': string;
-    /**
-     * The new client-specified order ID after amendment
-     */
-    'updated_client_order_id': string;
-    /**
-     * Updated yes price for the order in cents
-     */
-    'yes_price'?: number;
-    /**
-     * Updated no price for the order in cents
-     */
-    'no_price'?: number;
-    /**
-     * US dollar amount as a fixed-point decimal string with exactly 4 decimal places
-     */
-    'yes_price_dollars'?: string;
-    /**
-     * US dollar amount as a fixed-point decimal string with exactly 4 decimal places
-     */
-    'no_price_dollars'?: string;
-    /**
-     * Updated quantity for the order
-     */
-    'count'?: number;
-}
-
-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/amend-order-response.ts

@@ -1,24 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Kalshi Trade API Manual Endpoints
- * Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
- *
- * The version of the OpenAPI document: 3.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-// May contain unused imports in some cases
-// @ts-ignore
-import type { Order } from './order';
-
-export interface AmendOrderResponse {
-    'old_order': Order;
-    'order': Order;
-}
-