Skip to main content

Wallet API documentation

Directly integrate your dapp with the MetaMask extension.

Ethereum API
Multichain API

eth_getTransactionByBlockNumberAndIndex

Summary: Returns information about a transaction by block number and transaction index position.

Parameters

Block
oneOf

Block number or tag

Block number
string

Block number

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

Block tag
enum

earliest: The lowest numbered block the client has available; finalized: The most recent crypto-economically secure block, cannot be re-orged outside of manual intervention driven by community coordination; safe: The most recent block that is safe from re-orgs under honest majority and certain synchronicity assumptions; latest: The most recent block in the canonical chain observed by the client, this block may be re-orged out of the canonical chain even under healthy/normal conditions; pending: A sample next block built by the client on top of latest and containing the set of transactions usually taken from local mempool. Before the merge transition is finalized, any call querying for finalized or safe block MUST be responded to with -39001: Unknown block error

Enum:
"earliest"
"finalized"
"safe"
"latest"
"pending"
Transaction index
string

hex encoded unsigned integer

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

Returns

Transaction information
oneOf

Not Found (null)
null

Not Found (null)

Transaction information
allOf

Transaction information

Contextual information
required

Contextual information

oneOf

Signed 4844 Transaction
allOf

Signed 4844 Transaction

EIP-4844 transaction.
object
required

EIP-4844 transaction.

type
string
required

type

Pattern: ^0x([0-9a-fA-F]?){1,2}$

nonce
string
required

nonce

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

to
string
required

hex encoded address

Pattern: ^0x[0-9a-fA-F]{40}$

gas
string
required

gas limit

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

value
string
required

value

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

input
string
required

input data

Pattern: ^0x[0-9a-f]*$

maxPriorityFeePerGas
string
required

Maximum fee per gas the sender is willing to pay to miners in wei

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

maxFeePerGas
string
required

The maximum total fee per gas the sender is willing to pay (includes the network / base fee and miner / priority fee) in wei

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

maxFeePerBlobGas
string
required

The maximum total fee per gas the sender is willing to pay for blob gas in wei

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

accessList
array
required

EIP-2930 access list

Access list entry
object

Access list entry

address
string

hex encoded address

Pattern: ^0x[0-9a-fA-F]{40}$

storageKeys
array

32 byte hex value
string

32 byte hex value

Pattern: ^0x[0-9a-f]{64}$

blobVersionedHashes
array
required

List of versioned blob hashes associated with the transaction's EIP-4844 data blobs.

32 byte hex value
string

32 byte hex value

Pattern: ^0x[0-9a-f]{64}$

chainId
string
required

Chain ID that this transaction is valid on.

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

EIP-4844 transaction signature properties.
required

EIP-4844 transaction signature properties.

Signed 1559 Transaction
allOf

Signed 1559 Transaction

EIP-1559 transaction.
object
required

EIP-1559 transaction.

type
string
required

type

Pattern: ^0x2$

nonce
string
required

nonce

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

to
oneOf

to address

Contract Creation (null)
null

Contract Creation (null)

hex encoded address
string

hex encoded address

Pattern: ^0x[0-9a-fA-F]{40}$

gas
string
required

gas limit

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

value
string
required

value

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

input
string
required

input data

Pattern: ^0x[0-9a-f]*$

maxPriorityFeePerGas
string
required

Maximum fee per gas the sender is willing to pay to miners in wei

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

maxFeePerGas
string
required

The maximum total fee per gas the sender is willing to pay (includes the network / base fee and miner / priority fee) in wei

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

gasPrice
string
required

The effective gas price paid by the sender in wei. For transactions not yet included in a block, this value should be set equal to the max fee per gas. This field is DEPRECATED, please transition to using effectiveGasPrice in the receipt object going forward.

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

accessList
array
required

EIP-2930 access list

Access list entry
object

Access list entry

address
string

hex encoded address

Pattern: ^0x[0-9a-fA-F]{40}$

storageKeys
array

32 byte hex value
string

32 byte hex value

Pattern: ^0x[0-9a-f]{64}$

chainId
string
required

Chain ID that this transaction is valid on.

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

EIP-1559 transaction signature properties.
required

EIP-1559 transaction signature properties.

Signed 2930 Transaction
allOf

Signed 2930 Transaction

EIP-2930 transaction.
object
required

EIP-2930 transaction.

type
string
required

type

Pattern: ^0x1$

nonce
string
required

nonce

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

to
oneOf

to address

Contract Creation (null)
null

Contract Creation (null)

hex encoded address
string

hex encoded address

Pattern: ^0x[0-9a-fA-F]{40}$

gas
string
required

gas limit

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

value
string
required

value

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

input
string
required

input data

Pattern: ^0x[0-9a-f]*$

gasPrice
string
required

The gas price willing to be paid by the sender in wei

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

accessList
array
required

EIP-2930 access list

Access list entry
object

Access list entry

address
string

hex encoded address

Pattern: ^0x[0-9a-fA-F]{40}$

storageKeys
array

32 byte hex value
string

32 byte hex value

Pattern: ^0x[0-9a-f]{64}$

chainId
string
required

Chain ID that this transaction is valid on.

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

EIP-2930 transaction signature properties.
required

EIP-2930 transaction signature properties.

Signed Legacy Transaction
allOf

Signed Legacy Transaction

Legacy transaction.
object
required

Legacy transaction.

type
string
required

type

Pattern: ^0x0$

nonce
string
required

nonce

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

to
oneOf

to address

Contract Creation (null)
null

Contract Creation (null)

hex encoded address
string

hex encoded address

Pattern: ^0x[0-9a-fA-F]{40}$

gas
string
required

gas limit

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

value
string
required

value

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

input
string
required

input data

Pattern: ^0x[0-9a-f]*$

gasPrice
string
required

The gas price willing to be paid by the sender in wei

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

chainId
string

Chain ID that this transaction is valid on.

Pattern: ^0x([1-9a-f]+[0-9a-f]*|0)$

Legacy transaction signature properties.
required

Legacy transaction signature properties.

Customize request
Parameter
Value
0x1442e
oneOf
  • Block number
  • Block tag
string

Connect your MetaMask wallet to run requests successfully.

Request

await window.ethereum.request({
 "method": "eth_getTransactionByBlockNumberAndIndex",
 "params": [
  "0x1442e",
  "0x2"
],
});

Example response

{
  "blockHash": "0x510efccf44a192e6e34bcb439a1947e24b86244280762cbb006858c237093fda",
  "blockNumber": "0x422",
  "chainId": 2018,
  "from": "0xfe3b557e8fb62b89f4916b721be55ceb828dbd73",
  "gas": "0x5208",
  "gasPrice": "0x3b9aca00",
  "hash": "0xa52be92809541220ee0aaaede6047d9a6c5d0cd96a517c854d944ee70a0ebb44",
  "input": "0x",
  "nonce": "0x1",
  "to": "0x627306090abab3a6e1400e9345bc60c78a8bef57",
  "transactionIndex": "0x0",
  "value": "0x4e1003b28d9280000",
  "v": "0xfe7",
  "r": "0x84caf09aefbd5e539295acc67217563438a4efb224879b6855f56857fa2037d3",
  "s": "0x5e863be3829812c81439f0ae9d8ecb832b531d651fb234c848d1bf45e62be8b9"
}