Skip to main content
GET
/
v1
/
blocks
Error
A valid request URL is required to generate request examples
{
  "blocks": [
    {
      "header": {
        "slot": "<string>",
        "blockHash": {
          "value": "aSDinaTvuI8gbWludGxpZnk="
        },
        "headerSignature": {
          "value": "aSDinaTvuI8gbWludGxpZnk="
        },
        "version": 123,
        "producer": {
          "value": "aSDinaTvuI8gbWludGxpZnk="
        },
        "expiryTimestamp": "2023-11-07T05:31:56Z",
        "startSlot": "<string>",
        "expiryAfter": 123,
        "maxBlockSize": 123,
        "maxComputeUnits": "<string>",
        "maxStateUnits": 123,
        "price": "<string>",
        "blockTime": "2023-11-07T05:31:56Z"
      },
      "footer": {
        "signature": {
          "value": "aSDinaTvuI8gbWludGxpZnk="
        },
        "status": "EXECUTION_STATUS_UNSPECIFIED",
        "consumedComputeUnits": "<string>",
        "consumedStateUnits": 123
      },
      "body": "aSDinaTvuI8gbWludGxpZnk=",
      "consensusStatus": "CONSENSUS_STATUS_UNSPECIFIED"
    }
  ],
  "page": {
    "nextPageToken": "<string>",
    "totalSize": "<string>"
  }
}

Query Parameters

​
filter.expression
string

CEL expression applied server-side. Empty expressions are treated as no-op.

​
page.pageSize
integer<int64>

Maximum number of items to return in a single response.

​
page.pageToken
string

Token identifying the position to resume from.

​
page.orderBy
string

Optional ordering specification in "field [asc|desc]" form.

​
view
enum<string>
default:BLOCK_VIEW_UNSPECIFIED
Available options:
BLOCK_VIEW_UNSPECIFIED,
BLOCK_VIEW_HEADER_ONLY,
BLOCK_VIEW_HEADER_AND_FOOTER,
BLOCK_VIEW_BODY_ONLY,
BLOCK_VIEW_FULL
​
minConsensus
enum<string>
default:CONSENSUS_STATUS_UNSPECIFIED
  • CONSENSUS_STATUS_UNSPECIFIED: CONSENSUS_STATUS_UNSPECIFIED indicates the consensus status is unknown.
  • CONSENSUS_STATUS_OBSERVED: CONSENSUS_STATUS_OBSERVED indicates the resource has been observed but not yet confirmed in a finalized block.
  • CONSENSUS_STATUS_INCLUDED: CONSENSUS_STATUS_INCLUDED indicates the resource has been included in the ledger but may not be finalized.
  • CONSENSUS_STATUS_FINALIZED: CONSENSUS_STATUS_FINALIZED indicates the resource is finalized for a slot.
  • CONSENSUS_STATUS_LOCALLY_EXECUTED: CONSENSUS_STATUS_LOCALLY_EXECUTED indicates the local node executed the resource but broader cluster finality may not have been achieved.
  • CONSENSUS_STATUS_CLUSTER_EXECUTED: CONSENSUS_STATUS_CLUSTER_EXECUTED indicates the entire cluster has executed and agreed on the resource.
Available options:
CONSENSUS_STATUS_UNSPECIFIED,
CONSENSUS_STATUS_OBSERVED,
CONSENSUS_STATUS_INCLUDED,
CONSENSUS_STATUS_FINALIZED,
CONSENSUS_STATUS_LOCALLY_EXECUTED,
CONSENSUS_STATUS_CLUSTER_EXECUTED

Response

A successful response.

ListBlocksResponse returns a page of blocks.

​
blocks
object[]
​
page
object

PageResponse captures pagination metadata returned with list results.