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

address stringrequired
bech32 address that is referenced by the outputs.
Example: iota1qpf0mlq8yxpx2nck8a0slxnzr4ef2ek8f5gqxlzd0wasgp73utryj430ldu

Responses

200

Successful operation.

application/json

Schema

Schema

totalBalance string

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.

availableBalance string

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.

ledgerIndex integer

The ledger index for which the balance calculation was performed.

Example (from schema)

{
  "totalBalance": "string",
  "availableBalance": "string",
  "ledgerIndex": 0
}

default

{
  "totalBalance": 100000,
  "availableBalance": 99900,
  "ledgerIndex": 500000
}

400

Unsuccessful operation: indicates that the provided parameters are invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

Loading...