Skip to main content
POST
Calculate payouts
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.

Body

application/json
selection
object[]
required

One or more explicitly selected outcome/listing references; no rows for unrequested instruments.

Minimum array length: 1

Supply exactly one outcome_id or listing_id; never both.

scenarios
object[]

Optional single-family references or compatible cross-family tuples selecting columns; omit for all applicable columns.

Minimum array length: 1
scenario_pins
object[]

Optional immutable family/version pins; must agree with explicit scenario references.

require_complete_coverage
boolean
default:true

True rejects missing selected payout interpretations; false returns scoped coverage and supported rows.

page_size
integer
default:50

Requested maximum scenario columns per page; proposed default 50, subject to disclosed service bound.

Required range: x >= 1
page_token
string

Continuation bound to the same selection, filters and pinned versions; no input changes between pages.

Response

200 - application/json

Success.

matrices
object[]
required
next_page_token
string | null
required
coverage
object
required
versions
object
required