Search Settlements
get
Search settlement
Authorizations
Query parameters
pageinteger | nullableOptionalDefault:
Defines the page number to be fetched.
1
Example: 3
page_sizeinteger | nullableOptionalDefault:
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
20
Example: 40
Responses
200
settlement search results
application/json
400
invalid search parameters
application/json
get
GET /settlements HTTP/1.1
Host:
X-Ledger-API-Key: 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
}
}
Last updated