Ctrl+K

List addresses sorted by balance

get/api/v2/{coin}/wallet/{walletId}/addresses/balances

List addresses by sorted balances on a wallet. Supported coins: TRX.

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: trx
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • pagestring<number>Default: 1
    page number
    Minimum: >= 1
  • limitstring<number>Default: 500
    Maximum number of results to return
    Minimum: >= 1
    Maximum: <= 500
  • sortstringDefault: -1
    Sort order of returned addresses based on balance. (1 for ascending, -1 for descending)
    Enum: 1 -1
  • tokenstring
    Name of the token for which the addresses need to be fetched
  • nftCollectionIdstring
    NFT collection ID for which the addresses need to be fetched
  • nftIdstring
    NFT ID for which the addresses need to be fetched
  • addressesNeedingFundingboolean
  • addressesEligibleForConsolidationboolean

200 Response

coin string required
The coin associated with the address balances
Example: trx
page number
The current page number
totalAddressCount number
Total number of addresses present
totalPages number
Total number of pages available for pagination
addresses array[object]
List of addresses with their balances and other fields
chain number required
Allowed values: 0 1 10 11 20 21 30 31 40 41
coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
index number required
wallet string required
id string
Platform public ID for an address
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
address string
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
balance object
coinSpecificOne of
Properties specific to certain coin types
label string
A human-readable label for the address
Max length: <= 250 characters
Example: Bob's Hot Wallet Address
lastNonce number
Default: -1
token string
proof string
signature string
lastConsolidatedTime string <date>
needsConsolidation boolean
tokenConsolidationState
tokenAddress
message string
Optional message from the response
count number
Count of the addresses in the current response

202 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id