Ctrl+K

List addresses

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

List receive addresses on a wallet

Path Parameters

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

Query Parameters

  • includeBalancesbooleanDefault: false
    Whether to include address balances
  • includeTokensbooleanDefault: false
    Whether to include token addresses
  • includeAllTokenAddressesbooleanDefault: false
    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.
  • limitstringDefault: 25
    Maximum number of results to return
    Minimum: >= 1
    Maximum: <= 500
  • sortstringDefault: 1
    Sort order of returned addresses. (1 for ascending, -1 for descending)
  • sortedFieldstring
    The field by which addresses will be sorted, if not provided then sort by id by default
    Enum: token label
  • sortedFieldDirectionstring
    Sort order of the returned addresses on the sortedField
    Enum: 1 -1
  • chainsarray[string]
    Filter by address chains
    Example: 1
    Enum: 0 1 10 11 20 21 30 31 40 41
  • includeTotalAddressCountbooleanDefault: false
    For large wallets (>100k addresses), include total count of addresses (including addresses pending on-chain) matching the query.
  • prevIdstring
    Return the next batch of results, based on the nextBatchPrevId value from the previous batch
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • tokenarray[string]
    This param is used to query and filter addresses by token names in case of ofc wallets
    Example: 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.

200 Response

coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
pendingAddressCount number
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.
totalAddressCount number
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.
addresses array[object]
chain number required
Allowed values: 0 1 10 11 20 21 30 31 40 41
coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
index number required
wallet string required
id string
Platform public ID for an address
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
address string
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
balance object
coinSpecificOne of
Properties specific to certain coin types
label string
A human-readable label for the address
Max length: <= 250 characters
Example: Bob's Hot Wallet Address
lastNonce number
Default: -1
token string
proof string
signature string
lastConsolidatedTime string <date>
needsConsolidation boolean
tokenConsolidationState
tokenAddress
nextBatchPrevId string <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.
Example: 585951a5df8380e0e3063e9f
count number
Total number of addresses returned in this response

202 Response

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

400 Response

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

403 Response

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