Ethereum — web3, net, eth, Gossip, State, History

API reference for Ethereum. All methods ->

`web3_clientVersion`

Returns the current client version.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required): None.

Returns

<string>: the current client version.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "web3_clientVersion",
      "params": [],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "Geth/v1.10.26-stable-e5eb32ac/linux-amd64/go1.18.5"
}

`web3_sha3`

Returns Keccak-256 (not the standardized SHA3-256) of the given data.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
- <string> (data): the data to convert into a SHA3 hash.

Returns

<string> (data): the SHA3 result of the given string.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "web3_sha3",
      "params": ["0x68656c6c6f20776f726c64"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad"
}

`net_version`

Returns the current network ID.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required): None.

Returns

<string>: the current network ID.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "net_version",
      "params": [],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "1"
}

`net_listening`

Returns true if client is actively listening for network connections.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required): None.

Returns

<boolean>: true when listening, otherwise false.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "net_listening",
      "params": [],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": true
}

`eth_syncing`

Returns an object with data about the sync status or false.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required): None.

Returns

<object>|<boolean>: an object with sync status data or FALSE, when not syncing:
- startingBlock (quantity): the block at which the import started (will only be reset, after the sync reached its head).
- currentBlock (quantity): the current block, same as eth_blockNumber.
- highestBlock (quantity): the estimated highest block.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_syncing",
      "params": [],
      "id": 1
    }'

Response example (syncing)

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "startingBlock": "0x384",
        "currentBlock": "0x386",
        "highestBlock": "0x454"
    }
}

Response example (not syncing)

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": false
}

`eth_gasPrice`

Returns the current price per gas in wei.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required): None.

Returns

<string> (quantity): the current gas price in wei.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_gasPrice",
      "params": [],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x2b2a3ec91"
}

`eth_accounts`

Returns a list of addresses owned by client.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required): None.

Returns

<array> (string; data, 20 bytes): addresses owned by the client.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_accounts",
      "params": [],
      "id": 1
    }'

Response example

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": [
        "0x407d73d8a49eeb85d32cf465507dd71d507100c1"
    ]
}

`eth_blockNumber`

Returns the number of most recent block.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required): None.

Returns

<string> (quantity): the current block number the client is on.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_blockNumber",
      "params": [],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0xf5f277"
}

`eth_getBalance`

Returns the balance of the account specified by address.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (data, 20 bytes): an address to check for balance.
2. <string> (quantity|tag): either the hex value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

<string> (quantity): the current balance in wei.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getBalance",
      "params": ["0x8D97689C9818892B700e27F316cc3E41e17fBeb9", "latest"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x2c85c3ecfcb5fb"
}

`eth_getStorageAt`

Returns the value from a storage position at an address specified.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (data, 20 bytes): an address of the storage (hex encoded).
2. <string> (quantity): a slot position in the storage (hex encoded unsigned integer).
3. <string> (quantity|tag): either the hex value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

<string> (data): the value at this storage position.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getStorageAt",
      "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x0", "latest"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x0000000000000000000000000000000000000000000000000000000000000000"
}

`eth_getTransactionCount`

Returns the number of transactions sent from an address.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (data, 20 bytes): an address.
2. <string> (quantity|tag): either the hex value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

<string> (quantity): the number of transactions send from this address.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getTransactionCount",
      "params": ["0x8D97689C9818892B700e27F316cc3E41e17fBeb9", "latest"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x9"
}

`eth_getBlockTransactionCountByHash`

Returns the number of transactions in a block specified by block hash.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (data, 32 bytes): a block hash.

Returns

<string> (quantity): the number of transactions in this block.

Request example:

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getBlockTransactionCountByHash",
      "params": ["0x829df9bb801fc0494abf2f443423a49ffa32964554db71b098d332d87b70a48b"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x7b"
}

`eth_getBlockTransactionCountByNumber`

Returns the number of transactions in the block specified by number.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (quantity|tag): either the hex value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

<string> (quantity): the number of transactions in this block.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getBlockTransactionCountByNumber",
      "params": ["latest"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0xb6"
}

`eth_getUncleCountByBlockHash`

Returns the number of uncles in a block specified by block hash.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (data, 32 bytes): a block's hash.

Returns

<string> (quantity): the number of uncles in this block.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getUncleCountByBlockHash",
      "params": ["0x829df9bb801fc0494abf2f443423a49ffa32964554db71b098d332d87b70a48b"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x0"
}

`eth_getUncleCountByBlockNumber`

Returns the number of uncles in a block specified by block number.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (quantity|tag): either the hex value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

<string> (quantity): the number of uncles in this block.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getUncleCountByBlockNumber",
      "params": ["0xc5043f"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x1"
}

`eth_getCode`

Returns code at a given address.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (data, 20 bytes): an address to get the code from.
2. <string> (quantity|tag): either the hex value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

<string> (data): the code from the given address.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getCode",
      "params": ["0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b", "0x2"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x"
}

`eth_sign`

Returns an EIP-191 signature over the provided data.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (data, 20 bytes): an address.
2. <string> (data, N bytes): a message to sign.

Returns

<string> (data): an EIP-191 signature.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_sign",
      "params": ["0x9b2055d370f73ec7d8a03e965129118dc8f5bf83", "0xdeadbeaf"],
      "id": 1
    }'

Response example

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": "0xa3f20717a250c2b0b729b7e5becbff67fdaef7e0699da4de7ca5895b02a170a12d887fd3b17bfdce3481f10bea41f45ba9f709d39ce8325427b57afcfc994cee1b"
}

`eth_signTransaction`

Signs a transaction that can be submitted to the network at a later time using with eth_sendRawTransaction.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <object> (hex encoded): the transaction object:
  - from (string; data, 20 bytes; required): the address the transaction is sent from.
  - to (string; data, 20 bytes; optional for contract creation): the address the transaction is directed to.
  - gas (string; quantity; optional; default: 90000): the gas provided for the transaction execution.
  - gasPrice (string; quantity; optional): the gas price willing to be paid by the sender in wei.
  - value (string; quantity; optional): the value sent with this transaction, in wei.
  - data (string; data): the compiled code of a contract OR the hash of the invoked method signature and encoded parameters.
  - nonce (string; quantity; optional): a nonce; allows to overwrite your own pending transactions that use the same nonce.

Returns

<string> (data): a signed transaction.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
    "jsonrpc": "2.0",
    "method": "eth_signTransaction",
    "params": [
        {
            "data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
            "from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155",
            "gas": "0x76c0",
            "gasPrice": "0x9184e72a000",
            "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567",
            "value": "0x9184e72a",
            "nonce": "0x689056015818adbe"
        }
    ],
    "id": 1
}'

Response example

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": "0xa3f20717a250c2b0b729b7e5becbff67fdaef7e0699da4de7ca5895b02a170a12d887fd3b17bfdce3481f10bea41f45ba9f709d39ce8325427b57afcfc994cee1b"
}

`eth_sendTransaction`

Signs and submits a transaction.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <object> (hex encoded): the transaction object:
  - from (string; data, 20 bytes; required): the address the transaction is sent from.
  - to (string; data, 20 bytes; optional for contract creation): the address the transaction is directed to.
  - gas (string; quantity; optional; default: 90000): the gas provided for the transaction execution.
  - gasPrice (string; quantity; optional): the gas price willing to be paid by the sender in wei.
  - value (string; quantity; optional): the value sent with this transaction, in wei.
  - data (string; data): the compiled code of a contract OR the hash of the invoked method signature and encoded parameters.
  - nonce (string; quantity; optional): a nonce; allows to overwrite your own pending transactions that use the same nonce.

Returns

<string> (data, 32 bytes): the transaction hash, or the zero hash if the transaction is not yet available.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
    "jsonrpc": "2.0",
    "method": "eth_sendTransaction",
    "params": [
        {
            "data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
            "from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155",
            "gas": "0x76c0",
            "gasPrice": "0x9184e72a000",
            "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567",
            "value": "0x9184e72a"
        }
    ],
    "id": 1
}'

Response example

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
}

`eth_sendRawTransaction`

Creates new message call transaction or a contract creation for signed transactions.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (data): the signed transaction data.

Returns

<string> (data, 32 bytes): the transaction hash, or the zero hash if the transaction is not yet available.

Use eth_getTransactionReceipt to get the contract address, after the transaction was mined, when you created a contract.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
    "jsonrpc": "2.0",
    "method": "eth_sendRawTransaction",
    "params": ["0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"],
    "id": 1
}'

Response example

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
}

`eth_call`

Executes a new message call immediately without creating a transaction on the blockchain.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <object> (hex encoded): the transaction object:
  - from (string; data, 20 bytes; optional): the address the transaction is sent from.
  - to (string; data, 20 bytes): the address the transaction is directed to.
  - gas (string; quantity; optional): the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
  - gasPrice (string; quantity; optional): the gas price willing to be paid by the sender in wei.
  - value (string; quantity; optional): the value sent with this transaction, in wei.
  - data (string; data; optional): the hash of the method signature and encoded parameters.
2. <string> (quantity|tag): either the hex value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

<string> (hex encoded bytes): the return value of executed contract.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
    "jsonrpc": "2.0",
    "method": "eth_call",
    "params": [{"from":null,"to":"0x6b175474e89094c44da98b954eedeac495271d0f","data":"0x70a082310000000000000000000000006E0d01A76C3Cf4288372a29124A26D4353EE51BE"}, "latest"],
    "id": 1
}'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x0000000000000000000000000000000000000000000000000858898f93629000"
}

`eth_estimateGas`

Generates and returns an estimate of how much gas is necessary to allow the transaction to complete.

The transaction will not be added to the blockchain. Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <object> (hex encoded): the transaction object:
  - from (string; data, 20 bytes; optional): the address the transaction is sent from.
  - to (string; data, 20 bytes; optional): the address the transaction is directed to.
  - gas (string; quantity; optional): the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
  - gasPrice (string; quantity; optional): the gas price willing to be paid by the sender in wei.
  - value (string; quantity; optional): the value sent with this transaction, in wei.
  - data (string; data; optional): the hash of the method signature and encoded parameters.
2. <string> (quantity|tag; optional): either a HEX value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

<string> (quantity): the amount of gas used.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
    "jsonrpc": "2.0",
    "method": "eth_estimateGas",
    "params": [{"from":null,"to":"0x6b175474e89094c44da98b954eedeac495271d0f","data":"0x70a082310000000000000000000000006E0d01A76C3Cf4288372a29124A26D4353EE51BE"}, "latest"],
    "id": 1
}'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": "0x5de2"
}

`eth_simulateV1`

Simulates multiple blocks and transactions without creating transactions or blocks on the blockchain.

The eth_simulateV1 method allows the simulation of multiple blocks and transactions without creating transactions or blocks on the blockchain. It functions similarly to eth_call, but offers more control.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <object> (hex encoded): the simulation payload:
  - blockStateCalls (array): an array of the block state call objects.
    - blockOverrides (object; optional): an object to override block-level parameters.
      - baseFeePerGas (string): the base fee per gas for the block, encoded as hexadecimal.
    - stateOverrides (object; optional): an object to override account states.
      - address (object): the address of the account to override.
        
        balance (string; optional): the balance to set for the account, encoded as hexadecimal.
    - calls (array): an array of transaction call objects:
      - from (string; optional): the address from which the transaction is sent.
      - to (string): the address to which the transaction is sent.
      - maxFeePerGas (string; optional): the maximum fee per gas the sender is going to pay.
      - value (string; optional): the value sent with the transaction, encoded as hexadecimal.
  - validation (boolean; optional): indicates whether to perform validation checks.
  - traceTransfers (boolean; optional): indicates whether to trace value transfers.
2. <string> (quantity|tag; optional): either a HEX value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

On a successful eth_simulateV1 call, an array of generated full blocks is returned (the same object that you would get with eth_getBlockByHash, except for an added calls field), otherwise an error is returned.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
    "jsonrpc": "2.0",
    "method": "eth_simulateV1",
    "params": "params": [
        {
            "blockStateCalls": [
                {
                    "blockOverrides": {
                        "baseFeePerGas": "0x9"
                    },
                    "stateOverrides": {
                        "0xc000000000000000000000000000000000000000": {
                            "balance": "0x4a817c800"
                        }
                    },
                    "calls": [
                        {
                            "from": "0xc000000000000000000000000000000000000000",
                            "to": "0xc000000000000000000000000000000000000001",
                            "maxFeePerGas": "0xf",
                            "value": "0x1"
                        },
                        {
                            "from": "0xc000000000000000000000000000000000000000",
                            "to": "0xc000000000000000000000000000000000000002",
                            "maxFeePerGas": "0xf",
                            "value": "0x1"
                        }
                    ]
                }
            ],
            "validation": true,
            "traceTransfers": true
        },
        "latest"
    ],
    "id": 1
}'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": [
        {
            "baseFeePerGas": "0x9",
            "blobGasUsed": "0x0",
            "calls": [
                {
                    "returnData": "0x",
                    "logs": [
                        {
                            "address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
                            "topics": [
                                "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                                "0x000000000000000000000000c000000000000000000000000000000000000000",
                                "0x000000000000000000000000c000000000000000000000000000000000000001"
                            ],
                            "data": "0x0000000000000000000000000000000000000000000000000000000000000001",
                            "blockNumber": "0x13d2747",
                            "transactionHash": "0xe7217784e0c3f7b35d39303b1165046e9b7e8af9b9cf80d5d5f96c3163de8f51",
                            "transactionIndex": "0x0",
                            "blockHash": "0x5e28f54a56dc9df973a058cd54b3eeef8c67a1a613cb5db1df8a0a434c931d56",
                            "logIndex": "0x0",
                            "removed": false
                        }
                    ],
                    "gasUsed": "0x5208",
                    "status": "0x1"
                },
                {
                    "returnData": "0x",
                    "logs": [
                        {
                            "address": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
                            "topics": [
                                "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                                "0x000000000000000000000000c000000000000000000000000000000000000000",
                                "0x000000000000000000000000c000000000000000000000000000000000000002"
                            ],
                            "data": "0x0000000000000000000000000000000000000000000000000000000000000001",
                            "blockNumber": "0x13d2747",
                            "transactionHash": "0xf0182201606ec03701ba3a07d965fabdb4b7d06b424f226ea7ec3581802fc6fa",
                            "transactionIndex": "0x1",
                            "blockHash": "0x5e28f54a56dc9df973a058cd54b3eeef8c67a1a613cb5db1df8a0a434c931d56",
                            "logIndex": "0x1",
                            "removed": false
                        }
                    ],
                    "gasUsed": "0x5208",
                    "status": "0x1"
                }
            ],
            "difficulty": "0x0",
            "excessBlobGas": "0x0",
            "extraData": "0x",
            "gasLimit": "0x1c9c380",
            "gasUsed": "0xa410",
            "hash": "0x5e28f54a56dc9df973a058cd54b3eeef8c67a1a613cb5db1df8a0a434c931d56",
            "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
            "miner": "0x4838b106fce9647bdf1e7877bf73ce8b0bad5f97",
            "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "nonce": "0x0000000000000000",
            "number": "0x13d2747",
            "parentBeaconBlockRoot": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "parentHash": "0xd24222b93a05a066cf79dc20e333f5aa6bb06d36eb50eb2b6b0b744b937e7975",
            "receiptsRoot": "0x75308898d571eafb5cd8cde8278bf5b3d13c5f6ec074926de3bb895b519264e1",
            "sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
            "size": "0x298",
            "stateRoot": "0xbb0740745211507e2a2a6cdb627dfa171ef5050ad2a01e5401c2e3df4be5b919",
            "timestamp": "0x66ec2853",
            "totalDifficulty": "0xc70d815d562d3cfa955",
            "transactions": [
                "0xe7217784e0c3f7b35d39303b1165046e9b7e8af9b9cf80d5d5f96c3163de8f51",
                "0xf0182201606ec03701ba3a07d965fabdb4b7d06b424f226ea7ec3581802fc6fa"
            ],
            "transactionsRoot": "0x9bdb74f3ce41f5893a02a631e904ae0d21ae8c4e416786d8dbd9cb5c54f1dc0f",
            "uncles": [],
            "withdrawals": [],
            "withdrawalsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"
        }
    ]
}

`eth_getBlockByHash`

Returns information for the block specified by block hash.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (data, 32 bytes): the block's hash.
2. <boolean>: if true it returns the full transaction objects, if false — only the hashes of the transactions.

Returns

<object>: a block object, or null when no block was found:
- number (string; quantity): the block number; null when it's a pending block.
- hash (string; data, 32 bytes): the hash of the block; null when it's a pending block.
- parentHash (string; data, 32 bytes): the hash of the parent block.
- nonce (string; data, 8 bytes): the hash of the generated proof-of-work; null when it's a pending block.
- sha3Uncles (string; data, 32 bytes): SHA3 of the uncles data in the block.
- logsBloom (string; data, 256 bytes): the bloom filter for the logs of the block. null when its pending block.
- transactionsRoot (string; data, 32 bytes): the root of the transaction trie of the block.
- stateRoot (string; data, 32 bytes): the root of the final state trie of the block.
- receiptsRoot (string; data, 32 bytes): the root of the receipts trie of the block.
- miner (string; data, 20 bytes): the address of the beneficiary to whom the mining rewards were given.
- difficulty (string; quantity): the difficulty for this block.
- totalDifficulty (string; quantity): the total difficulty of the chain until this block.
- extraData (string; data): the extra data field of this block.
- size (string; quantity): the size of this block in bytes.
- gasLimit (string; quantity): the maximum gas allowed in this block.
- gasUsed (string; quantity): the total used gas by all transactions in this block.
- timestamp (string; quantity): the unix timestamp for when the block was collated.
- transactions (array of strings): an array of transaction objects, or 32 bytes transaction hashes depending on the last given parameter.
- uncles (array of strings): an array of uncle hashes.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getBlockByHash",
      "params": ["0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae", false],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "difficulty": "0x4ea3f27bc",
        "extraData": "0x476574682f4c5649562f76312e302e302f6c696e75782f676f312e342e32",
        "gasLimit": "0x1388",
        "gasUsed": "0x0",
        "hash": "0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae",
        "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
        "miner": "0xbb7b8287f3f0a933474a79eae42cbca977791171",
        "mixHash": "0x4fffe9ae21f1c9e15207b1f472d5bbdd68c9595d461666602f2be20daf5e7843",
        "nonce": "0x689056015818adbe",
        "number": "0x1b4",
        "parentHash": "0xe99e022112df268087ea7eafaf4790497fd21dbeeb6bd7a1721df161a6657a54",
        "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
        "size": "0x220",
        "stateRoot": "0xddc8b0234c2e0cad087c8b389aa7ef01f7d79b2570bccb77ce48648aa61c904d",
        "timestamp": "0x55ba467c",
        "totalDifficulty": "0x78ed983323d",
        "transactions": [],
        "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "uncles": []
    }
}

`eth_getBlockByNumber`

Returns information for the block specified by block number.

Parameters

id (integer; required): a request ID (example: 1).
jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
method (string; required): a method used for the request.
params (array; required):
1. <string> (quantity|tag): either the hex value of a block number or one of the following block tags:
  - earliest: the lowest numbered block available on the client.
  - 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 can 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 the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.
2. <boolean>: if true it returns the full transaction objects, if false — only the hashes of the transactions.

Returns

<object>: a block object, or null when no block was found:
- number (string; quantity): the block number; null when it's a pending block.
- hash (string; data, 32 bytes): the hash of the block; null when it's a pending block.
- parentHash (string; data, 32 bytes): the hash of the parent block.
- nonce (string; data, 8 bytes): the hash of the generated proof-of-work; null when it's a pending block.
- sha3Uncles (string; data, 32 bytes): SHA3 of the uncles data in the block.
- logsBloom (string; data, 256 bytes): the bloom filter for the logs of the block. null when its pending block.
- transactionsRoot (string; data, 32 bytes): the root of the transaction trie of the block.
- stateRoot (string; data, 32 bytes): the root of the final state trie of the block.
- receiptsRoot (string; data, 32 bytes): the root of the receipts trie of the block.
- miner (string; data, 20 bytes): the address of the beneficiary to whom the mining rewards were given.
- difficulty (string; quantity): the difficulty for this block.
- totalDifficulty (string; quantity): the total difficulty of the chain until this block.
- extraData (string; data): the extra data field of this block.
- size (string; quantity): the size of this block in bytes.
- gasLimit (string; quantity): the maximum gas allowed in this block.
- gasUsed (string; quantity): the total used gas by all transactions in this block.
- timestamp (string; quantity): the unix timestamp for when the block was collated.
- transactions (array of strings): an array of transaction objects, or 32 bytes transaction hashes depending on the last given parameter.
- uncles (array of strings): an array of uncle hashes.

Request example

curl -X POST https://rpc.ankr.com/eth/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getBlockByNumber",
      "params": ["0x1b4", true],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "difficulty": "0x4ea3f27bc",
        "extraData": "0x476574682f4c5649562f76312e302e302f6c696e75782f676f312e342e32",
        "gasLimit": "0x1388",
        "gasUsed": "0x0",
        "hash": "0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae",
        "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
        "miner": "0xbb7b8287f3f0a933474a79eae42cbca977791171",
        "mixHash": "0x4fffe9ae21f1c9e15207b1f472d5bbdd68c9595d461666602f2be20daf5e7843",
        "nonce": "0x689056015818adbe",
        "number": "0x1b4",
        "parentHash": "0xe99e022112df268087ea7eafaf4790497fd21dbeeb6bd7a1721df161a6657a54",
        "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
        "size": "0x220",
        "stateRoot": "0xddc8b0234c2e0cad087c8b389aa7ef01f7d79b2570bccb77ce48648aa61c904d",
        "timestamp": "0x55ba467c",
        "totalDifficulty": "0x78ed983323d",
        "transactions": [],
        "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "uncles": []
    }
}

web3_clientVersion​

Parameters​

Returns​

Request example​

Response example​

web3_sha3​

Parameters​

Returns​

Request example​

Response example​

net_version​

Parameters​

Returns​

Request example​

Response example​

net_listening​

Parameters​

Returns​

Request example​

Response example​

eth_syncing​

Parameters​

Returns​

Request example​

Response example (syncing)​

Response example (not syncing)​

eth_gasPrice​

Parameters​

Returns​

Request example​

Response example​

eth_accounts​

Parameters​

Returns​

Request example​

Response example​

eth_blockNumber​

Parameters​

Returns​

Request example​

Response example​

eth_getBalance​

Parameters​

Returns​

Request example​

Response example​

eth_getStorageAt​

Parameters​

Returns​

Request example​

Response example​

eth_getTransactionCount​

Parameters​

Returns​

Request example​

Response example​

eth_getBlockTransactionCountByHash​

Parameters​

Returns​

Request example:​

Response example​

eth_getBlockTransactionCountByNumber​

Parameters​

Returns​

Request example​

Response example​

eth_getUncleCountByBlockHash​

Parameters​

Returns​

Request example​

Response example​

eth_getUncleCountByBlockNumber​

Parameters​

Returns​

Request example​

Response example​

eth_getCode​

Parameters​

Returns​

Request example​

`web3_clientVersion`

Parameters

Returns

Request example

Response example

`web3_sha3`

Parameters

Returns

Request example

Response example

`net_version`

Parameters

Returns

Request example

Response example

`net_listening`

Parameters

Returns

Request example

Response example

`eth_syncing`

Parameters

Returns

Request example

Response example (syncing)

Response example (not syncing)

`eth_gasPrice`

Parameters

Returns

Request example

Response example

`eth_accounts`

Parameters

Returns

Request example

Response example

`eth_blockNumber`

Parameters

Returns

Request example

Response example

`eth_getBalance`

Parameters

Returns

Request example

Response example

`eth_getStorageAt`

Parameters

Returns

Request example

Response example

`eth_getTransactionCount`

Parameters

Returns

Request example

Response example

`eth_getBlockTransactionCountByHash`

Parameters

Returns

Request example:

Response example

`eth_getBlockTransactionCountByNumber`

Parameters

Returns

Request example

Response example

`eth_getUncleCountByBlockHash`

Parameters

Returns

Request example

Response example

`eth_getUncleCountByBlockNumber`

Parameters

Returns

Request example

Response example

`eth_getCode`

Parameters

Returns

Request example