kalshi-typescript 3.6.0 → 3.7.0

package/docs/ExchangeApi.md

@@ -0,0 +1,163 @@
+# ExchangeApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getExchangeAnnouncements**](#getexchangeannouncements) | **GET** /exchange/announcements | Get Exchange Announcements|
+|[**getExchangeSchedule**](#getexchangeschedule) | **GET** /exchange/schedule | Get Exchange Schedule|
+|[**getExchangeStatus**](#getexchangestatus) | **GET** /exchange/status | Get Exchange Status|
+|[**getSeriesFeeChanges**](#getseriesfeechanges) | **GET** /series/fee_changes | Get Series Fee Changes|
+|[**getUserDataTimestamp**](#getuserdatatimestamp) | **GET** /exchange/user_data_timestamp | Get User Data Timestamp|
+
+# **getExchangeAnnouncements**
+> GetExchangeAnnouncementsResponse getExchangeAnnouncements()
+
+ Endpoint for getting all exchange-wide announcements.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetExchangeAnnouncementsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Exchange announcements retrieved successfully |  -  |
+|**500** | Internal server error |  -  |
+
+# **getExchangeSchedule**
+> GetExchangeScheduleResponse getExchangeSchedule()
+
+ Endpoint for getting the exchange schedule.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetExchangeScheduleResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Exchange schedule retrieved successfully |  -  |
+|**500** | Internal server error |  -  |
+
+# **getExchangeStatus**
+> ExchangeStatus getExchangeStatus()
+
+ Endpoint for getting the exchange status.
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ExchangeStatus**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Exchange status retrieved successfully |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+# **getSeriesFeeChanges**
+> GetSeriesFeeChangesResponse getSeriesFeeChanges()
+
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesTicker** | [**string**] |  | (optional) defaults to undefined|
+| **showHistorical** | [**boolean**] |  | (optional) defaults to false|
+
+
+### Return type
+
+**GetSeriesFeeChangesResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Series fee changes retrieved successfully |  -  |
+|**400** | Bad request - invalid input |  -  |
+|**500** | Internal server error |  -  |
+
+# **getUserDataTimestamp**
+> GetUserDataTimestampResponse getUserDataTimestamp()
+
+ There is typically a short delay before exchange events are reflected in the API endpoints. Whenever possible, combine API responses to PUT/POST/DELETE requests with websocket data to obtain the most accurate view of the exchange state. This endpoint provides an approximate indication of when the data from the following endpoints was last validated: GetBalance, GetOrder(s), GetFills, GetPositions
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetUserDataTimestampResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | User data timestamp retrieved successfully |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/ExchangeInstance.md

@@ -0,0 +1,11 @@
+# ExchangeInstance
+
+The exchange instance type
+
+## Enum
+
+* `EventContract` (value: `'event_contract'`)
+
+* `Margined` (value: `'margined'`)
+
+[[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/ExchangeStatus.md

@@ -0,0 +1,24 @@
+# ExchangeStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exchange_active** | **boolean** | False if the core Kalshi exchange is no longer taking any state changes at all. This includes but is not limited to trading, new users, and transfers. True unless we are under maintenance. | [default to undefined]
+**trading_active** | **boolean** | True if we are currently permitting trading on the exchange. This is true during trading hours and false outside exchange hours. Kalshi reserves the right to pause at any time in case issues are detected. | [default to undefined]
+**exchange_estimated_resume_time** | **string** | Estimated downtime for the current exchange maintenance window. However, this is not guaranteed and can be extended. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ExchangeStatus } from 'kalshi-typescript';
+
+const instance: ExchangeStatus = {
+    exchange_active,
+    trading_active,
+    exchange_estimated_resume_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/FcmApi.md

@@ -0,0 +1,92 @@
+# FcmApi
+
+All URIs are relative to *https://api.elections.kalshi.com/trade-api/v2*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getFCMOrders**](#getfcmorders) | **GET** /fcm/orders | Get FCM Orders|
+|[**getFCMPositions**](#getfcmpositions) | **GET** /fcm/positions | Get FCM Positions|
+
+# **getFCMOrders**
+> GetOrdersResponse getFCMOrders()
+
+Endpoint for FCM members to get orders filtered by subtrader ID. This endpoint requires FCM member access level and allows filtering orders by subtrader ID. 
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **subtraderId** | [**string**] | Restricts the response to orders for a specific subtrader (FCM members only) | defaults to undefined|
+| **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**] | Event ticker of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10). | (optional) defaults to undefined|
+| **ticker** | [**string**] | Filter by market ticker | (optional) defaults to undefined|
+| **minTs** | [**number**] | Restricts the response to orders after a timestamp, formatted as a Unix Timestamp | (optional) defaults to undefined|
+| **maxTs** | [**number**] | Restricts the response to orders before a timestamp, formatted as a Unix Timestamp | (optional) defaults to undefined|
+| **status** | [**&#39;resting&#39; | &#39;canceled&#39; | &#39;executed&#39;**]**Array<&#39;resting&#39; &#124; &#39;canceled&#39; &#124; &#39;executed&#39;>** | Restricts the response to orders that have a certain status | (optional) defaults to undefined|
+| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100 | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetOrdersResponse**
+
+### 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** | Orders retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+|**500** | Internal server error |  -  |
+
+# **getFCMPositions**
+> GetPositionsResponse getFCMPositions()
+
+Endpoint for FCM members to get market positions filtered by subtrader ID. This endpoint requires FCM member access level and allows filtering positions by subtrader ID. 
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **subtraderId** | [**string**] | Restricts the response to positions for a specific subtrader (FCM members only) | defaults to undefined|
+| **ticker** | [**string**] | Ticker of desired positions | (optional) defaults to undefined|
+| **eventTicker** | [**string**] | Event ticker of desired positions | (optional) defaults to undefined|
+| **countFilter** | [**string**] | Restricts the positions to those with any of following fields with non-zero values, as a comma separated list | (optional) defaults to undefined|
+| **settlementStatus** | [**&#39;all&#39; | &#39;unsettled&#39; | &#39;settled&#39;**]**Array<&#39;all&#39; &#124; &#39;unsettled&#39; &#124; &#39;settled&#39;>** | Settlement status of the markets to return. Defaults to unsettled | (optional) defaults to undefined|
+| **limit** | [**number**] | Parameter to specify the number of results per page. Defaults to 100 | (optional) defaults to undefined|
+| **cursor** | [**string**] | The Cursor represents a pointer to the next page of records in the pagination | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetPositionsResponse**
+
+### 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** | Positions retrieved successfully |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+|**500** | Internal server error |  -  |
+

package/docs/Fill.md

@@ -0,0 +1,58 @@
+# Fill
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fill_id** | **string** | Unique identifier for this fill | [default to undefined]
+**trade_id** | **string** | Unique identifier for this fill (legacy field name, same as fill_id) | [default to undefined]
+**order_id** | **string** | Unique identifier for the order that resulted in this fill | [default to undefined]
+**client_order_id** | **string** | Client-provided identifier for the order that resulted in this fill | [optional] [default to undefined]
+**ticker** | **string** | Unique identifier for the market | [default to undefined]
+**market_ticker** | **string** | Unique identifier for the market (legacy field name, same as ticker) | [default to undefined]
+**side** | **string** | Specifies if this is a \'yes\' or \'no\' fill | [default to undefined]
+**action** | **string** | Specifies if this is a buy or sell order | [default to undefined]
+**count** | **number** | Number of contracts bought or sold in this fill | [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. | [default to undefined]
+**price** | **number** | Fill price (deprecated - use yes_price or no_price) | [default to undefined]
+**yes_price** | **number** | Fill price for the yes side in cents | [default to undefined]
+**no_price** | **number** | Fill price for the no side in cents | [default to undefined]
+**yes_price_fixed** | **string** | Fill price for the yes side in fixed point dollars | [default to undefined]
+**no_price_fixed** | **string** | Fill price for the no side in fixed point dollars | [default to undefined]
+**is_taker** | **boolean** | If true, this fill was a taker (removed liquidity from the order book) | [default to undefined]
+**created_time** | **string** | Timestamp when this fill was executed | [optional] [default to undefined]
+**fee_cost** | **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]
+**subaccount_number** | **number** | Subaccount number (0 for primary, 1-32 for subaccounts). Present for direct users. | [optional] [default to undefined]
+**ts** | **number** | Unix timestamp when this fill was executed (legacy field name) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Fill } from 'kalshi-typescript';
+
+const instance: Fill = {
+    fill_id,
+    trade_id,
+    order_id,
+    client_order_id,
+    ticker,
+    market_ticker,
+    side,
+    action,
+    count,
+    count_fp,
+    price,
+    yes_price,
+    no_price,
+    yes_price_fixed,
+    no_price_fixed,
+    is_taker,
+    created_time,
+    fee_cost,
+    subaccount_number,
+    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/ForecastPercentilesPoint.md

@@ -0,0 +1,26 @@
+# ForecastPercentilesPoint
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_ticker** | **string** | The event ticker this forecast is for. | [default to undefined]
+**end_period_ts** | **number** | Unix timestamp for the inclusive end of the forecast period. | [default to undefined]
+**period_interval** | **number** | Length of the forecast period in minutes. | [default to undefined]
+**percentile_points** | [**Array<PercentilePoint>**](PercentilePoint.md) | Array of forecast values at different percentiles. | [default to undefined]
+
+## Example
+
+```typescript
+import { ForecastPercentilesPoint } from 'kalshi-typescript';
+
+const instance: ForecastPercentilesPoint = {
+    event_ticker,
+    end_period_ts,
+    period_interval,
+    percentile_points,
+};
+```
+
+[[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/GenerateApiKeyRequest.md

@@ -0,0 +1,22 @@
+# GenerateApiKeyRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name for the API key. This helps identify the key\'s purpose | [default to undefined]
+**scopes** | **Array<string>** | List of scopes to grant to the API key. Valid values are \'read\' and \'write\'. If \'write\' is included, \'read\' must also be included. Defaults to full access ([\'read\', \'write\']) if not provided. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GenerateApiKeyRequest } from 'kalshi-typescript';
+
+const instance: GenerateApiKeyRequest = {
+    name,
+    scopes,
+};
+```
+
+[[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/GenerateApiKeyResponse.md

@@ -0,0 +1,22 @@
+# GenerateApiKeyResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_key_id** | **string** | Unique identifier for the newly generated API key | [default to undefined]
+**private_key** | **string** | RSA private key in PEM format. This must be stored securely and cannot be retrieved again after this response | [default to undefined]
+
+## Example
+
+```typescript
+import { GenerateApiKeyResponse } from 'kalshi-typescript';
+
+const instance: GenerateApiKeyResponse = {
+    api_key_id,
+    private_key,
+};
+```
+
+[[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/GetAccountApiLimitsResponse.md

@@ -0,0 +1,24 @@
+# GetAccountApiLimitsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usage_tier** | **string** | User\'s API usage tier | [default to undefined]
+**read_limit** | **number** | Maximum read requests per second | [default to undefined]
+**write_limit** | **number** | Maximum write requests per second | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAccountApiLimitsResponse } from 'kalshi-typescript';
+
+const instance: GetAccountApiLimitsResponse = {
+    usage_tier,
+    read_limit,
+    write_limit,
+};
+```
+
+[[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/GetApiKeysResponse.md

@@ -0,0 +1,20 @@
+# GetApiKeysResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_keys** | [**Array<ApiKey>**](ApiKey.md) | List of all API keys associated with the user | [default to undefined]
+
+## Example
+
+```typescript
+import { GetApiKeysResponse } from 'kalshi-typescript';
+
+const instance: GetApiKeysResponse = {
+    api_keys,
+};
+```
+
+[[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/GetBalanceResponse.md

@@ -0,0 +1,24 @@
+# GetBalanceResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balance** | **number** | Member\'s available balance in cents. This represents the amount available for trading. | [default to undefined]
+**portfolio_value** | **number** | Member\'s portfolio value in cents. This is the current value of all positions held. | [default to undefined]
+**updated_ts** | **number** | Unix timestamp of the last update to the balance. | [default to undefined]
+
+## Example
+
+```typescript
+import { GetBalanceResponse } from 'kalshi-typescript';
+
+const instance: GetBalanceResponse = {
+    balance,
+    portfolio_value,
+    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/GetCommunicationsIDResponse.md

@@ -0,0 +1,20 @@
+# GetCommunicationsIDResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**communications_id** | **string** | A public communications ID which is used to identify the user | [default to undefined]
+
+## Example
+
+```typescript
+import { GetCommunicationsIDResponse } from 'kalshi-typescript';
+
+const instance: GetCommunicationsIDResponse = {
+    communications_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/GetEventCandlesticksResponse.md

@@ -0,0 +1,24 @@
+# GetEventCandlesticksResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**market_tickers** | **Array<string>** | Array of market tickers in the event. | [default to undefined]
+**market_candlesticks** | **Array<Array<MarketCandlestick>>** | Array of market candlestick arrays, one for each market in the event. | [default to undefined]
+**adjusted_end_ts** | **number** | Adjusted end timestamp if the requested candlesticks would be larger than maxAggregateCandidates. | [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventCandlesticksResponse } from 'kalshi-typescript';
+
+const instance: GetEventCandlesticksResponse = {
+    market_tickers,
+    market_candlesticks,
+    adjusted_end_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/GetEventForecastPercentilesHistoryResponse.md

@@ -0,0 +1,20 @@
+# GetEventForecastPercentilesHistoryResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**forecast_history** | [**Array<ForecastPercentilesPoint>**](ForecastPercentilesPoint.md) | Array of forecast percentile data points over time. | [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventForecastPercentilesHistoryResponse } from 'kalshi-typescript';
+
+const instance: GetEventForecastPercentilesHistoryResponse = {
+    forecast_history,
+};
+```
+
+[[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/GetEventMetadataResponse.md

@@ -0,0 +1,30 @@
+# GetEventMetadataResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_url** | **string** | A path to an image that represents this event. | [default to undefined]
+**featured_image_url** | **string** | A path to an image that represents the image of the featured market. | [optional] [default to undefined]
+**market_details** | [**Array<MarketMetadata>**](MarketMetadata.md) | Metadata for the markets in this event. | [default to undefined]
+**settlement_sources** | [**Array<SettlementSource>**](SettlementSource.md) | A list of settlement sources for this event. | [default to undefined]
+**competition** | **string** | Event competition. | [optional] [default to undefined]
+**competition_scope** | **string** | Event scope, based on the competition. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventMetadataResponse } from 'kalshi-typescript';
+
+const instance: GetEventMetadataResponse = {
+    image_url,
+    featured_image_url,
+    market_details,
+    settlement_sources,
+    competition,
+    competition_scope,
+};
+```
+
+[[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/GetEventResponse.md

@@ -0,0 +1,22 @@
+# GetEventResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | [**EventData**](EventData.md) |  | [default to undefined]
+**markets** | [**Array<Market>**](Market.md) | Data for the markets in this event. This field is deprecated in favour of the \"markets\" field inside the event. Which will be filled with the same value if you use the query parameter \"with_nested_markets=true\". | [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventResponse } from 'kalshi-typescript';
+
+const instance: GetEventResponse = {
+    event,
+    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/GetEventsResponse.md

@@ -0,0 +1,24 @@
+# GetEventsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**Array<EventData>**](EventData.md) | Array of events matching the query criteria. | [default to undefined]
+**milestones** | [**Array<Milestone>**](Milestone.md) | Array of milestones related to the events. | [optional] [default to undefined]
+**cursor** | **string** | Pagination cursor for the next page. Empty if there are no more results. | [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventsResponse } from 'kalshi-typescript';
+
+const instance: GetEventsResponse = {
+    events,
+    milestones,
+    cursor,
+};
+```
+
+[[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/GetExchangeAnnouncementsResponse.md

@@ -0,0 +1,20 @@
+# GetExchangeAnnouncementsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**announcements** | [**Array<Announcement>**](Announcement.md) | A list of exchange-wide announcements. | [default to undefined]
+
+## Example
+
+```typescript
+import { GetExchangeAnnouncementsResponse } from 'kalshi-typescript';
+
+const instance: GetExchangeAnnouncementsResponse = {
+    announcements,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)