Skip to main content
GET
Get coverage
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

listing_ids
string[]

Rook listing IDs from /markets or /markets:resolve. Select the venue and outcome side explicitly; repeat the query parameter for multiple listings.

Minimum array length: 1

Opaque text identifier. Preserve its exact value.

Minimum string length: 1
market_ids
string[]

Rook market IDs in this resource. On an event these reflect its source venue membership; on a family they identify the related market members.

Minimum array length: 1

Opaque text identifier. Preserve its exact value.

Minimum string length: 1
family_id
string

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
venue
string

Venue identifier, such as polymarket or kalshi. Required when looking up a venue-native ID; never inferred from the ID.

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