Skip to main content
GET
/
v1
/
admin
/
settlements
List settlements across all platforms
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keystoneos.xyz/v1/admin/settlements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idempotency_key": "<string>",
      "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "template_version": 123,
      "external_reference": "<string>",
      "settlement_type": "<string>",
      "parties": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "role": "<string>",
          "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_reference": "<string>",
          "name": "<string>",
          "wallet_address": "<string>",
          "chain_id": 123,
          "status": "<string>",
          "confirmed_at": "2023-11-07T05:31:56Z",
          "wallet_address_hint": "<string>",
          "counterparty_reference": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "legs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "settlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "leg_type": "<string>",
          "instrument_id": "<string>",
          "chain_id": 123,
          "token_standard": "<string>",
          "quantity": "<string>",
          "direction": "<string>",
          "party_role": "<string>",
          "status": "<string>",
          "external_reference": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deposit_secret": "<string>",
          "deposit_key": "<string>"
        }
      ],
      "state": "<string>",
      "timeout_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "parent_settlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settlement_category": "<string>",
      "maturity_at": "2023-11-07T05:31:56Z",
      "repo_metadata": {},
      "platform_name": "",
      "environment_slug": ""
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.keystoneos.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Query Parameters

​
platform_id
string<uuid> | null
​
environment_id
string<uuid> | null
​
environment_slug
string | null

Filter by environment slug (e.g., production, staging)

​
state
string | null
​
template_id
string<uuid> | null
​
created_after
string<date-time> | null
​
created_before
string<date-time> | null
​
search
string | null

Search by idempotency key

​
limit
integer
default:50
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

​
items
AdminSettlementRead · object[]
required
​
total
integer
required
​
limit
integer
required
​
offset
integer
required