Skip to main content

The record of one position being paid out when its market settled. Money is in dollars, prices are per contract, timestamps are epoch milliseconds.

id
string
required

The settlement's id, prefixed smnt_.

Example:

"smnt_6af1a3c27d9e4b0f8c2a65e1d3b7f940"

amount
number
required

The payout in dollars: settlement_price × the contracts held, rounded to the cent. It is what was credited to your cash for this position.

Example:

20

created_at
integer<int64>
required

When the settlement was recorded. Epoch milliseconds.

Example:

1794174120000

updated_at
integer<int64>
required

When the settlement record last changed. Epoch milliseconds; the same as created_at unless the record was corrected later.

Example:

1794174120000

market_id
string
required

The market that settled; the same as market.id on the transaction.

Example:

"pm_6ae1e3c08d5c2a7e3f9b41e6d2c8a604"

position_id
string
required

The position that was paid out, prefixed pos_. Look it up with Get a position; it is closed after settlement.

Example:

"pos_6aedecf7f6c1b4e9a3d27f50c8e4a1d3"

result
enum<string>
required

How the market resolved: yes, no, or scalar (resolved to a value rather than a side). See Market results.

Available options:
yes,
no,
scalar
Example:

"yes"

settlement_price
number
required

What each contract you held paid, in dollars, on the side you held, with up to four decimal places: 1 when your side won, 0 when it lost, and the value in between when the market resolved to one (0.5 for a 50/50 resolution).

Example:

1

yes_quantity
number
required

YES contracts you held when the market settled; 0 if you held NO.

Example:

20

no_quantity
number
required

NO contracts you held when the market settled; 0 if you held YES.

Example:

0