Settlements

GET Settlement

Retrieve a settlement by its settlementId.

GEThttps://cams.aquanow.com/api/v1/settlements/{settlementId}

Path parameters

settlementId*string (uuid)

The settlementId of the settlement

Response

2004004014034XX5XX

Successful response

Body

application/json

Settlement (one of)

TradesFees

Request

JavaScriptCurlPython

const response = await fetch('https://cams.aquanow.com/api/v1/settlements/{settlementId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "settlementId": "bf89babc-b0ee-4234-8afe-47a88416a23b",
  "valueDate": "2024-11-21",
  "settlementStatus": "INITIATED",
  "settlementType": "TRADES",
  "tradeDetailPath": "/settlements/2024-01-01/bf89babc-b0ee-4234-8afe-47a88416a23b_trade_detail.json",
  "customerSettlementDetailPath": "/settlements/2024-01-01/bf89babc-b0ee-4234-8afe-47a88416a23b_customer_settlement_detail.json",
  "totalTrades": "3",
  "totalSells": "2",
  "totalBuys": "1",
  "assets": [
    {
      "currency": "BTC",
      "trades": "3",
      "sells": "2",
      "buys": "1",
      "totalQuantity": "9.11679943",
      "quantityBuys": "4.53816155",
      "quantitySells": "4.57863788",
      "clientSends": "0.04047633",
      "clientReceives": "0"
    }
  ]
}

GET Settlements

Retrieve a list of settlements with optional filtering and pagination.

GEThttps://cams.aquanow.com/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 Settlement (one of)

Request

JavaScriptCurlPython

const response = await fetch('https://cams.aquanow.com/api/v1/settlements', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "settlementId": "bf89babc-b0ee-4234-8afe-47a88416a23b",
      "valueDate": "2024-11-21",
      "settlementStatus": "INITIATED",
      "settlementType": "TRADES",
      "tradeDetailPath": "/settlements/2024-01-01/bf89babc-b0ee-4234-8afe-47a88416a23b_trade_detail.json",
      "customerSettlementDetailPath": "/settlements/2024-01-01/bf89babc-b0ee-4234-8afe-47a88416a23b_customer_settlement_detail.json",
      "totalTrades": "3",
      "totalSells": "2",
      "totalBuys": "1",
      "assets": [
        {
          "currency": "BTC",
          "trades": "3",
          "sells": "2",
          "buys": "1",
          "totalQuantity": "9.11679943",
          "quantityBuys": "4.53816155",
          "quantitySells": "4.57863788",
          "clientSends": "0.04047633",
          "clientReceives": "0"
        }
      ]
    }
  ]
}