GET
List your settlements
/api/v1/settlements · needs an API key
What resolved markets paid you, newest first.
Each resolved market you held shares of when it resolved: the winning outcome, your YES and NO shares, and what VPX paid for them (a winning share pays 100¢, a losing one nothing). VPX pays out automatically at resolution; there is nothing to claim.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| since | query | string (date-time) | Only markets resolved after this time (ISO 8601, e.g. 2026-10-27T18:00:00Z) |
| limit | query | integer | How many to return (1–1000, default 100) Default 100. |
| cursor | query | string | From a previous page's nextCursor |
Request
curl "https://www.vancouverpx.ca/api/v1/settlements" \
-H "Authorization: Bearer $VPX_API_KEY"Response
200 with this object:
| Field | Type | Description |
|---|---|---|
| settlements | Settlement[] | |
| nextCursor | string | null | Pass as cursor to get the next page; null on the last page |
Example
{
"settlements": [
{
"marketId": "3f1c0f2e-6a55-4a8e-9b53-2a1f0c9d7e11",
"marketQuestion": "Will the Bank of Canada cut rates on October 28?",
"walletId": "clx8w2k3p0001qz8r5t1y7u4v",
"outcome": "YES",
"resolvedAt": "2026-10-28T14:05:00.000Z",
"yesQuantity": 40,
"noQuantity": 0,
"yesPayout": 100,
"noPayout": 0,
"payout": 4000
}
],
"nextCursor": null
}Errors
The errors every endpoint can answer.