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

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

Query Parameters

pageSize number
Requested page size. Overridden by the cursor if provided.
Example: 100
sort string
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.
Example: newest
startMilestoneIndex number
The milestone index at which to start retrieving results. This will be overridden by the cursor if provided.
Example: 500000
cursor string
The cursor which can be used to retrieve the next logical page of results.
Example: 1643383242.fa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20100.100

Responses

200

Successful operation.

application/json

Schema

Schema

address stringrequired

bech32 address that is referenced by the outputs.

items undefined[]required
A list of ledger updates.
Array [
milestoneIndex integerrequired
The index of the milestone.
milestoneTimestamp integerrequired
The timestamp at which the milestone was issued.
outputId stringrequired
The output ID (transaction hash + output index) of the update. Hex-encoded with 0x prefix.
isSpent booleanrequired
Indicates if the output is spent or not.
]
cursor string

The cursor which can be used to retrieve the next logical page of results.

Example (from schema)

{
  "address": "string",
  "items": [
    {
      "milestoneIndex": 0,
      "milestoneTimestamp": 0,
      "outputId": "string",
      "isSpent": true
    }
  ],
  "cursor": "string"
}

default

{
  "address": "iota1qpf0mlq8yxpx2nck8a0slxnzr4ef2ek8f5gqxlzd0wasgp73utryj430ldu",
  "items": [
    {
      "milestoneIndex": 500000,
      "milestoneTimestamp": 1660065130,
      "outputId": "fa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20100",
      "isSpent": false
    },
    {
      "milestoneIndex": 500000,
      "milestoneTimestamp": 1660065129,
      "outputId": "fa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20000",
      "isSpent": true
    }
  ],
  "cursor": "1643383242.fa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20100.true.100"
}

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...