Settlements

GET Settlement

Retrieve a settlement by its settlementId.

get

/v1/settlements/{settlementId}

Authorizations

Path parameters

settlementIdstring · uuidrequired

The settlementId of the settlement

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cams.aquanow.com/api/v1/settlements/{settlementId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

4XX

5XX

200

{
  "settlementId": "bf89babc-b0ee-4234-8afe-47a88416a23b",
  "valueDate": "2025-03-09",
  "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"
    }
  ]
}

Successful response

GET Settlements

Retrieve a list of settlements with optional filtering and pagination.

get

/v1/settlements

Authorizations

Query parameters

settlementStatusstring · enum

Filter settlements by status

Options: PENDING

valueDateStartstring · date-time

Filter settlements by settlement value date lower bound, exclusive

valueDateEndstring · date-time

Filter settlements by settlement value date upper bound, inclusive

afterstring

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring · integer

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

sortFieldstring

Will sort the returned data using the specified field.

sortDirectionstring · enum

Specifies the sort direction for the sortField.

Options: ASC, DESC

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cams.aquanow.com/api/v1/settlements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

4XX

5XX

200

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "settlementId": "bf89babc-b0ee-4234-8afe-47a88416a23b",
      "valueDate": "2025-03-09",
      "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"
        }
      ]
    }
  ]
}

Successful response