curl --request GET \
--url https://api.rook.pm/v1/families \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.rook.pm/v1/families"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.rook.pm/v1/families', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"items": [
{
"family_id": "fam_fed_dec_2026",
"title": "December 2026 Fed rate decision",
"description": "Related markets across two distinct illustrative Polymarket events. Original event membership is preserved; the family connects the cut and hold markets.",
"market_ids": [
"mkt_fed_dec_2026_cut",
"mkt_fed_dec_2026_hold"
],
"current_scenario_version": "1",
"scenario_versions": [
"1"
],
"supported_convention_ids": [
"demo_all_legs_win_v1"
],
"analytical_coverage": "COMPLETE",
"observed_at": "2026-10-19T12:00:00Z",
"event_ids": [
"evt_pm_900001",
"evt_pm_900002"
]
}
],
"next_page_token": null,
"snapshot_id": "snap_rates_20261019_120000",
"as_of": "2026-10-19T12:00:00Z"
}List families
Discover Rook’s grouping of related markets across the events maintained by venues. A family sits above venue events and their markets; it does not replace the events or rewrite their source membership. Use family_id for one family, market_ids to find families containing supplied markets, or q to search by topic.
Each item returns family_id, event_ids, market_ids, a readable description, analytical_coverage and available scenario versions. Event and market responses include family_ids so you can reach the same family from either starting point. Several memberships remain explicit rather than forcing an arbitrary exclusive tree.
Use /events?family_id=… to browse its original venue events, /markets?family_id=… for member markets and /scenarios for a published scenario catalog. Membership describes the grouping; analytical_coverage states whether settlement analysis is available. Listing an event in a family does not claim that every market in that event has supported payout analysis.
curl --request GET \
--url https://api.rook.pm/v1/families \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.rook.pm/v1/families"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.rook.pm/v1/families', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"items": [
{
"family_id": "fam_fed_dec_2026",
"title": "December 2026 Fed rate decision",
"description": "Related markets across two distinct illustrative Polymarket events. Original event membership is preserved; the family connects the cut and hold markets.",
"market_ids": [
"mkt_fed_dec_2026_cut",
"mkt_fed_dec_2026_hold"
],
"current_scenario_version": "1",
"scenario_versions": [
"1"
],
"supported_convention_ids": [
"demo_all_legs_win_v1"
],
"analytical_coverage": "COMPLETE",
"observed_at": "2026-10-19T12:00:00Z",
"event_ids": [
"evt_pm_900001",
"evt_pm_900002"
]
}
],
"next_page_token": null,
"snapshot_id": "snap_rates_20261019_120000",
"as_of": "2026-10-19T12:00:00Z"
}Examples
GET /v1/families
GET /v1/families?family_id=fam_fed_dec_2026
GET /v1/families?q=Fed%20rate%20cut&page_size=5
GET /v1/families?category=rates&page_size=20
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
Proposed server-to-server API key. No client request HMAC signing scheme is specified.
Headers
Caller correlation reference; not an idempotency guarantee.
Query Parameters
Rook family ID connecting related markets across original venue events. Omit to browse. Exact lookup retains the items envelope.
1Search titles, descriptions and tags by words, ignoring letter case. Results are ordered by relevance with stable ID tie-breaking. Other filters narrow the matches.
1Rook market IDs in this resource. On an event these reflect its source venue membership; on a family they identify the related market members.
1Opaque text identifier. Preserve its exact value.
1Exact category label used by the catalog, for example rates. Narrows search results.
Venue identifier, such as polymarket or kalshi. Required when looking up a venue-native ID; never inferred from the ID.
Requested maximum items; service caps disclosed by coverage. Oversize requests fail explicitly.
x >= 1Opaque continuation; reuse the same filters/order. Cursor pins the original snapshot.