kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
45 lines (37 loc) • 2.53 kB
Markdown
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\&
**category** | **string** | Event category (deprecated, use series-level category instead). | [optional] [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 \&
**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]
**last_updated_ts** | **string** | Timestamp of when this event\&
```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,
last_updated_ts,
};
```
[[Back to Model list]](../README.md