GET

List addresses sorted by balance

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

Path Params

coin string required

A cryptocurrency symbol or token ticker symbol
walletId string required

matches ^[0-9a-f]{32}$

Query Params

page string number

page number

>= 1

Defaults to 1
limit string number

Maximum number of results to return

>= 1 · <= 500

Defaults to 500
sort string enum

Sort order of returned addresses based on balance. (1 for ascending, -1 for descending)

Defaults to -1

1-1
token string

Name of the token for which the addresses need to be fetched
nftCollectionId string

NFT collection ID for which the addresses need to be fetched
nftId string

NFT ID for which the addresses need to be fetched

Responses

200

Response Body

object

Represents the result of a query for addresses with balances. This structure contains the details of a set of addresses, their associated balances, and pagination information about the query results.

coin string required

The coin associated with the address balances
page number

The current page number
totalAddressCount number

Total number of addresses present
totalPages number

Total number of pages available for pagination
addresses array of objects
addresses object
- chain number enum required
  
  011011202130314041
- coin string required
  
  A cryptocurrency symbol or token ticker symbol
- index number required
- wallet string required
- id string
  
  Platform public ID for an address
  
  matches ^[0-9a-f]{32}$
- address string
  
  up to 250 characters
- balance object
  balance object
  - balanceString string required
    
    String representation of the balance. Guaranteed to not lose precision.
  - confirmedBalanceString string required
    
    The total balance of confirmed transactions for the address (in the chain's base unit). Guaranteed to not lose precision.
  - spendableBalanceString string required
    
    The total balance of the address (in the chain's base unit) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision.
  - updated string
    
    The last time a transaction affected the balance of this address
  - balance number
  - lockedBalanceString string
  - reservedBalanceString string
  - totalReceived number
    
    The total amount received on this address (in the chain's base unit)
  - totalSent number
    
    The total amount sent from this address (in the chain's base unit)
  - transferCount number
  - tokens map of objects
    
    tokens object
    
    <key> object
  - nfts map of objects
    
    nfts object
    
    <key> object
  - unsupportedNfts map of objects
    
    unsupportedNfts object
    
    <key> object
  - type object
  - metadata object
- coinSpecific object
  
  Properties specific to certain coin types
  ONE OF
  rootAddress string required
  
  trustedTokens array of objects
  
  trustedTokens object
  
  state string enum
  
  pendingactive
  
  limit string
  
  token string
  
  addressVersion number
  
  threshold number
  
  bitgoKey object
  
  bitgoPubKey string
  rootAddress string required
  
  memoId string required
  threshold number required
  
  addresses array of strings required
  redeemScript string
  
  witnessScript string
  format string enum
  
  cashaddrbase58
  
  redeemScript string
  
  witnessScript string
  accountHash string required
  
  rootAddress string required
  
  transferId string required
  rootAddress string required
  
  nonceTracker object required
  
  nonceTracker object
  
  lastReservedNonce number required
  
  lastExecutedNonce number required
  
  detectedMissingNonces array of objects required
  
  detectedMissingNonces object
  
  nonce number required
  
  isNonceLocked boolean required
  
  nonceLockExpireTime string date
  
  detecMissingNoncesData array of objects required
  
  detecMissingNoncesData object
  
  nonce number required
  
  isNonceLocked boolean required
  
  nonceLockExpireTime string date
  rootAddress string required
  
  memoId string required
  creationFailure array of strings required
  
  forwarderVersion number required
  
  nonce number required
  
  feeAddress string required
  
  pendingChainInitialization boolean required
  
  pendingDeployment boolean required
  
  txCount number required
  
  updateTime string date required
  
  hopTxid string
  
  salt string
  
  usdtBug boolean
  
  isTss boolean
  
  isNonceLocked boolean
  
  nonceLockExpireTime string date
  
  previousLowBalanceEmailSentAt string date
  feeAddress string
  bankAccountId string
  
  faBankAccountId string
  
  bankAccount object
  
  bankAccount object
  
  accountNumber string required
  
  address1 string required
  
  name string required
  
  owner object required
  
  owner object
  
  name string required
  
  address1 string required
  
  address2 string
  
  address3 string
  
  idHash string required
  
  verificationState string required
  
  address2 string
  
  address3 string
  
  enterpriseId string
  
  id string
  
  routingNumber string
  
  shortCountryCode string
  
  swiftCode string
  
  type string
  baseAddress string required
  
  memoId string required
  <key> object
  rootAddress string required
  
  minimumFunding number required
  
  pendingChainInitialization boolean required
  
  trustedTokens array of objects required
  
  trustedTokens object
  
  state string enum
  
  pendingactive
  
  limit string
  
  token string
  
  nonceExpiresAt string date
  
  nonceTxRequestid string
  
  type string
  baseAddress string required
  
  memoId string required
  memoId string required
  
  rootAddress string required
  <key> object
  counter number required
  
  updateTime string date required
  
  txCount number required
  
  pendingChainInitialization boolean required
  
  pendingPublicKeyRevelation boolean required
  
  creationFailure array of strings required
  
  delegate string
  
  previousLowBalanceEmailSentAt string date
  rootPub string required
  nonceTracker object required
  
  nonceTracker object
  
  detectedMissingNonces array of objects required
  
  detectedMissingNonces object
  
  nonce number required
  
  isNonceLocked boolean required
  
  nonceLockExpireTime string date
  
  detectedMissingNoncesData array of objects required
  
  detectedMissingNoncesData object
  
  nonce number required
  
  isNonceLocked boolean required
  
  nonceLockExpireTime string date
  addresses array of strings required
- label string
  
  A human-readable label for the address
  
  up to 250 characters
- lastNonce number
  
  Defaults to -1
- token string
- proof string
- signature string
- lastConsolidatedTime string date
- needsConsolidation boolean
- tokenConsolidationState object
- tokenAddress object
message string

Optional message from the response
count number

Count of the addresses in the current response

202

Accepted

Response Body

object

name string

Error code
context map of objects required

Properties that apply to a specific error name
context object
- <key> object
error string required

Human-readable error message
requestId string required

Client request id

400

Bad Request

Response Body

object

name string

Error code
context map of objects required

Properties that apply to a specific error name
context object
- <key> object
error string required

Human-readable error message
requestId string required

Client request id

403

Forbidden

Response Body

object

name string

Error code
context map of objects required

Properties that apply to a specific error name
context object
- <key> object
error string required

Human-readable error message
requestId string required

Client request id

curl --request GET \ --url 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/addresses/balances?page=1&limit=500&sort=-1&token=string&nftCollectionId=string&nftId=string' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/addresses/balances?page=1&limit=500&sort=-1&token=string&nftCollectionId=string&nftId=string'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/v2/coin/wallet/walletId/addresses/balances?page=1&limit=500&sort=-1&token=string&nftCollectionId=string&nftId=string") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/addresses/balances?page=1&limit=500&sort=-1&token=string&nftCollectionId=string&nftId=string', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/v2/coin/wallet/walletId/addresses/balances?page=1&limit=500&sort=-1&token=string&nftCollectionId=string&nftId=string" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "coin": "trx", "page": 0, "totalAddressCount": 0, "totalPages": 0, "addresses": [ { "chain": 0, "coin": "btc", "index": 0, "wallet": "string", "id": "59cd72485007a239fb00282ed480da1f", "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS", "balance": { "balanceString": "500000", "confirmedBalanceString": "400000", "spendableBalanceString": "40000", "updated": "string", "balance": 50000, "lockedBalanceString": "string", "reservedBalanceString": "string", "totalReceived": 0, "totalSent": 0, "transferCount": 0, "tokens": { "key": "string" }, "nfts": { "key": "string" }, "unsupportedNfts": { "key": "string" }, "type": "string", "metadata": "string" }, "coinSpecific": { "rootAddress": "string", "trustedTokens": [ { "state": "pending", "limit": "string", "token": "string" } ], "addressVersion": 0, "threshold": 0, "bitgoKey": "string", "bitgoPubKey": "string" }, "label": "Bob's Hot Wallet Address", "lastNonce": -1, "token": "string", "proof": "string", "signature": "string", "lastConsolidatedTime": "string", "needsConsolidation": true, "tokenConsolidationState": "string", "tokenAddress": "string" } ], "message": "string", "count": 0 }