v4

latestOpenAPI 3.0.02026-08-04103181301.4 KB
multivariate

Get Multivariate Event Collections

Endpoint for getting data about multivariate event collections.

get/multivariate_event_collections

Query parameters

status'unopened' | 'open' | 'closed'

Only return collections of a certain status. Can be unopened, open, or closed.

associated_event_tickerstring

Only return collections associated with a particular event ticker.

series_tickerstring

Only return collections with a particular series ticker.

limitinteger

Specify the maximum number of results.

cursorstring

The Cursor represents a pointer to the next page of records in the pagination. This optional parameter, when filled, should be filled with the cursor string returned in a previous request to this end-point.

Response

Collections retrieved successfully

cursorstring

The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page.