getBlockTransactionCount ​

Returns the number of Transactions at a block number, hash or tag.

Usage ​

import { publicClient } from './client'

const count = await publicClient.getBlockTransactionCount() 
// 23

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

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

Returns ​

number

The block transaction count.

Parameters ​

blockHash (optional) ​

• Type: Hash

Count at a given block hash.

const count = await publicClient.getBlockTransactionCount({
  blockHash: '0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d' 
})

blockNumber (optional) ​

• Type: bigint

Count at a given block number.

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

blockTag (optional) ​

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

Count at a given block tag.

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

JSON-RPC Method ​

• Calls eth_getBlockTransactionCountByNumber for blockNumber & blockTag.
• Calls eth_getBlockTransactionCountByHash for blockHash.