getBlock

Returns information about a block at a block number, hash or tag.

Usage

example.tsclient.ts

import { publicClient } from './client'

const block = await publicClient.getBlock() 
/**
 * {
 *  baseFeePerGas: 10789405161n,
 *  difficulty: 11569232145203128n,
 *  extraData: '0x75732d656173742d38',
 *  ...
 * }
 */

import { publicClient } from './client'

const block = await publicClient.getBlock() 
/**
 * {
 *  baseFeePerGas: 10789405161n,
 *  difficulty: 11569232145203128n,
 *  extraData: '0x75732d656173742d38',
 *  ...
 * }
 */

import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

export const publicClient = createPublicClient({
  chain: mainnet,
  transport: http()
})

import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

export const publicClient = createPublicClient({
  chain: mainnet,
  transport: http()
})

Returns

Block

Information about the block.

Parameters

blockHash (optional)

Type: Hash

Information at a given block hash.

const block = await publicClient.getBlock({
  blockHash: '0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d' 
})

const block = await publicClient.getBlock({
  blockHash: '0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d' 
})

blockNumber (optional)

Type: bigint

Information at a given block number.

const block = await publicClient.getBlock({
  blockNumber: 42069n 
})

const block = await publicClient.getBlock({
  blockNumber: 42069n 
})

blockTag (optional)

Type: 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'
Default: 'latest'

Information at a given block tag.

const block = await publicClient.getBlock({
  blockTag: 'safe' 
})

const block = await publicClient.getBlock({
  blockTag: 'safe' 
})

includeTransactions (optional)

Type: boolean

Whether or not to include transactions (as a structured array of Transaction objects).

const block = await publicClient.getBlock({
  includeTransactions: true 
})

const block = await publicClient.getBlock({
  includeTransactions: true 
})

Example

Check out the usage of getBlock in the live Fetching Blocks Example below.

JSON-RPC Method

Calls eth_getBlockByNumber for blockNumber & blockTag.
Calls eth_getBlockByHash for blockHash.

getBlock ​

Usage ​

Returns ​

Parameters ​

blockHash (optional) ​

blockNumber (optional) ​

blockTag (optional) ​

includeTransactions (optional) ​

Example ​

JSON-RPC Method ​