Skip to main content

Properties

NameTypeDescriptionNotes
collection_tickerstrUnique identifier for the collection.
series_tickerstrSeries associated with the collection. Events produced in the collection will be associated with this series.
titlestrTitle of the collection.
descriptionstrShort description of the collection.
open_datedatetimeThe open date of the collection. Before this time, the collection cannot be interacted with.
close_datedatetimeThe close date of the collection. After this time, the collection cannot be interacted with.
associated_eventsList[AssociatedEvent]List of events with their individual configuration.
associated_event_tickersList[str][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.
is_orderedboolWhether 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_single_market_per_eventbool[DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create.
is_all_yesbool[DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of ‘yes’ may be used.
size_minintThe minimum number of markets that must be passed into Lookup/Create (inclusive).
size_maxintThe maximum number of markets that must be passed into Lookup/Create (inclusive).
functional_descriptionstrA functional description of the collection describing how inputs affect the output.