Account

List Settlements

Your settled positions: what resolved, what you held, what it paid.

One row per position a market resolution closed, newest position first: rows are ordered by position_id (the paging cursor), NOT by settled_at, so an older position that resolved recently sorts below a newer one that resolved earlier. Filter by settlement time with from / to. payout is the amount the ledger credited (payout_source = "ledger"); for positions settled before 2026-06-11 it is quantity × payout_per_share (payout_source = "reconstructed"). result is won, lost, split (a 50/50 resolution), expired (refunded, the market never resolved), partial or unknown. Numbers are strings. Page with next_cursor; an empty string means the last page.

GET

account

settlements

List Settlements

curl --request GET \
  --url https://api.polysimulator.com/v1/account/settlements \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.polysimulator.com/v1/account/settlements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polysimulator.com/v1/account/settlements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polysimulator.com/v1/account/settlements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/account/settlements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "position_id": 123,
      "market_id": "<string>",
      "outcome": "<string>",
      "result": "<string>",
      "quantity": "<string>",
      "avg_entry_price": "<string>",
      "cost_basis": "<string>",
      "payout": "<string>",
      "realized_pnl": "<string>",
      "payout_source": "<string>",
      "settled_at": "<string>",
      "market_question": "<string>",
      "winning_outcome": "<string>",
      "payout_per_share": "<string>",
      "exit_reason": "<string>",
      "wallet_id": 123,
      "wallet_kind": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

Authorizations

X-API-Key

string

header

required

Issue from /v1/keys (or admin-issued for enterprise tier).

Headers

X-API-Key

string | null

Your PolySimulator API key

POLY_API_KEY

string | null

Polymarket-CLOB-compat alias for X-API-Key (underscore form). SDK clients ported from Polymarket can authenticate without changing header names. X-API-Key takes precedence when both are provided.

Poly-API-Key

string | null

PM-CLOB-compat dashed-form alias for X-API-Key. Same value semantics as POLY_API_KEY but with HTTP-conventional dash separators. Both spellings are accepted end-to-end.

authorization

string | null

PM-CLOB-compat: Authorization: Bearer ps_live_... (or ps_test_...) is accepted as an alias for X-API-Key so py-clob-client and other ported SDKs authenticate without header name changes. Bearer JWTs are NOT accepted here — use the dashboard-auth endpoints for those.

Query Parameters

limit

integer

default:100

Rows per page (max 500).

Required range: 1 <= x <= 500

cursor

string | null

next_cursor from the previous page. Omit for the newest page.

wallet_id

string | null

Wallet scope: an integer wallet id you own (404 WALLET_NOT_FOUND otherwise; MAIN/API wallet ids fold in legacy rows recorded before per-wallet attribution, matching /portfolio), 'all' (every wallet you own, including UI MAIN/SANDBOX wallets), or 'api' (your API wallet — includes legacy pre-attribution rows). Keywords are case-insensitive; any other value returns 422 VALIDATION_FAILED. Default (omitted) = 'api' since 2026-06-10, matching /balance, /portfolio and /equity; before 2026-06-10 the default was all-wallets — pass wallet_id=all to keep the old behaviour.

market_id

string | null

Filter to one market condition_id.

Maximum string length: 80

from

string | null

Inclusive lower bound on the settlement time. UTC ISO-8601 (2026-06-05T13:04:05Z) or YYYY-MM-DD. 422 if unparseable.

string | null

Inclusive upper bound on the settlement time. UTC ISO-8601 or YYYY-MM-DD. 422 if unparseable.

Response

Successful Response

data

SettlementRow · object[]

required

Show child attributes

next_cursor

string

required

List Settlements

curl --request GET \
  --url https://api.polysimulator.com/v1/account/settlements \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.polysimulator.com/v1/account/settlements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polysimulator.com/v1/account/settlements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polysimulator.com/v1/account/settlements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/account/settlements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "position_id": 123,
      "market_id": "<string>",
      "outcome": "<string>",
      "result": "<string>",
      "quantity": "<string>",
      "avg_entry_price": "<string>",
      "cost_basis": "<string>",
      "payout": "<string>",
      "realized_pnl": "<string>",
      "payout_source": "<string>",
      "settled_at": "<string>",
      "market_question": "<string>",
      "winning_outcome": "<string>",
      "payout_per_share": "<string>",
      "exit_reason": "<string>",
      "wallet_id": 123,
      "wallet_kind": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

Overview

Endpoints

List Settlements

Authorizations

Headers

Query Parameters

Response