Ctrl+K

List forwarder addresses and balances

get/api/v2/{coin}/wallet/{walletId}/forwarders/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 Parameters

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

Query Parameters

  • minimumBalancestring<number>
    Lower bound of balance range.
  • maximumBalancestring<number>
    Upper bound of balance range.

200 Response

forwarders array[object] required
address string required
The forwarder address.
balance string required
Current balance of the forwarder address.
json
1
2
3
4
5
6
7
8
{
  "forwarders": [
    {
      "address": "string",
      "balance": "string"
    }
  ]
}

400 Response

One of
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
json
1
2
3
4
5
6
{
  "name": "string",
  "context": {},
  "error": "string",
  "requestId": "string"
}