Api/ElrondApi

Elrond API Reference

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

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

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

Methods

Method	Description
eGldGetCurrentBlock()	Get current block number
egldBroadcast()	Broadcast signed EGLD transaction
egldGenerateAddress()	Generate EGLD account address from mnemonic
egldGenerateAddressPrivateKey()	Generate EGLD private key
egldGenerateWallet()	Generate EGLD wallet
egldGetBalance()	Get EGLD Account balance
egldGetBlock()	Get EGLD block by hash
egldGetTransaction()	Get EGLD Transaction
egldGetTransactionAddress()	Get count of outgoing EGLD transactions
egldGetTransactionCount()	Get count of outgoing EGLD transactions
transferEgldBlockchain()	Send EGLD from account to account
transferEgldBlockchainKMS()	Send EGLD from account to account

`eGldGetCurrentBlock()`

Example

#️⃣ Execute command in terminal

✨ php -f eGldGetCurrentBlock.php

Request

GET /v3/egld/block/current

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->eGldGetCurrentBlock(): float

Parameters

This endpoint does not need any parameter.

Return type

float

Description

Get current block number

1 credit per API call.

Get EGLD current block number. This is the number of the latest block in the blockchain.

`egldBroadcast()`

Example

#️⃣ Execute command in terminal

✨ php -f egldBroadcast.php

Request

POST /v3/egld/broadcast

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->egldBroadcast(
    \Tatum\Model\BroadcastKMS $broadcast_kms
): \Tatum\Model\TransactionHash

Parameters

Name	Type	Description	Notes
$broadcast_kms	\Tatum\Model\BroadcastKMS

Return type

\Tatum\Model\TransactionHash

Description

Broadcast signed EGLD transaction

2 credits per API call.

Broadcast signed transaction to EGLD 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.

`egldGenerateAddress()`

Example

#️⃣ Execute command in terminal

✨ php -f egldGenerateAddress.php

Request

GET /v3/egld/address/{mnemonic}/{index}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->egldGenerateAddress(
    string $mnemonic,
    float $index
): \Tatum\Model\EgldGenerateAddress200Response

Parameters

Name	Type	Description	Notes
$mnemonic	string	Mnemonic to use for generation of address.
$index	float	Derivation index of desired address to be generated.

Return type

\Tatum\Model\EgldGenerateAddress200Response

Description

Generate EGLD account address from mnemonic

1 credit per API call.

Generate EGLD account deposit address from mnemonic phrase. Deposit address is generated for the specific index - each mnemonic phrase can generate up to 2^31 addresses starting from index 0 until 2^31.

`egldGenerateAddressPrivateKey()`

Example

#️⃣ Execute command in terminal

✨ php -f egldGenerateAddressPrivateKey.php

Request

POST /v3/egld/wallet/priv

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->egldGenerateAddressPrivateKey(
    \Tatum\Model\PrivKeyRequest $priv_key_request
): \Tatum\Model\PrivKey

Parameters

Name	Type	Description	Notes
$priv_key_request	\Tatum\Model\PrivKeyRequest

Return type

\Tatum\Model\PrivKey

Description

Generate EGLD private key

1 credit per API call.

Generate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic can generate up to 2^31 private keys starting from index 0 until 2^31.

`egldGenerateWallet()`

Example

#️⃣ Execute command in terminal

✨ php -f egldGenerateWallet.php

Request

GET /v3/egld/wallet

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->egldGenerateWallet(
    [ string $mnemonic ]
): \Tatum\Model\EgldGenerateWallet200Response

Parameters

Name	Type	Description	Notes
$mnemonic	string	Mnemonic to use for generation of private key.	[optional]

Return type

\Tatum\Model\EgldGenerateWallet200Response

Description

Generate EGLD wallet

1 credit per API call.

The Elrond Address format is bech32, specified by the BIP 0173. The address always starts with an erd1. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in 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 - public address to be published
Derivation index - index of generated address

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

`egldGetBalance()`

Example

#️⃣ Execute command in terminal

✨ php -f egldGetBalance.php

Request

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

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->egldGetBalance(
    string $address
): \Tatum\Model\EgldGetBalance200Response

Parameters

Name	Type	Description	Notes
$address	string	Account address you want to get balance of

Return type

\Tatum\Model\EgldGetBalance200Response

Description

Get EGLD Account balance

1 credit per API call.

Get account balance in EGLD.

`egldGetBlock()`

Example

#️⃣ Execute command in terminal

✨ php -f egldGetBlock.php

Request

GET /v3/egld/block/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->egldGetBlock(
    string $hash
): \Tatum\Model\EgldBlock

Parameters

Name	Type	Description	Notes
$hash	string	Block hash or nonce

Return type

\Tatum\Model\EgldBlock

Description

Get EGLD block by hash

1 credit per API call.

Get EGLD block by block hash or block number. EGLD docs

`egldGetTransaction()`

Example

#️⃣ Execute command in terminal

✨ php -f egldGetTransaction.php

Request

GET /v3/egld/transaction/{hash}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->egldGetTransaction(
    string $hash
): \Tatum\Model\EgldTx

Parameters

Name	Type	Description	Notes
$hash	string	Transaction hash

Return type

\Tatum\Model\EgldTx

Description

Get EGLD Transaction

1 credit per API call.

Get EGLD transaction by transaction hash. Detail result please find here EGLD docs

`egldGetTransactionAddress()`

Example

#️⃣ Execute command in terminal

✨ php -f egldGetTransactionAddress.php

Request

GET /v3/egld/transaction/address/{address}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->egldGetTransactionAddress(
    string $address
): object[]

Parameters

Name	Type	Description	Notes
$address	string	address

Return type

object[]

Description

Get count of outgoing EGLD transactions

1 credit per API call.

This endpoint allows one to retrieve the latest 20 transactions sent from an address.

`egldGetTransactionCount()`

Example

#️⃣ Execute command in terminal

✨ php -f egldGetTransactionCount.php

Request

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

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->egldGetTransactionCount(
    string $address
): float

Parameters

Name	Type	Description	Notes
$address	string	address

Return type

float

Description

Get count of outgoing EGLD transactions

1 credit per API call.

Get a number of outgoing EGLD 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.

`transferEgldBlockchain()`

Example

#️⃣ Execute command in terminal

✨ php -f transferEgldBlockchain.php

Request

POST /v3/egld/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->transferEgldBlockchain(
    \Tatum\Model\TransferEgldBlockchain $transfer_egld_blockchain
): \Tatum\Model\TransactionSigned

Parameters

Name	Type	Description	Notes
$transfer_egld_blockchain	\Tatum\Model\TransferEgldBlockchain

Return type

\Tatum\Model\TransactionSigned

Description

Send EGLD from account to account

2 credits per API call.

Send EGLD from account to account. This operation needs the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key. No one should ever send it’s own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on devnet versions of blockchain when there is no risk of losing funds. In production, Tatum KMS should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

`transferEgldBlockchainKMS()`

Example

#️⃣ Execute command in terminal

✨ php -f transferEgldBlockchainKMS.php

Request

POST /v3/egld/transaction

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->elrond()->transferEgldBlockchainKMS(
    \Tatum\Model\TransferEgldBlockchainKMS $transfer_egld_blockchain_kms
): \Tatum\Model\TransactionSigned

Parameters

Name	Type	Description	Notes
$transfer_egld_blockchain_kms	\Tatum\Model\TransferEgldBlockchainKMS

Return type

\Tatum\Model\TransactionSigned

Description

Send EGLD from account to account