kalshi-typescript 3.6.0 → 3.7.0

package/docs/CreateOrderGroupResponse.md

@@ -0,0 +1,20 @@
+# CreateOrderGroupResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_group_id** | **string** | The unique identifier for the created order group | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateOrderGroupResponse } from 'kalshi-typescript';
+
+const instance: CreateOrderGroupResponse = {
+    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/CreateOrderRequest.md

@@ -0,0 +1,58 @@
+# 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** | Order quantity in contracts (whole contracts only). Provide count or count_fp; if both provided they must match. | [optional] [default to undefined]
+**count_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
+**yes_price** | **number** |  | [optional] [default to undefined]
+**no_price** | **number** |  | [optional] [default to undefined]
+**yes_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
+**no_price_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
+**expiration_ts** | **number** |  | [optional] [default to undefined]
+**time_in_force** | **string** |  | [optional] [default to undefined]
+**buy_max_cost** | **number** | Maximum cost in cents. When specified, the order will automatically have Fill-or-Kill (FoK) behavior. | [optional] [default to undefined]
+**post_only** | **boolean** |  | [optional] [default to undefined]
+**reduce_only** | **boolean** |  | [optional] [default to undefined]
+**sell_position_floor** | **number** | Deprecated: Use reduce_only instead. Only accepts value of 0. | [optional] [default to undefined]
+**self_trade_prevention_type** | [**SelfTradePreventionType**](SelfTradePreventionType.md) |  | [optional] [default to undefined]
+**order_group_id** | **string** | The order group this order is part of | [optional] [default to undefined]
+**cancel_order_on_pause** | **boolean** | If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason. | [optional] [default to undefined]
+**subaccount** | **number** | The subaccount number to use for this order. 0 is the primary subaccount. | [optional] [default to 0]
+
+## Example
+
+```typescript
+import { CreateOrderRequest } from 'kalshi-typescript';
+
+const instance: CreateOrderRequest = {
+    ticker,
+    client_order_id,
+    side,
+    action,
+    count,
+    count_fp,
+    yes_price,
+    no_price,
+    yes_price_dollars,
+    no_price_dollars,
+    expiration_ts,
+    time_in_force,
+    buy_max_cost,
+    post_only,
+    reduce_only,
+    sell_position_floor,
+    self_trade_prevention_type,
+    order_group_id,
+    cancel_order_on_pause,
+    subaccount,
+};
+```
+
+[[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

@@ -0,0 +1,20 @@
+# CreateOrderResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | [**Order**](Order.md) |  | [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

@@ -0,0 +1,28 @@
+# CreateQuoteRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rfq_id** | **string** | The ID of the RFQ to quote on | [default to undefined]
+**yes_bid** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**no_bid** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**rest_remainder** | **boolean** | Whether to rest the remainder of the quote after execution | [default to undefined]
+**subaccount** | **number** | Optional subaccount number to place the quote under (0 for primary, 1-32 for subaccounts) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateQuoteRequest } from 'kalshi-typescript';
+
+const instance: CreateQuoteRequest = {
+    rfq_id,
+    yes_bid,
+    no_bid,
+    rest_remainder,
+    subaccount,
+};
+```
+
+[[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

@@ -0,0 +1,20 @@
+# CreateQuoteResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The ID of the newly created quote | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateQuoteResponse } from 'kalshi-typescript';
+
+const instance: CreateQuoteResponse = {
+    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/CreateRFQRequest.md

@@ -0,0 +1,36 @@
+# CreateRFQRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market_ticker** | **string** | The ticker of the market for which to create an RFQ | [default to undefined]
+**contracts** | **number** | The number of contracts for the RFQ. Whole contracts only. Contracts may be provided via contracts or contracts_fp; if both provided they must match. | [optional] [default to undefined]
+**contracts_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
+**target_cost_centi_cents** | **number** | DEPRECATED: The target cost for the RFQ in centi-cents. Use target_cost_dollars instead. | [optional] [default to undefined]
+**target_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [optional] [default to undefined]
+**rest_remainder** | **boolean** | Whether to rest the remainder of the RFQ after execution | [default to undefined]
+**replace_existing** | **boolean** | Whether to delete existing RFQs as part of this RFQ\'s creation | [optional] [default to false]
+**subtrader_id** | **string** | The subtrader to create the RFQ for (FCM members only) | [optional] [default to undefined]
+**subaccount** | **number** | The subaccount number to create the RFQ for (direct members only; 0 for primary, 1-32 for subaccounts) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateRFQRequest } from 'kalshi-typescript';
+
+const instance: CreateRFQRequest = {
+    market_ticker,
+    contracts,
+    contracts_fp,
+    target_cost_centi_cents,
+    target_cost_dollars,
+    rest_remainder,
+    replace_existing,
+    subtrader_id,
+    subaccount,
+};
+```
+
+[[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

@@ -0,0 +1,20 @@
+# CreateRFQResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The ID of the newly created RFQ | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateRFQResponse } from 'kalshi-typescript';
+
+const instance: CreateRFQResponse = {
+    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/CreateSubaccountResponse.md

@@ -0,0 +1,20 @@
+# CreateSubaccountResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subaccount_number** | **number** | The sequential number assigned to this subaccount (1-32). | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateSubaccountResponse } from 'kalshi-typescript';
+
+const instance: CreateSubaccountResponse = {
+    subaccount_number,
+};
+```
+
+[[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

@@ -0,0 +1,22 @@
+# DailySchedule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**open_time** | **string** | Opening time in ET (Eastern Time) format HH:MM. | [default to undefined]
+**close_time** | **string** | Closing time in ET (Eastern Time) format HH:MM. | [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

@@ -0,0 +1,28 @@
+# DecreaseOrderRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subaccount** | **number** | Optional subaccount number to use for this decrease (0 for primary, 1-32 for subaccounts) | [optional] [default to 0]
+**reduce_by** | **number** | Number of contracts to reduce by (whole contracts only). Reduce-by may be provided via reduce_by or reduce_by_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided. | [optional] [default to undefined]
+**reduce_by_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
+**reduce_to** | **number** | Number of contracts to reduce to (whole contracts only). Reduce-to may be provided via reduce_to or reduce_to_fp; if both provided they must match. Exactly one of reduce_by(/reduce_by_fp) or reduce_to(/reduce_to_fp) must be provided. | [optional] [default to undefined]
+**reduce_to_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DecreaseOrderRequest } from 'kalshi-typescript';
+
+const instance: DecreaseOrderRequest = {
+    subaccount,
+    reduce_by,
+    reduce_by_fp,
+    reduce_to,
+    reduce_to_fp,
+};
+```
+
+[[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

@@ -0,0 +1,20 @@
+# DecreaseOrderResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | [**Order**](Order.md) |  | [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

@@ -0,0 +1,26 @@
+# ErrorResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | Error code | [optional] [default to undefined]
+**message** | **string** | Human-readable error message | [optional] [default to undefined]
+**details** | **string** | Additional details about the error, if available | [optional] [default to undefined]
+**service** | **string** | The name of the service that generated the error | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ErrorResponse } from 'kalshi-typescript';
+
+const instance: ErrorResponse = {
+    code,
+    message,
+    details,
+    service,
+};
+```
+
+[[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/EventData.md

@@ -0,0 +1,42 @@
+# EventData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_ticker** | **string** | Unique identifier for this event. | [default to undefined]
+**series_ticker** | **string** | Unique identifier for the series this event belongs to. | [default to undefined]
+**sub_title** | **string** | Shortened descriptive title for the event. | [default to undefined]
+**title** | **string** | Full title of the event. | [default to undefined]
+**collateral_return_type** | **string** | Specifies how collateral is returned when markets settle (e.g., \'binary\' for standard yes/no markets). | [default to undefined]
+**mutually_exclusive** | **boolean** | If true, only one market in this event can resolve to \'yes\'. If false, multiple markets can resolve to \'yes\'. | [default to undefined]
+**category** | **string** | Event category (deprecated, use series-level category instead). | [default to undefined]
+**strike_date** | **string** | The specific date this event is based on. Only filled when the event uses a date strike (mutually exclusive with strike_period). | [optional] [default to undefined]
+**strike_period** | **string** | The time period this event covers (e.g., \'week\', \'month\'). Only filled when the event uses a period strike (mutually exclusive with strike_date). | [optional] [default to undefined]
+**markets** | [**Array<Market>**](Market.md) | Array of markets associated with this event. Only populated when \'with_nested_markets=true\' is specified in the request. | [optional] [default to undefined]
+**available_on_brokers** | **boolean** | Whether this event is available to trade on brokers. | [default to undefined]
+**product_metadata** | **object** | Additional metadata for the event. | [default to undefined]
+
+## Example
+
+```typescript
+import { EventData } from 'kalshi-typescript';
+
+const instance: EventData = {
+    event_ticker,
+    series_ticker,
+    sub_title,
+    title,
+    collateral_return_type,
+    mutually_exclusive,
+    category,
+    strike_date,
+    strike_period,
+    markets,
+    available_on_brokers,
+    product_metadata,
+};
+```
+
+[[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

@@ -0,0 +1,40 @@
+# EventPosition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_ticker** | **string** | Unique identifier for events | [default to undefined]
+**total_cost** | **number** | Total spent on this event in cents | [default to undefined]
+**total_cost_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**total_cost_shares** | **number** | Total number of shares traded on this event (including both YES and NO contracts) | [default to undefined]
+**total_cost_shares_fp** | **string** | Fixed-point contract count string (2 decimals, e.g., \"10.00\"; referred to as \"fp\" in field names). Requests accept 0–2 decimal places (e.g., \"10\", \"10.0\", \"10.00\"); responses always emit 2 decimals. Currently only whole contract values are permitted, but the format supports future fractional precision. Integer contract count fields are legacy and will be deprecated; when both integer and fp fields are provided, they must match. | [default to undefined]
+**event_exposure** | **number** | Cost of the aggregate event position in cents | [default to undefined]
+**event_exposure_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**realized_pnl** | **number** | Locked in profit and loss, in cents | [default to undefined]
+**realized_pnl_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+**fees_paid** | **number** | Fees paid on fill orders, in cents | [default to undefined]
+**fees_paid_dollars** | **string** | US dollar amount as a fixed-point decimal string with up to 4 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market\'s price level structure. | [default to undefined]
+
+## Example
+
+```typescript
+import { EventPosition } from 'kalshi-typescript';
+
+const instance: EventPosition = {
+    event_ticker,
+    total_cost,
+    total_cost_dollars,
+    total_cost_shares,
+    total_cost_shares_fp,
+    event_exposure,
+    event_exposure_dollars,
+    realized_pnl,
+    realized_pnl_dollars,
+    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

@@ -0,0 +1,239 @@
+# 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|
+|[**getEventForecastPercentilesHistory**](#geteventforecastpercentileshistory) | **GET** /series/{series_ticker}/events/{ticker}/forecast_percentile_history | Get Event Forecast Percentile History|
+|[**getEventMetadata**](#geteventmetadata) | **GET** /events/{event_ticker}/metadata | Get Event Metadata|
+|[**getEvents**](#getevents) | **GET** /events | Get Events|
+|[**getMarketCandlesticksByEvent**](#getmarketcandlesticksbyevent) | **GET** /series/{series_ticker}/events/{ticker}/candlesticks | Get Event Candlesticks|
+|[**getMultivariateEvents**](#getmultivariateevents) | **GET** /events/multivariate | Get Multivariate Events|
+
+# **getEvent**
+> GetEventResponse getEvent()
+
+ Endpoint for getting 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.
+
+### 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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Event retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**404** | Event not found |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getEventForecastPercentilesHistory**
+> GetEventForecastPercentilesHistoryResponse getEventForecastPercentilesHistory()
+
+Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticker** | [**string**] | The event ticker | defaults to undefined|
+| **seriesTicker** | [**string**] | The series ticker | defaults to undefined|
+| **percentiles** | **Array<number>** | Array of percentile values to retrieve (0-10000, max 10 values) | defaults to undefined|
+| **startTs** | [**number**] | Start timestamp for the range | defaults to undefined|
+| **endTs** | [**number**] | End timestamp for the range | defaults to undefined|
+| **periodInterval** | [**0 | 1 | 60 | 1440**]**Array<0 &#124; 1 &#124; 60 &#124; 1440>** | Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals. | defaults to undefined|
+
+
+### Return type
+
+**GetEventForecastPercentilesHistoryResponse**
+
+### Authorization
+
+[kalshiAccessSignature](../README.md#kalshiAccessSignature), [kalshiAccessKey](../README.md#kalshiAccessKey), [kalshiAccessTimestamp](../README.md#kalshiAccessTimestamp)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Event forecast percentile history retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getEventMetadata**
+> GetEventMetadataResponse getEventMetadata()
+
+ Endpoint for getting metadata about an event by its ticker.  Returns only the metadata information for an event.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventTicker** | [**string**] | Event ticker | defaults to undefined|
+
+
+### Return type
+
+**GetEventMetadataResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Event metadata retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**404** | Event not found |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getEvents**
+> GetEventsResponse getEvents()
+
+Get all events. This endpoint excludes multivariate events. To retrieve multivariate events, use the GET /events/multivariate endpoint. 
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200. | (optional) defaults to 200|
+| **cursor** | [**string**] | Parameter to specify the 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**] | Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event. | (optional) defaults to false|
+| **withMilestones** | [**boolean**] | If true, includes related milestones as a field alongside events. | (optional) defaults to false|
+| **status** | [**&#39;open&#39; | &#39;closed&#39; | &#39;settled&#39;**]**Array<&#39;open&#39; &#124; &#39;closed&#39; &#124; &#39;settled&#39;>** | Filter by event status. Possible values are \&#39;open\&#39;, \&#39;closed\&#39;, \&#39;settled\&#39;. Leave empty to return events with any status. | (optional) defaults to undefined|
+| **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
+| **minCloseTs** | [**number**] | Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds). | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetEventsResponse**
+
+### Authorization
+
+No authorization required
+
+### 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 |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getMarketCandlesticksByEvent**
+> GetEventCandlesticksResponse getMarketCandlesticksByEvent()
+
+ End-point for returning aggregated data across all markets corresponding to an event.
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ticker** | [**string**] | The event ticker | defaults to undefined|
+| **seriesTicker** | [**string**] | The series ticker | defaults to undefined|
+| **startTs** | [**number**] | Start timestamp for the range | defaults to undefined|
+| **endTs** | [**number**] | End timestamp for the range | defaults to undefined|
+| **periodInterval** | [**1 | 60 | 1440**]**Array<1 &#124; 60 &#124; 1440>** | Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day. | defaults to undefined|
+
+
+### Return type
+
+**GetEventCandlesticksResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Event candlesticks retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+
+# **getMultivariateEvents**
+> GetMultivariateEventsResponse getMultivariateEvents()
+
+Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker.
+
+### 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. | (optional) defaults to undefined|
+| **seriesTicker** | [**string**] | Filter by series ticker | (optional) defaults to undefined|
+| **collectionTicker** | [**string**] | Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker. | (optional) defaults to undefined|
+| **withNestedMarkets** | [**boolean**] | Parameter to specify if nested markets should be included in the response. When true, each event will include a \&#39;markets\&#39; field containing a list of Market objects associated with that event. | (optional) defaults to false|
+
+
+### Return type
+
+**GetMultivariateEventsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Multivariate events retrieved successfully |  -  |
+|**400** | Bad request - invalid parameters |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server error |  -  |
+