Skip to main content

[Block] klay_getHeaderByNumber

Returns information about a header by number. This API works only on RPC call, not on JavaScript console.

NOTE: This API is supported from Klaytn v1.7.0.

JSONRPC: klay_getHeaderByNumber

Request

Body

    method stringrequired

    Default value: klay_getHeaderByNumber

    Method name

    id int64required

    Default value: 1

    Request ID, Random or Auto incrementation

    jsonrpc stringrequired

    Default value: 2.0

    JSON-RPC Version (2.0)

    params

    undefined[]

    required

  • Array [

  • BlockNumberOrTag

    object

    oneOf

    number

  • ]

Responses

Returns information about a header by number

Schema

    jsonrpc stringrequired

    Default value: 2.0

    id int64required

    error

    object

    code int64required

    A Number that indicates the error type that occurred. This MUST be an integer.

    | code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

    message string

    A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

    data string

    A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

    result

    object

    The block header object.

    number hexnullable

    The block number. null when its pending block.

    hash 32-byte DATAnullablerequired

    Hash of the block. null when it is pending block.

    parentHash 32-byte DATArequired

    Hash of the parent block.

    logsBloom 256-byte DATAnullable

    The bloom filter for the logs of the block. null when it is pending block.

    transactionsRoot 32-byte DATArequired

    The root of the transaction trie of the block

    stateRoot 32-byte DATArequired

    The root of the final state trie of the block.

    receiptsRoot 32-byte DATArequired

    The root of the receipts trie of the block.

    reward 20-byte DATArequired

    The address of the beneficiary to whom the block rewards were given.

    blockScore hexrequired

    Former difficulty. Always 1 in the BFT consensus engine

    extraData DATArequired

    The "extra data" field of this block.

    gasUsed hexrequired

    The total used gas by all transactions in this block.

    timestamp hexrequired

    The Unix timestamp for when the block was collated.

    timestampFoS hexrequired

    The fraction of a second of the timestamp for when the block was collated.

    governanceData DATArequired

    RLP encoded governance configuration

    voteData DATArequired

    RLP encoded governance vote of the proposer

    baseFeePerGas hexrequired

    The base fee per gas. It has a meaningful value when EthTxTypeCompatible and Magma hardforks are activated.

Loading...
Make this page better