kalshi-typescript
Version:
OpenAPI client for kalshi-typescript
71 lines (70 loc) • 2.51 kB
TypeScript
/**
* Kalshi Trade API Manual Endpoints
* Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
*
* The version of the OpenAPI document: 3.11.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { AssociatedEvent } from './associated-event';
export interface MultivariateEventCollection {
/**
* Unique identifier for the collection.
*/
'collection_ticker': string;
/**
* Series associated with the collection. Events produced in the collection will be associated with this series.
*/
'series_ticker': string;
/**
* Title of the collection.
*/
'title': string;
/**
* Short description of the collection.
*/
'description': string;
/**
* The open date of the collection. Before this time, the collection cannot be interacted with.
*/
'open_date': string;
/**
* The close date of the collection. After this time, the collection cannot be interacted with.
*/
'close_date': string;
/**
* List of events with their individual configuration.
*/
'associated_events': Array<AssociatedEvent>;
/**
* [DEPRECATED - Use associated_events instead] A list of events associated with the collection. Markets in these events can be passed as inputs to the Lookup and Create endpoints.
*/
'associated_event_tickers': Array<string>;
/**
* Whether the collection is ordered. If true, the order of markets passed into Lookup/Create affects the output. If false, the order does not matter.
*/
'is_ordered': boolean;
/**
* [DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create.
*/
'is_single_market_per_event': boolean;
/**
* [DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of \'yes\' may be used.
*/
'is_all_yes': boolean;
/**
* The minimum number of markets that must be passed into Lookup/Create (inclusive).
*/
'size_min': number;
/**
* The maximum number of markets that must be passed into Lookup/Create (inclusive).
*/
'size_max': number;
/**
* A functional description of the collection describing how inputs affect the output.
*/
'functional_description': string;
}