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

Examples

The response always contains items, next_page_token, snapshot_id and as_of. An ID lookup returns zero or one item with its full details. No match returns an empty items array. Use q to search titles, descriptions and tags by words. Results are ordered by relevance. page_size sets the maximum results per page; use next_page_token to continue. Other filters, such as category or venue, narrow the search.

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

Rook family ID connecting related markets across original venue events. Omit to browse. Exact lookup retains the items envelope.

Minimum string length: 1
q
string

Search titles, descriptions and tags by words, ignoring letter case. Results are ordered by relevance with stable ID tie-breaking. Other filters narrow the matches.

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

Exact category label used by the catalog, for example rates. Narrows search results.

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