Search Settlements

get

Search settlement

Authorizations

Ledger_API_Key & Ledger_API_UserLedger_API_Key & Ledger_API_User & Ledger_Store_Auth_TokenLedger_API_UserLedger_API_User & Ledger_Store_Auth_Token

X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Query parameters

pageinteger · min: 1 · nullableOptional

Defines the page number to be fetched.

Default: 1Example: 3

page_sizeinteger · min: -1 · nullableOptional

Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 being special values to return a maximum defined in the gate

Default: 20Example: 40

Responses

200

settlement search results

application/json

400

invalid search parameters

application/json

get

/settlements

HTTPcURLJavaScriptPython

GET /settlements HTTP/1.1
X-Ledger-API-Key: YOUR_API_KEY
X-Ledger-API-User: YOUR_API_KEY
Accept: */*

{
  "edges": [
    {
      "cursor": 0,
      "node": {
        "account_id": 1,
        "amount": 1,
        "asset_manager": {
          "code": "text",
          "id": "text",
          "name": "text",
          "role": "text"
        },
        "custodian": {
          "code": "text",
          "id": "text",
          "name": "text",
          "role": "text"
        },
        "exchange": {
          "code": "text",
          "id": "text",
          "name": "text",
          "role": "text"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "pending": 1,
        "pledge_subaccount_id": 1,
        "state": "ASSIGNED_TO_SETTLEMENT"
      }
    }
  ],
  "page_info": {
    "count": 1,
    "has_next_page": false
  }
}