Returns all ledger updates for a given milestone index.

GET 
http://127.0.0.1:8000/api/explorer/v2/ledger/updates/by-milestone/:milestoneId

Returns all ledger updates that occurred in the milestone with the provided index.

Request

Path Parameters

milestoneId stringrequired
Milestone id for which to receive ledger updates.
Example: 0x7a09324557e9200f39bf493fc8fd6ac43e9ca750c6f6d884cc72386ddcb7d695

Query Parameters

pageSize number
Requested page size. Overridden by the cursor if provided.
Example: 100
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

milestoneIndex integerrequired

The index of the milestone.

items undefined[]required
A list of ledger updates.
Array [
address stringrequired
bech32 address that is referenced by the outputs.
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)

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

default

{
  "milestoneIndex": 500000,
  "items": [
    {
      "address": "iota1qpf0mlq8yxpx2nck8a0slxnzr4ef2ek8f5gqxlzd0wasgp73utryj430ldu",
      "outputId": "fa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20100",
      "isSpent": false
    },
    {
      "address": "iota1qpf0mlq8yxpx2nck8a0slxnzr4ef2ek8f5gqxlzd0wasgp73utryj430ldb",
      "outputId": "fa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20000",
      "isSpent": true
    }
  ],
  "cursor": "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"
  }
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'http://127.0.0.1:8000/api/explorer/v2/ledger/updates/by-milestone/:milestoneId' \
-H 'Accept: application/json'

Request Collapse all

Base URL

http://127.0.0.1:8000

Parameters

milestoneId — pathrequired

pageSize — query

cursor — query

ResponseClear

Click the Send API Request button above and see the response here!