Celestia Node Header API

JSON-RPC methods in the header module of celestia-node. Query ExtendedHeaders with header.LocalHead, header.NetworkHead, header.GetByHeight, header.GetByHash, and header.GetRangeByHeight; track sync state with header.SyncState and header.SyncWait; and subscribe to new headers with header.Subscribe.

OpenAPI Specification

celestia-header-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Celestia Node Blob Header API
  version: 0.30.x
  description: 'JSON-RPC methods in the `blob` module of celestia-node. Used to submit, retrieve,

    and prove blobs of arbitrary data published to the Celestia data availability layer

    against one or more namespaces. Blobs are the canonical payload unit for rollups

    and other applications using Celestia for DA.

    '
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: Celestia Labs
    url: https://celestia.org
servers:
- url: http://localhost:26658
  description: Default celestia-node JSON-RPC endpoint (light/bridge/full)
tags:
- name: Header
  description: Query and subscribe to Celestia extended block headers.
paths:
  /:
    post:
      tags:
      - Header
      summary: Invoke Header JSON-RPC Method
      description: 'Single JSON-RPC entrypoint exposing the `header.*` namespace including

        `header.LocalHead`, `header.NetworkHead`, `header.GetByHeight`,

        `header.GetByHash`, `header.GetRangeByHeight`, `header.SyncState`,

        `header.SyncWait`, `header.WaitForHeight`, and `header.Subscribe`.

        '
      security:
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonRpcRequest'
            examples:
              localHead:
                summary: Get local head
                value:
                  jsonrpc: '2.0'
                  id: 1
                  method: header.LocalHead
                  params: []
              getByHeight:
                summary: Get header by height
                value:
                  jsonrpc: '2.0'
                  id: 1
                  method: header.GetByHeight
                  params:
                  - 1234567
      responses:
        '200':
          description: JSON-RPC response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonRpcResponse'
components:
  schemas:
    JsonRpcResponse:
      type: object
      properties:
        jsonrpc:
          type: string
        id: {}
        result: {}
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
    JsonRpcRequest:
      type: object
      required:
      - jsonrpc
      - method
      - id
      properties:
        jsonrpc:
          type: string
          enum:
          - '2.0'
        id:
          oneOf:
          - type: integer
          - type: string
        method:
          type: string
          enum:
          - header.LocalHead
          - header.NetworkHead
          - header.GetByHeight
          - header.GetByHash
          - header.GetRangeByHeight
          - header.SyncState
          - header.SyncWait
          - header.WaitForHeight
          - header.Subscribe
        params:
          type: array
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer