GET

List forwarder addresses and balances

Lists all forwarder addresses and their balances for a wallet. By default, returns low-balance forwarder addresses. A forwarder address has a low balance if the number of assets in it is less than the balance times by the current gas price times the transaction gas limit.

Path Params

coin string required

A cryptocurrency symbol or token ticker symbol
walletId string required

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

Query Params

minimumBalance string number

Lower bound of balance range.
maximumBalance string number

Upper bound of balance range.

Responses

200

Response Body

object

forwarders array of objects required
forwarders object
- address string required
  
  The forwarder address.
- balance string required
  
  Current balance of the forwarder address.

400

Bad Request

Response Body

ONE OF

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

name string enum required

InvalidWalletId
context object required
context object
- id string required
  
  matches ^[0-9a-f]{32}$
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/forwarders/balances&minimumBalance=string&maximumBalance=string' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/v2/coin/wallet/walletId/forwarders/balances&minimumBalance=string&maximumBalance=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/forwarders/balances&minimumBalance=string&maximumBalance=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/forwarders/balances&minimumBalance=string&maximumBalance=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/forwarders/balances&minimumBalance=string&maximumBalance=string" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)