Accounts

Get Accounts

get

Retrieve a list of accounts with optional filtering and pagination.

Authorizations
Query parameters
accountStatusstring · enumOptional

Filter accunts by status

Possible values:
accountTypestring · enumOptional

Filter account by type

Possible values:
createDateStartstring · date-timeOptional

Filter account by creation date lower bound, exclusive

createDateEndstring · date-timeOptional

Filter accounts by creation date upper bound, inclusive

recentCreditHistorystring · enumOptionalPossible values:
customerIdstring · uuidOptional

Filter accounts by customer ID

afterstringOptional

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

limitstring · integerOptional

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

sortFieldstring · enumOptional

Will sort the returned data using the specified field.

Possible values:
sortDirectionstring · enumOptional

Specifies the sort direction for the sortField.

Possible values:
Responses
200
OK
application/json
get
GET /api/v1/accounts HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "accountStatus": "ACTIVE",
      "accountType": "CREDIT",
      "createDate": "2025-07-01T16:43:55.821Z",
      "credit": {
        "creditCurrency": "USD",
        "creditLimit": "40000",
        "utilizedCredit": "39592.01",
        "unutilizedCredit": "407.99"
      },
      "assets": [
        {
          "asset": "BTC",
          "tradeBalance": "0",
          "custodyBalance": "0",
          "pendingSettlement": "0",
          "open": "0",
          "availableToWithdraw": "0"
        }
      ],
      "recentCreditHistory": [
        {
          "creditLimitRequested": "10000.00",
          "newCreditLimit": "10000.00",
          "action": "INCREASE",
          "updatedAt": "2024-08-01T18:44:05Z"
        }
      ]
    }
  ]
}

Last updated