Ctrl+K

List addresses

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

List receive addresses on a wallet

Path Parameters

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

Query Parameters

  • labelContainsstring
    A case-insensitive regular expression which will be used to filter returned addresses based on their address label.
  • limitintegerDefault: 25
    Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.
  • minebooleanDefault: false
    Whether to return only the addresses which the current user has created.
  • prevIdstring
    Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$
  • 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.
  • sortintegerDefault: 1
    Sorts the order of addresses when comparing their address IDs. For ascending, pass '1'. For descending, pass '-1'.
    Enum: -1 1
  • chainsinteger
    Filter by address chain. May be given multiple times.
    Example: 1
    Enum: 0 1 10 11 20 21 30 31 40 41
  • includeBalancesbooleanDefault: false
    Whether to include address balances
  • includeTokensbooleanDefault: true
    Whether to include token addresses
  • includeTotalAddressCountbooleanDefault: false
    For large wallets (>100k addresses), include total count of addresses (including addresses pending on-chain) matching the query.
  • returnBalancesForTokenstring
    Name of the token that the response should include balances for. (Eth and Celo only)
  • pendingDeploymentboolean
    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)
  • sortedFieldstring
    Field by which addresses are sorted. If not provided, defaults to address IDs.
    Enum: label token
  • sortedFieldDirectionstringDefault: 1
    Sorts the order of addresses returned on "sortedField". For ascending, pass '1'. For descending, pass '-1'. If addresses have same "sortedField" value, sort by address ID and sort the order using "sort".
    Enum: -1 1
  • tokenstring
    Filters by token name. Use only with off-chain (ofc) wallets. If specified multiple times, returns addresses that apply to any of the given tokens.
    Example: "ofctbtc"

200 Response

coin string
totalAddressCount integer
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.
pendingAddressCount integer
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.
addresses array[object]
id string
platform public id for an address
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
address string
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
chain integer
Allowed values: 0 1 10 11 20 21 30 31 40 41
Example: 1
index integer
coin string
lastNonce integer
Default: -1
wallet string
The wallet which contains this address
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coinSpecific object
Properties which are specific to certain coin types
balance object
Balance of the address. In case of Eth and Celo, if returnBalancesForToken is passed with includeBalances, then it will return token balance in the address object. This field will be present only when "includeBalances" query param is passed as true.
label
string or null
A human-readable label for the address.
Max length: <= 250 characters
Example: Bob's Hot Wallet Address
addressType string
Allowed values: p2sh p2shP2wsh p2wsh p2tr p2trMusig2
Example: p2sh
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

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code