For AI agents: an LLM-friendly Markdown version of every page is available by appending .md to its URL or by sending an Accept: text/markdown request header. The full documentation index is at https://www.ankr.com/docs/llms.txt
Skip to main content

Etherlink — web3, net, eth (1/3)

API reference for Etherlink. All methods ->

Part 1 of 3: 1 · 2 · 3

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/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "web3_clientVersion",
      "params": [],
      "id": 1
    }'

Response example​

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": "octez-evm-node/octez-evm-node 0.29-b42b360a/Unix/ocamlc.5.2.1"
}

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/etherlink_mainnet/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/etherlink_mainnet/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": "42793"
}

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/etherlink_mainnet/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": "0x3b9aca00"
}

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/etherlink_mainnet/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": []
}

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/etherlink_mainnet/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": "0x143e45f"
}

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/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getBalance",
      "params": ["0xd7e6B324eE4D34BcC3c830b654c286AB9EEC0226", "latest"],
      "id": 1
    }'

Response example​

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

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/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getStorageAt",
      "params": ["0xA2cCa359C43839040cF3D230DeB1689AB8db2dac", "0x0", "latest"],
      "id": 1
    }'

Response example​

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

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/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getTransactionCount",
      "params": ["0xd7e6B324eE4D34BcC3c830b654c286AB9EEC0226", "latest"],
      "id": 1
    }'

Response example​

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

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/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getBlockTransactionCountByHash",
      "params": ["0x2a014d2f605a0088ea65a60b8ca6f3f8f95b2575d696f5a41ff51c3ab895e5e1"],
      "id": 1
    }'

Response example​

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

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/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getBlockTransactionCountByNumber",
      "params": ["0x143E45D"],
      "id": 1
    }'

Response example​

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

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 hash.

Returns​

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

Request example​

curl -X POST https://rpc.ankr.com/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getUncleCountByBlockHash",
      "params": ["0x2a014d2f605a0088ea65a60b8ca6f3f8f95b2575d696f5a41ff51c3ab895e5e1"],
      "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/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getUncleCountByBlockNumber",
      "params": ["0x143E45D"],
      "id": 1
    }'

Response example​

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

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/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getCode",
      "params": ["0xA2cCa359C43839040cF3D230DeB1689AB8db2dac", "latest"],
      "id": 1
    }'

Response example​

{
    "jsonrpc": "2.0",
    "result": "0x60806040523661001357610011610017565b005b6100115b61001f6101b7565b6001600160a01b0316336001600160a01b0316141561016f5760606001600160e01b031960003516631b2ce7f360e11b8114156100655761005...",
    "id": 1
}

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/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
    "jsonrpc": "2.0",
    "method": "eth_sendRawTransaction",
    "params": ["signed_tx_data"],
    "id": 1
}'

Response example​

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

eth_sendRawTransactionSync​

Submits a transaction and retrieves the transaction receipt.

Synchronous transaction submission; waits for transaction to be included in a block before returning.

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; required): the valid hex-encoded, RLP-encoded signed transaction.
    2. <integer> (quantity; optional): maximum wait time in milliseconds. MUST be a positive integer not greater than the node-configured maximum timeout.

Returns​

  • object: a transaction receipt object, or null when no receipt was found:

    • transactionHash (string; data, 32 bytes): a hash of the transaction.

    • transactionIndex (string; quantity): the transactions index position in the block.

    • blockHash (string; data, 32 bytes): a hash of the block containing the transaction.

    • blockNumber (string; quantity): a number of the block containing the transaction.

    • from (string; data, 20 bytes): an address of the sender.

    • to (string; data, 20 bytes): an address of the receiver; null when it's a contract creation transaction.

    • cumulativeGasUsed (string; quantity): the total amount of gas used when this transaction was executed in the block.

    • effectiveGasPrice (string; quantity): the sum of the base fee and tip paid per unit of gas.

    • gasUsed (string; quantity): the amount of gas used by this specific transaction alone.

    • contractAddress (string; data, 20 bytes): the contract address created, if the transaction was a contract creation, otherwise null.

    • logs (array): an array of log objects, which this transaction generated.

    • logsBloom (string; data, 256 bytes): a bloom filter for light clients to quickly retrieve related logs.

    • type (string; data): the transaction type, 0x00 for legacy transactions, 0x01 for access list types, 0x02 for dynamic fees. It also returns either of the following:

      • root (string; data, 32 bytes): a post-transaction stateroot (pre Byzantium).
      • status (string; quantity): either 1 (success) or 0 (failure).

Request example (no timeout)​

curl -X POST https://rpc.ankr.com/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_sendRawTransactionSync",
      "params": [
        "0xf86c808504a817c80082520894ab... (signed tx hex)"
      ],
      "id": 1
    }'

Request example (with timeout)​

curl -X POST https://rpc.ankr.com/etherlink_mainnet/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_sendRawTransactionSync",
      "params": [
        "0xf86c808504a817c80082520894ab... (signed tx hex)",
        5000
      ],
      "id": 1
    }'

Response example​

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "transactionHash": "0x1234abcd...",
        "blockHash": "0xabcd1234...",
        "blockNumber": "0x10d4f",
        "cumulativeGasUsed": "0x5208",
        "gasUsed": "0x5208",
        "contractAddress": null,
        "logs": [],
        "status": "0x1"
    }
}