---
search:
  tags:
    - Portfolio
    - GET
seo:
  description: >-
    Returns the caller's settlements — payouts of positions held in markets that
    have… Reference for the GET /portfolio/settlements endpoint in the REST API
    API.
sidebar:
  badge: GET
  label: Get Settlements
title: Get Settlements
type: openapi-operation
---
Returns the caller's settlements — payouts of positions held in markets that have resolved — newest first, optionally filtered by account, market, and settlement-time range. Settlements are ordered by settled_at in the requested direction, tie-broken by account_id and ticker in the same direction.

### Endpoint

- Method and path: `GET /portfolio/settlements`
- Operation ID: `getSettlements`
- API reference: [GET /portfolio/settlements](/api-reference/portfolio/getsettlements)

#### Authorization

- Accepted credentials: `UDX-Access-Key` header and `UDX-Access-Timestamp` header and `UDX-Access-Signature` header; or Bearer token in `Authorization`
- Details: [Authentication](/authentication)

#### Parameters

- `UDX-Version` (`header`) — Dated API version (YYYY-MM-DD). Omit to use the oldest supported version. An unknown version returns `400`.
- `account_id` (`query`) — Filter to a single account.
- `ticker` (`query`) — Filter by market ticker.
- `settled_after` (`query`) — Only return settlements settled after this instant.
- `settled_before` (`query`) — Only return settlements settled before this instant.
- `limit` (`query`) — Maximum number of items to return in one page. Defaults to 10 when omitted; must be an integer from 1 to 100. A value outside that range is rejected with 400 rather than silently clamped. A returned next_page_url preserves the effective value.
- `page` (`query`) — Opaque token identifying the requested page. Clients should not construct or extract this value; follow next_page_url from the previous response unchanged instead.
- `sort` (`query`) — Field to sort settlements by. Defaults to settled_at (settlement time).
- `order` (`query`) — Sort direction. Defaults to desc. Applies to the default sort field when sort is omitted. Nulls sort last in both directions.

#### Responses

- `200` — A page of settled positions.
- `400` — The request doesn't conform to this spec.
- `401` — No valid credential was provided.
- `403` — The credential lacks the `read` scope.
- `422` — Too many position changes match the time range. Narrow `settled_after` and `settled_before`.
- `429` — The member rate limit was exceeded. Wait for `Retry-After`.
- `500` — Something went wrong on UDX's side.
- `503` — Request admission or account setup is unavailable. Retry later.