Ctrl+K

Update address

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

Update a receive address on a wallet

Path Parameters

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

Query Parameters

  • dtstring
    For XRP addresses
  • memoIdstring
    For XLM addresses

Request Body

label
string or null
New label which should apply to this address. The caller needs admin permissions for the associated wallet if the label already has a value. Otherwise view or spend permissions are fine because the label has not been set yet. This is due to the fact that customers use address labels to associate addresses with their customers.
Max length: <= 250 characters
Example: Bob's Hot Wallet Address

200 Response

coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
wallet string required
chain number required
Allowed values: 0 1 10 11 20 21 30 31 40 41
index number 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
balanceString string required
String representation of the balance. Guaranteed to not lose precision.
Example: 500000
confirmedBalanceString string required
The total balance of confirmed transactions for the address (in the chain's base unit). Guaranteed to not lose precision.
Example: 400000
spendableBalanceString string required
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
updatedOne of
The last time a transaction affected the balance of this address
balance number
Example: 50000
lockedBalanceString string
reservedBalanceString string
totalReceived number
The total amount received on this address (in the chain's base unit)
totalSent number
The total amount sent from this address (in the chain's base unit)
transferCount number
tokens object
nfts object
unsupportedNfts object
type
metadata
coinSpecificOne of
Properties specific to certain coin types
rootAddress string required
trustedTokens array[object]
addressVersion number
threshold number
bitgoKey
bitgoPubKey string
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

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

401 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