TAtatum
Account

Count of found entities for get accounts request

/v3/ledger/account/count

1 credit per API call.

Count of accounts that were found from /v3/ledger/account

get/v3/ledger/account/count

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/ledger/account/count
  • Auth
    API key in header x-api-key

Query parameters

pageSizenumber
Example:20

Max number of items per page is 50.

pagenumber

Page number

sort'asc' | 'desc'

Direction of sorting. Can be asc or desc

sortBy'_id' | 'account_number' | 'account_balance' | 'available_balance'
Example:_id

Sort by

activeboolean
Example:true

Filter only active or non active accounts

onlyNonZeroBalanceboolean
Example:true

Filter only accounts with non zero balances

frozenboolean
Example:true

Filter only frozen or non frozen accounts

currencystring
Example:BTC

Filter by currency

accountNumberstring
Example:AC_1011_B

Filter by account number

Response

OK

totalnumber

Total entities

Example response

{
  "total": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.