GET /v1/account/{addr}/settlementsengine.settled on
GET /v1/account/{addr}, which holds the last eight days,
this keeps every one, so a book the contract may still owe you (see
Settlement) can always be found.query limitintegerdefault: 100query beforeintegerpos of the last settlement of the page before: the next page is the settlements before it.query envelope1{"position", "settlements"}.123456[ { "pos": 920114, "underlyingKey": 7, "specifier": 859008923130267914, "quantity": -1, "amount": -25800000 } ]
| Field | Meaning |
pos | The settlement's stream position, which names it. |
underlyingKey, specifier | The contract. Its expiry is in the specifier (see Instruments); its settlement price is on GET /v1/settlements. |
quantity | The position that settled, signed: positive long, negative short. |
amount | The cash the settlement moved for this position, micro-USDC: positive paid to you, negative paid by you. |
503 with Retry-After: 1. Each settlement also arrives live as a
positionSettled event on your WebSocket account: channel.