Returns an address's balance.
GET/api/explorer/v2/balance/:address
Returns the balance of IOTA tokens owned by a given bech32 address.
Request
Path Parameters
bech32 address that is referenced by the outputs.
Responses
- 200
- 400
- 404
- 500
Successful operation.
- application/json
- Schema
- Example (from schema)
- default
Schema
The total value held in unspent outputs that is unlockable by the given address or currently timelocked. Does not include funds held in storage deposit.
The total value held in unspent outputs that is immediately unlockable at ledgerIndex by the given address. Does not include funds held in storage deposit.
The ledger index for which the balance calculation was performed.
{
"totalBalance": "string",
"availableBalance": "string",
"ledgerIndex": 0
}
{
"totalBalance": 100000,
"availableBalance": 99900,
"ledgerIndex": 500000
}
Unsuccessful operation: indicates that the provided parameters are invalid.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 400,
"message": "invalid data provided"
}
}
Unsuccessful operation: indicates that the requested data was not found.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 404,
"message": "could not find data"
}
}
Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 500,
"message": "internal server error"
}
}