Settlements

GET Settlement

Retrieve a settlement by its settlementId.

GEThttp://localhost:3001/api/v1/settlements/{settlementId}

Path parameters

settlementId*string (uuid)

The settlementId of the settlement

Response

2004004014034XX5XX

Successful response

Body

application/json

settlementIdstring (uuid)

settlementStatusenum

PENDING

tradeCountstring (integer)

Example: "3"

quantityBuysstring (integer)

Example: "2"

quantitySellsstring (integer)

Example: "1"

clientSendsarray of object

clientReceivesarray of object

valueDatestring (date)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/settlements/{settlementId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "settlementId": "123e4567-e89b-12d3-a456-426614174000",
  "settlementStatus": "PENDING",
  "tradeCount": "3",
  "quantityBuys": "2",
  "quantitySells": "1",
  "clientSends": [
    {
      "asset": "USD",
      "quantity": "150000"
    }
  ],
  "clientReceives": [
    {
      "asset": "BTC",
      "quantity": "2"
    }
  ],
  "valueDate": "2024-09-12"
}

GET Settlements

Retrieve a list of settlements with optional filtering and pagination.

GEThttp://localhost:3001/api/v1/settlements

Query parameters

Response

2004004014034XX5XX

Successful response

Body

application/json

afterstring

The token of the last item in the response

totalCountstring (integer)

The total number of items in the entire filtered data set

Example: "1"

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/settlements', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "settlementId": "123e4567-e89b-12d3-a456-426614174000",
      "settlementStatus": "PENDING",
      "tradeCount": "3",
      "quantityBuys": "2",
      "quantitySells": "1",
      "clientSends": [
        {
          "asset": "USD",
          "quantity": "150000"
        }
      ],
      "clientReceives": [
        {
          "asset": "BTC",
          "quantity": "2"
        }
      ],
      "valueDate": "2024-09-12"
    }
  ]
}