Skip to main content
GET
Get Settlements

Authorizations

KALSHI-ACCESS-KEY
string
header
required

Your API key ID

KALSHI-ACCESS-SIGNATURE
string
header
required

Base64 signature of the pre-sign text (timestamp + method + path) made with the API key's algorithm - RSA-PSS with SHA-256 for RSA keys, Ed25519 for Ed25519 keys

KALSHI-ACCESS-TIMESTAMP
string
header
required

Request timestamp in milliseconds

Query Parameters

limit
integer<int64>
default:100

Number of results per page. Defaults to 100.

Required range: 1 <= x <= 1000
cursor
string

Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.

ticker
string

Filter by market ticker

event_ticker
string

Event ticker to filter by. Only a single event ticker is supported.

min_ts
integer<int64>

Filter items after this Unix timestamp

max_ts
integer<int64>

Filter items before this Unix timestamp

subaccount
integer

Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.

Required range: x >= 0

Response

Settlements retrieved successfully

settlements
object[]
required
cursor
string