Returns blocks in a given milestone by index.

GET 
http://127.0.0.1:8000/api/explorer/v2/milestones/by-index/:milestoneIndex/blocks

Returns block IDs in a given milestone by index sorted by white flag index.

Request

Path Parameters

milestoneIndex integerrequired
The milestone index to be used.
Example: 200000

Query Parameters

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

blocks object[]required
A list of block ids and corresponding payload types.
Array [
blockId stringrequired
The block ID.
payloadType integer
The corresponding payload type of the block if it exists.
]
cursor string

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

Example (from schema)

{
  "blocks": [
    {
      "blockId": "string",
      "payloadType": 0
    }
  ],
  "cursor": "string"
}

default

{
  "blocks": [
    {
      "blockId": "0xd0d361341fa3bb2f6855039a82ee9ea470c3336eaf34d22767fdfa901ba63e31",
      "payloadType": 0
    },
    {
      "blockId": "0x7a09324557e9200f39bf493fc8fd6ac43e9ca750c6f6d884cc72386ddcb7d695",
      "payloadType": 0
    },
    {
      "blockId": "0xfa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a2",
      "payloadType": 0
    }
  ],
  "cursor": "4.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/milestones/by-index/:milestoneIndex/blocks' \
-H 'Accept: application/json'

Request Collapse all

Base URL

http://127.0.0.1:8000

Parameters

milestoneIndex — pathrequired

sort — query

pageSize — query

cursor — query

ResponseClear

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