page.corvus.getBlock

corvus.page

Documentation

Return materialized snapshots for the requested `blockIds` plus the cursor at snapshot time. No transitive walk — only the explicit set is returned.

main query

Return materialized snapshots for the requested `blockIds` plus the cursor at snapshot time. No transitive walk — only the explicit set is returned.

Parameters

blockIds array of string Required

The block ids to materialize. Missing blocks are silently omitted from the output.

includeDids array of string Optional

Optional allowlist of editor DIDs whose ops the materialization should consider. When omitted, all editors are included.

Output

Encodingapplication/json
blocks array Required

Materialized snapshots for the requested `blockIds`. Order is not guaranteed to match the input order; blocks the server doesn't have are omitted (no entry, no error). Tree relationships are encoded on the blocks (sequence/register values reference other block-ids); the caller follows those refs with subsequent `getBlock` calls.

cursor integer Required

The server-assigned sequence number to resume from.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The block ids to materialize. Missing blocks are silently omitted from the output.
Optional allowlist of editor DIDs whose ops the materialization should consider. When omitted, all editors are included.
View raw schema 
{
  "type": "query",
  "errors": [],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "cursor",
        "blocks"
      ],
      "properties": {
        "blocks": {
          "type": "array",
          "items": {
            "refs": [
              "page.corvus.document",
              "page.corvus.database"
            ],
            "type": "union",
            "closed": false
          },
          "description": "Materialized snapshots for the requested `blockIds`. Order is not guaranteed to match the input order; blocks the server doesn't have are omitted (no entry, no error). Tree relationships are encoded on the blocks (sequence/register values reference other block-ids); the caller follows those refs with subsequent `getBlock` calls."
        },
        "cursor": {
          "type": "integer",
          "description": "The server-assigned sequence number to resume from."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "blockIds"
    ],
    "properties": {
      "blockIds": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "description": "The block ids to materialize. Missing blocks are silently omitted from the output."
      },
      "includeDids": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did"
        },
        "description": "Optional allowlist of editor DIDs whose ops the materialization should consider. When omitted, all editors are included."
      }
    }
  },
  "description": "Return materialized snapshots for the requested `blockIds` plus the cursor at snapshot time. No transitive walk — only the explicit set is returned."
}

Lexicon Garden

@