Api/EthereumApi

Ethereum API Reference

// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();

// MainNet API Call
$sdk->mainnet()->api()->ethereum();

// TestNet API Call
$sdk->testnet()->api()->ethereum();

Methods

callReadSmartContractMethod()

Example

#️⃣ Execute command in terminal

✨ php -f callReadSmartContractMethod.php

Request

POST /v3/ethereum/smartcontract

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->callReadSmartContractMethod(
    \Tatum\Model\CallReadSmartContractMethod $call_read_smart_contract_method,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\CallSmartContractMethod200Response

Parameters

Return type

\Tatum\Model\CallSmartContractMethod200Response

Description

Invoke a method in a smart contract on Ethereum

Back to top

callSmartContractMethod()

Example

#️⃣ Execute command in terminal

✨ php -f callSmartContractMethod.php

Request

POST /v3/ethereum/smartcontract

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->callSmartContractMethod(
    \Tatum\Model\CallSmartContractMethod $call_smart_contract_method,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\CallSmartContractMethod200Response

Parameters

Return type

\Tatum\Model\CallSmartContractMethod200Response

Description

Invoke a method in a smart contract on Ethereum

2 credits per API call

Invoke a method in an existing smart contract on Ethereum.

You can call a read-only or write method.

• For read-only methods, the output of the invoked method is returned.
• For write methods, the ID of the associated transaction is returned.

Troubleshooting a failed transaction Tatum ensures that this API works against the blockchain (accesses the blockchain, finds the specified smart contract, and executes the specified ABI method with the provided parameters). However, because this API can be run against any smart contract on the blockchain, Tatum cannot in any way guarantee that the method itself will be executed successfully.

If you have issues with invoking the method, refer to the user documentation for this method, or contact the author of the smart contract.

For more information about invoking methods in smart contracts, see this article on our Support Portal.

Signing a transaction When invoking a method in a smart contract, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

callSmartContractMethodKMS()

Example

#️⃣ Execute command in terminal

✨ php -f callSmartContractMethodKMS.php

Request

POST /v3/ethereum/smartcontract

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->callSmartContractMethodKMS(
    \Tatum\Model\CallSmartContractMethodKMS $call_smart_contract_method_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\CallSmartContractMethod200Response

Parameters

Return type

\Tatum\Model\CallSmartContractMethod200Response

Description

Invoke a method in a smart contract on Ethereum

Back to top

ethBroadcast()

Example

#️⃣ Execute command in terminal

✨ php -f ethBroadcast.php

Request

POST /v3/ethereum/broadcast

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethBroadcast(
    \Tatum\Model\BroadcastKMS $broadcast_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionHash

Parameters

Return type

\Tatum\Model\TransactionHash

Description

Broadcast signed Ethereum transaction

2 credits per API call

Broadcast signed transaction to Ethereum blockchain. This method is used internally from Tatum KMS or Tatum client libraries. It is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.

Back to top

ethGenerateAddress()

Example

#️⃣ Execute command in terminal

✨ php -f ethGenerateAddress.php

Request

GET /v3/ethereum/address/{xpub}/{index}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGenerateAddress(
    string $xpub,
    float $index,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\GeneratedAddressEth

Parameters

Return type

\Tatum\Model\GeneratedAddressEth

Description

Generate Ethereum account address from Extended public key

1 credit per API call.

Generates an Ethereum account deposit address from an Extended public key. The deposit address is generated for the specific index - each extended public key can generate up to 2^31 addresses starting from index 0 until 2^31 - 1.

Back to top

ethGenerateAddressPrivateKey()

Example

#️⃣ Execute command in terminal

✨ php -f ethGenerateAddressPrivateKey.php

Request

POST /v3/ethereum/wallet/priv

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGenerateAddressPrivateKey(
    \Tatum\Model\PrivKeyRequest $priv_key_request,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\PrivKey

Parameters

Return type

\Tatum\Model\PrivKey

Description

Generate Ethereum private key

1 credit per API call.

Generates the private key of an address from a mnemonic for a given derivation path index. The private key is generated for the specific index - each mnemonic can generate up to 2^32 private keys starting from index 0 until 2^31 - 1.

Back to top

ethGenerateWallet()

Example

#️⃣ Execute command in terminal

✨ php -f ethGenerateWallet.php

Request

GET /v3/ethereum/wallet

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGenerateWallet(
    [ string $mnemonic, ]
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\Wallet

Parameters

Return type

\Tatum\Model\Wallet

Description

Generate Ethereum wallet

1 credit per API call.

Tatum supports BIP44 HD wallets. Because they can generate 2^31 addresses from 1 mnemonic phrase, they are very convenient and secure. A mnemonic phrase consists of 24 special words in a defined order and can restore access to all generated addresses and private keys. Each address is identified by 3 main values:

• Private Key - your secret value which should never be revealed
• Public Key - a public address to be published
• Derivation index - an index of generated address

Tatum follows the BIP44 specification and generates for Ethereum wallets with the derivation path m/44’/60’/0’/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki. Generates a BIP44 compatible Ethereum wallet.

Back to top

ethGetBalance()

Example

#️⃣ Execute command in terminal

✨ php -f ethGetBalance.php

Request

GET /v3/ethereum/account/balance/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGetBalance(
    string $address,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\EthBalance

Parameters

Return type

\Tatum\Model\EthBalance

Description

Get the ETH balance of an Ethereum account

1 credit per API call

Get the balance of ETH of an Ethereum account.

To get the balance of tokens, use the APIs for getting the balance of fungible tokens (ERC-20) and NFTs (ERC-721).

Back to top

ethGetBlock()

Example

#️⃣ Execute command in terminal

✨ php -f ethGetBlock.php

Request

GET /v3/ethereum/block/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGetBlock(
    string $hash,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\EthBlock

Parameters

Return type

\Tatum\Model\EthBlock

Description

Get Ethereum block by hash

1 credit per API call.

Gets an Ethereum block-by-block hash or block number.

Back to top

ethGetCurrentBlock()

Example

#️⃣ Execute command in terminal

✨ php -f ethGetCurrentBlock.php

Request

GET /v3/ethereum/block/current

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGetCurrentBlock(
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): float

Parameters

Return type

float

Description

Get current block number

1 credit per API call.

Gets the current Ethereum block number. This is the number of the latest block in the blockchain.

Back to top

ethGetInternalTransactionByAddress()

Example

#️⃣ Execute command in terminal

✨ php -f ethGetInternalTransactionByAddress.php

Request

GET /v3/ethereum/account/transaction/erc20/internal/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGetInternalTransactionByAddress(
    string $address,
    float $page_size,
    [ float $offset, ]
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\EthTxInternal[]

Parameters

Return type

\Tatum\Model\EthTxInternal[]

Description

Get Ethereum internal transactions by address

1 credit per API call.

Get Ethereum internal transactions by address.

Back to top

ethGetTransaction()

Example

#️⃣ Execute command in terminal

✨ php -f ethGetTransaction.php

Request

GET /v3/ethereum/transaction/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGetTransaction(
    string $hash,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\EthTx

Parameters

Return type

\Tatum\Model\EthTx

Description

Get Ethereum Transaction

1 credit per API call

Get Ethereum transaction by transaction hash.

Back to top

ethGetTransactionByAddress()

Example

#️⃣ Execute command in terminal

✨ php -f ethGetTransactionByAddress.php

Request

GET /v3/ethereum/account/transaction/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGetTransactionByAddress(
    string $address,
    float $page_size,
    [ float $offset, ]
    [ float $from, ]
    [ float $to, ]
    [ string $sort = 'DESC', ]
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\EthTx[]

Parameters

Return type

\Tatum\Model\EthTx[]

Description

Get Ethereum transactions by address

1 credit per API call.

Get Ethereum transactions by address. This includes incoming and outgoing transactions for the address.

Back to top

ethGetTransactionCount()

Example

#️⃣ Execute command in terminal

✨ php -f ethGetTransactionCount.php

Request

GET /v3/ethereum/transaction/count/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->ethGetTransactionCount(
    string $address,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): float

Parameters

Return type

float

Description

Get count of outgoing Ethereum transactions

1 credit per API call.

Get a number of outgoing Ethereum transactions for the address. When a transaction is sent, there can be multiple outgoing transactions, which are not yet processed by the blockchain. To distinguish between them, there is a counter called a nonce, which represents the order of the transaction in the list of outgoing transactions.

Back to top

transferEthBlockchain()

Example

#️⃣ Execute command in terminal

✨ php -f transferEthBlockchain.php

Request

POST /v3/ethereum/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->transferEthBlockchain(
    \Tatum\Model\TransferEthBlockchain $transfer_eth_blockchain,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send ETH or fungible tokens (ERC-20) from account to account

2 credits per API call

Send ETH or Tatum-supported fungible tokens (ERC-20) from account to account.

NOTE: Sending the fungible tokens is supported only on the mainnet.

Signing a transaction When sending ETH, you are charged a fee for the transaction, and you must sign the transaction with the private key of the blockchain address from which the fee will be deducted.

Providing the private key in the API is not a secure way of signing transactions, because the private key can be stolen or exposed. Your private keys should never leave your security perimeter. You should use the private keys only for testing a solution you are building on the testnet of a blockchain.

For signing transactions on the mainnet, we strongly recommend that you use the Tatum Key Management System (KMS) and provide the signature ID instead of the private key in the API. Alternatively, you can use the Tatum JavaScript client.

Back to top

transferEthBlockchainKMS()

Example

#️⃣ Execute command in terminal

✨ php -f transferEthBlockchainKMS.php

Request

POST /v3/ethereum/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->ethereum()->transferEthBlockchainKMS(
    \Tatum\Model\TransferEthBlockchainKMS $transfer_eth_blockchain_kms,
    [ string $x_testnet_type = 'ethereum-sepolia' ]
): \Tatum\Model\TransactionSigned

Parameters

Return type

\Tatum\Model\TransactionSigned

Description

Send ETH or fungible tokens (ERC-20) from account to account

Back to top