Ctrl+K

Get address

get/api/v2/{coin}/wallet/{walletId}/address/{addressOrId}

Gets a receive address on a wallet

Path Parameters

  • addressOrIdstringRequired
    Address or Id which will be used for information lookup
  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: "btc"
  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • dtstring
    For XRP addresses
  • memoIdstring
    For XLM addresses

200 Response

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
xlm object
txlm object
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.
updated string <date-time>
The last time a transaction affected the balance of this address
balance integer
The cleared balance
Example: 50000
balanceString string
String representation of "balance". Guaranteed to not lose precision.
Example: 50000
totalReceived integer
The total amount received on this address (in the chain's base unit)
totalSent integer
The total amount send from this address (in the chain's base unit)
confirmedBalanceString string
The total balance of confirmed transactions for the address (in the chain's base unit). Guaranteed to not lose precision.
Example: 40000
spendableBalanceString string
The total balance of the address (in the chain's base unit) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision.
Example: 40000
labelOne of
Example: Bob's Hot Wallet Address
addressType string
Allowed values: p2sh p2shP2wsh p2wsh p2tr
Example: p2sh

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