kalshi-typescript/docs/MultivariateEventCollection.md

OpenAPI client for kalshi-typescript

# MultivariateEventCollection


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**collection_ticker** | **string** | Unique identifier for the collection. | [default to undefined]
**series_ticker** | **string** | Series associated with the collection. Events produced in the collection will be associated with this series. | [default to undefined]
**title** | **string** | Title of the collection. | [default to undefined]
**description** | **string** | Short description of the collection. | [default to undefined]
**open_date** | **string** | The open date of the collection. Before this time, the collection cannot be interacted with. | [default to undefined]
**close_date** | **string** | The close date of the collection. After this time, the collection cannot be interacted with. | [default to undefined]
**associated_events** | [**Array<AssociatedEvent>**](AssociatedEvent.md) | List of events with their individual configuration. | [default to undefined]
**associated_event_tickers** | **Array<string>** | [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. | [default to undefined]
**is_ordered** | **boolean** | 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. | [default to undefined]
**is_single_market_per_event** | **boolean** | [DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create. | [default to undefined]
**is_all_yes** | **boolean** | [DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of \'yes\' may be used. | [default to undefined]
**size_min** | **number** | The minimum number of markets that must be passed into Lookup/Create (inclusive). | [default to undefined]
**size_max** | **number** | The maximum number of markets that must be passed into Lookup/Create (inclusive). | [default to undefined]
**functional_description** | **string** | A functional description of the collection describing how inputs affect the output. | [default to undefined]

## Example

```typescript
import { MultivariateEventCollection } from 'kalshi-typescript';

const instance: MultivariateEventCollection = {
    collection_ticker,
    series_ticker,
    title,
    description,
    open_date,
    close_date,
    associated_events,
    associated_event_tickers,
    is_ordered,
    is_single_market_per_event,
    is_all_yes,
    size_min,
    size_max,
    functional_description,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)