Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Address

List addresses

List receive addresses on a wallet

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

Path parameters

coinstring required

A cryptocurrency symbol or token ticker symbol

Example:btc
walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

Query parameters

includeBalancesboolean

Whether to include address balances

includeTokensboolean

Whether to include token addresses

includeAllTokenAddressesboolean

Whether to include all token addresses for receiver addresses

labelContainsstring

A case-insensitive regular expression which will be used to filter returned addresses based on their address label.

limitstring

Maximum number of results to return

sortstring

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

sortedField'token' | 'label'

The field by which addresses will be sorted, if not provided then sort by id by default

sortedFieldDirection'1' | '-1'

Sort order of the returned addresses on the sortedField

chainsstring[]

Filter by address chains

[
  "1"
]
includeTotalAddressCountboolean

For large wallets (>100k addresses), include total count of addresses (including addresses pending on-chain) matching the query.

prevIdstring
Example:59cd72485007a239fb00282ed480da1f

Return the next batch of results, based on the nextBatchPrevId value from the previous batch

tokenstring[]

This param is used to query and filter addresses by token names in case of ofc wallets

[
  "ofctbtc"
]
returnBalancesForTokenstring

Name of the token that the response should include balances for. (Eth and Celo only)

pendingDeploymentstring

Filter the addresses based on their deployment status. Return the deployed addresses if this param is passed as false and return undeployed addresses if it is passed as true. (Eth only)

segwitboolean

DEPRECATED. Mutually exclusive with 'chains'. Returns only 'p2shP2wsh' unspents/addresses on true. Returns only 'p2sh' unspents/addresses on false. Equivalent to passing 10 and 11 as the only value in 'chains' on true, 0 and 1 on false.

Response

OK

coinstring required

A cryptocurrency symbol or token ticker symbol

pendingAddressCountnumber

Total number of addresses pending on-chain initialization on this wallet Note: for wallets with many addresses (100,000 or more), this property may be omitted for performance reasons. If the pending address count is needed for a large wallet, the includeTotalAddressCount query parameter can be used to force an address count to be returned with the initial page of addresses.

totalAddressCountnumber

Total number of addresses which match the provided query parameters. Note: for wallets with many addresses (100,000 or more), this property may be omitted for performance reasons. If the total address count is needed for a large wallet, the includeTotalAddressCount query parameter can be used to force an address count to be returned with the initial page of addresses.

nextBatchPrevIdstring uuid

When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the prevId query parameter.

countnumber

Total number of addresses returned in this response

Example response

{
  "coin": "btc",
  "addresses": [
    {
      "coin": "btc",
      "id": "59cd72485007a239fb00282ed480da1f",
      "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS",
      "balance": {
        "balanceString": "500000",
        "confirmedBalanceString": "400000",
        "spendableBalanceString": "40000",
        "balance": 50000
      },
      "label": "Bob's Hot Wallet Address"
    }
  ],
  "nextBatchPrevId": "585951a5df8380e0e3063e9f"
}