getblockheader

getblockheader "blockhash" ( verbose ) If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'. If verbose is true, returns an Object with information about blockheader <hash>. Arguments: 1. blockhash (string, required) The block hash 2. verbose (boolean, optional, default=true) true for a json object, false for the hex-encoded data Result (for verbose = true): { (json object) "hash" : "hex", (string) the block hash (same as provided) "shortHash" : "hex", (string) the shortHash (used for PoW check) "confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain "height" : n, (numeric) The block height or index "version" : n, (numeric) The block version "versionHex" : "hex", (string) The block version formatted in hexadecimal "merkleroot" : "hex", (string) The merkle root "time" : xxx, (numeric) The block time expressed in UNIX epoch time "mediantime" : xxx, (numeric) The median block time expressed in UNIX epoch time "nonce" : n, (numeric) The nonce "bits" : "hex", (string) nBits: compact representation of the block difficulty target "adjBits" : "hex", (string) nBits: compact representation of the block difficulty target with model modifier "target" : "hex", (string) The difficulty target "difficulty" : n, (numeric) The difficulty "chainwork" : "hex", (string) Expected number of hashes required to produce the current chain "hashPoW" : "hex", (string) The PoW blob hash "nTx" : n, (numeric) The number of transactions in the block "previousblockhash" : "hex", (string, optional) The hash of the previous block (if available) "nextblockhash" : "hex" (string, optional) The hash of the next block (if available) } Result (for verbose=false): "hex" (string) A string that is serialized, hex-encoded data for block 'hash' Examples: > bitcoin-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09" > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getblockheader", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

getblockheader(blockhash: string, verbose?: boolean) → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"getblockheader","params":["\"<blockhash>\"",true]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getblockheader", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"]}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getblockheader",
        "params": ["\"<blockhash>\"", true],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getblockheader",
    params: ["\"<blockhash>\"",true],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
blockhash	`string`	yes	The block hash
verbose	`boolean`	—	true for a json object, false for the hex-encoded data

Result

Type: any

{ (json object) "hash" : "hex", (string) the block hash (same as provided) "shortHash" : "hex", (string) the shortHash (used for PoW check) "confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain "height" : n, (numeric) The block height or index "version" : n, (numeric) The block version "versionHex" : "hex", (string) The block version formatted in hexadecimal "merkleroot" : "hex", (string) The merkle root "time" : xxx, (numeric) The block time expressed in UNIX epoch time "mediantime" : xxx, (numeric) The median block time expressed in UNIX epoch time "nonce" : n, (numeric) The nonce "bits" : "hex", (string) nBits: compact representation of the block difficulty target "adjBits" : "hex", (string) nBits: compact representation of the block difficulty target with model modifier "target" : "hex", (string) The difficulty target "difficulty" : n, (numeric) The difficulty "chainwork" : "hex", (string) Expected number of hashes required to produce the current chain "hashPoW" : "hex", (string) The PoW blob hash "nTx" : n, (numeric) The number of transactions in the block "previousblockhash" : "hex", (string, optional) The hash of the previous block (if available) "nextblockhash" : "hex" (string, optional) The hash of the next block (if available) } "hex" (string) A string that is serialized, hex-encoded data for block 'hash'

Source: services/core-node/bcore/src/rpc/blockchain.cpp:557

C++ symbol: getblockheader

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"getblockheader","params":["\"<blockhash>\"",true]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getblockheader", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"]}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getblockheader",
        "params": ["\"<blockhash>\"", true],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getblockheader",
    params: ["\"<blockhash>\"",true],
  }),
});
console.log(await res.json());