Returns all ledger updates involving a given bech32 address.
GET/api/explorer/v2/ledger/updates/by-address/:address
Returns all ledger updates involving a given bech32 address, sorted by milestone index.
Request
Path Parameters
bech32 address that is referenced by the outputs.
Query Parameters
Requested page size. Overridden by the cursor if provided.
Describes the sort order, either by oldest or newest. This value is NOT overridden by the cursor, and thus can be used to back-page.
The milestone index at which to start retrieving results. This will be overridden by the cursor if provided.
The cursor which can be used to retrieve the next logical page of results.
Responses
- 200
- 400
- 404
- 500
Successful operation.
- application/json
- Schema
- Example (from schema)
- default
Schema
- Array [
- ]
bech32 address that is referenced by the outputs.
items undefined[]required
A list of ledger updates.
The index of the milestone.
The timestamp at which the milestone was issued.
The output ID (transaction hash + output index) of the update. Hex-encoded with 0x prefix.
Indicates if the output is spent or not.
The cursor which can be used to retrieve the next logical page of results.
{
"address": "string",
"items": [
{
"milestoneIndex": 0,
"milestoneTimestamp": 0,
"outputId": "string",
"isSpent": true
}
],
"cursor": "string"
}
{
"address": "iota1qpf0mlq8yxpx2nck8a0slxnzr4ef2ek8f5gqxlzd0wasgp73utryj430ldu",
"items": [
{
"milestoneIndex": 500000,
"milestoneTimestamp": 1660065130,
"outputId": "fa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20100",
"isSpent": false
},
{
"milestoneIndex": 500000,
"milestoneTimestamp": 1660065129,
"outputId": "fa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20000",
"isSpent": true
}
],
"cursor": "1643383242.fa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20100.true.100"
}
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"
}
}