Skip to main content
GET
Discover relationships
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

market_id
string

Rook canonical market ID. Resolve a venue_market_id first; related markets do not share an ID merely because they share a family. Narrows the selection to this resource. Opaque text identifier. Preserve its exact value.

Minimum string length: 1
outcome_id
string

Rook outcome ID identifying one payout side, such as YES or NO. Opaque text identifier. Preserve its exact value.

Minimum string length: 1
event_id
string

Rook ID for one original venue event. Its identity is scoped to venue and venue_event_id; related events remain separate. Narrows the selection to this resource. 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.

Minimum string length: 1
type
enum<string>

Filter by a supported settlement relationship type, such as implication or exclusivity.

Available options:
EQUALITY,
COMPLEMENT,
IMPLICATION,
EXCLUSIVITY,
OVERLAP

Only return discovered neighbors with listings on this venue; does not change the starting selection.

scenario_version
string

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