List addresses

List receive addresses on a wallet

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A cryptocurrency symbol or token ticker symbol

string
required
Query Params
boolean
Defaults to false

Whether to include address balances

boolean
Defaults to false

Whether to include token addresses

boolean
Defaults to false

Whether to include all token addresses for receiver addresses

string

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

string
1 to 500
Defaults to 25

Maximum number of results to return

string
Defaults to 1

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

string
enum

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

Allowed:
string
enum

Sort order of the returned addresses on the sortedField

Allowed:
chains
array of strings

Filter by address chains

chains
boolean
Defaults to false

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

string

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

token
array of strings

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

token
string

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

string

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)

boolean

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.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json