Ctrl+K

List addresses

get/api/v2/admin/addresses

Query Parameters

  • addressarray[string]
    Filter by address.
    Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
    Max length: <= 250 characters
  • idarray[string]
    Filter by ID.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • limitintegerDefault: 25
    Maximum number of results to return. If the result set is truncated, use the `nextBatchPrevId` value to get the next batch.
    Minimum: >= 1
    Maximum: <= 500
  • prevIdstring
    Return the next batch of results, based on the `nextBatchPrevId` value from the previous batch.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • walletarray[string]
    Filter by wallet.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

200 Response

addresses array[object] 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
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

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