Skip to main content
GET
List scenarios
See the integration guide for the workflow and interpretation of this response.

Authorizations

Authorization
string
header
required

Proposed server-to-server API key. No client request HMAC signing scheme is specified.

Headers

X-Client-Request-Id
string

Caller correlation reference; not an idempotency guarantee.

Query Parameters

family_id
string
required

Rook family ID connecting related markets across original venue events. Narrows the selection to this resource. Opaque text identifier. Preserve its exact value.

Minimum string length: 1
scenario_version
string
required

Published family scenario-catalog version. Use together with family_id to pin scenario meaning. Opaque text identifier. Preserve its exact value.

Minimum string length: 1
scenario_ids
string[]

Return only these scenario IDs within the required family and scenario_version. Repeat the parameter for multiple IDs.

Minimum array length: 1

Opaque text identifier. Preserve its exact value.

Minimum string length: 1
page_size
integer
default:50

Requested maximum items; service caps disclosed by coverage. Oversize requests fail explicitly.

Required range: x >= 1
page_token
string

Opaque continuation; reuse the same filters/order. Cursor pins the original snapshot.

Response

200 - application/json

Success.

items
object[]
required
next_page_token
string | null
required
snapshot_id
string
required

Opaque text identifier. Preserve its exact value.

Minimum string length: 1
as_of
string<date-time>
required