Ctrl+K

Get wallet addresses (admin impersonate)

get/api/v2/{coin}/admin/impersonate/{impersonateUser}/wallet/{walletId}/addresses

Path Parameters

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

Query Parameters

  • includeBalancesboolean
    Whether to include address balances
  • includeTokensboolean
    Whether to include token addresses
  • labelContainsstring
    Filter addresses based on their label
  • limitstring
    Maximum number of results to return
  • sortstring
    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
  • sortedFieldDirectionstring
    Sort order of the returned addresses on the sortedField
  • chainsstring
    Filter by address chains
  • includeTotalAddressCountboolean
    Include total count of addresses and pending addresses matching the query
  • prevIdstring
    Return the next batch of results, based on the nextBatchPrevId value from the previous batch
  • tokenarray[string]
    This param is used to query and filter addresses by token names in case of ofc wallets
  • returnBalancesForTokenstring
    Token whose balance is to be fetched if this poram is passed with includeBalances param
  • pendingDeploymentstring
    Filter addresses by deployment status i.e. return deployed addresses if param is false and undeployed if it is true
  • segwitboolean

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