Skip to main content
GET
/
portfolio
/
settlements
Get Settlements
curl --request GET \
  --url https://api.elections.kalshi.com/trade-api/v2/portfolio/settlements \
  --header 'KALSHI-ACCESS-KEY: <api-key>' \
  --header 'KALSHI-ACCESS-SIGNATURE: <api-key>' \
  --header 'KALSHI-ACCESS-TIMESTAMP: <api-key>'
{
  "settlements": [
    {
      "ticker": "<string>",
      "market_result": "yes",
      "yes_count": 123,
      "yes_total_cost": 123,
      "no_count": 123,
      "no_total_cost": 123,
      "revenue": 123,
      "settled_time": "2023-11-07T05:31:56Z",
      "value": 123
    }
  ],
  "cursor": "<string>"
}

Authorizations

KALSHI-ACCESS-KEY
string
header
required

Your API key ID

KALSHI-ACCESS-SIGNATURE
string
header
required

RSA-PSS signature of the request

KALSHI-ACCESS-TIMESTAMP
string
header
required

Request timestamp in milliseconds

Query Parameters

limit
integer
default:100

Number of results per page. Defaults to 100. Maximum value is 200.

Required range: 1 <= x <= 200
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 of desired positions. Multiple event tickers can be provided as a comma-separated list (maximum 10).

min_ts
integer

Filter items after this Unix timestamp

max_ts
integer

Filter items before this Unix timestamp

Response

Settlements retrieved successfully

settlements
object[]
required
cursor
string
I