Tatum
Powered by Redocly

Elrond

Elrond (EGLD) is a distributed transactional computation protocol which relies on a sharded state architecture and a secure Proof of Stake consensus mechanism.
Tatum supports 2 chains:

  • Mainnet - a regular live chain
  • Devnet - a chain used for testing purposes. Coins on the test chain have no value and can be obtained from a faucet, e.g. https://r3d4.fr/elrond/devnet/

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.

SecurityX-API-Key
Request
query Parameters
mnemonic
string <= 500 characters

Mnemonic to use for generation of private key.

Responses
200

OK

400

Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.

401

Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

500

Internal server error. There was an error on the server during the processing of the request.

get/v3/egld/wallet
Request samples 
Response samples 
application/json
{
  • "mnemonic": "quantum tobacco key they maid mean crime youth chief jungle mind design broken tilt bus shoulder leaf good forward erupt split divert bread kitten"
}
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.


SecurityX-API-Key 
Request 
path Parameters
mnemonic
required
string
Mnemonic to use for generation of address.


 
 Example:  quantum tobacco key they maid mean crime youth chief jungle mind design broken tilt bus shoulder leaf good forward erupt split divert bread kitten
index
required
number
Derivation index of desired address to be generated.


 
 Example:  1
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server during the processing of the request.


get/v3/egld/address/{mnemonic}/{index}
Request samples 
Response samples 
application/json
{
  • "address": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7"
}
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.


SecurityX-API-Key 
Request 
Request Body schema: application/json
index
required
integer  <= 2147483647 
Derivation index of private key to generate.


 
mnemonic
required
string  [ 1 .. 500 ] characters 
Mnemonic to generate private key from.


 
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server during the processing of the request.


post/v3/egld/wallet/priv
Request samples 
application/json
{
  • "index": 0,
  • "mnemonic": "urge pulp usage sister evidence arrest palm math please chief egg abuse"
}
Response samples 
application/json
{
  • "key": "cTmS2jBWXgFaXZ2xG9jhn67TiyTshnMp3UedamzEhGm6BZV1vLgQ"
}
Node HTTP driverDeprecated
2 credits per API call


This endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.



Use this endpoint URL as a http-based driver to connect directly to the EGLD node provided by Tatum.
To learn more about EGLD, visit the EGLD developer's guide.


SecurityX-API-Key 
Request 
path Parameters
xApiKey
required
string
Tatum X-API-Key used for authorization.


 
 Example:  /v3/egld/node/asdlkfjnqunalkwjf124387ad/transaction/cost
Request Body schema: application/json
object
Any valid method content body.


 
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server during the processing of the request.


post/v3/egld/node/{xApiKey}/*
Request samples 
application/json
{
  • "version": 1,
  • "chainId": "D",
  • "nonce": 42,
  • "value": "100000000000000000",
  • "receiver": "erd1cux02zersde0l7hhklzhywcxk4u9n4py5tdxyx7vrvhnza2r4gmq4vw35r",
  • "sender": "erd1njqj2zggfup4nl83x0nfgqjkjserm7mjyxdx5vzkm8k0gkh40ezqtfz9lg",
  • "gasPrice": 1000000000,
  • "gasLimit": 70000,
  • "data": "food for cats",
  • "signature": "93207c579bf57be03add632b0e1624a73576eeda8a1687e0fa286f03eb1a17ffb125ccdb008a264c402f074a360442c7a034e237679322f62268b614e926d10f"
}
Response samples 
application/json
{ }
Node HTTP driverDeprecated
2 credits per API call


This endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.



Use this endpoint URL as a http-based driver to connect directly to the EGLD node provided by Tatum.
To learn more about EGLD, visit the EGLD developer's guide.


SecurityX-API-Key 
Request 
path Parameters
xApiKey
required
string
Tatum X-API-Key used for authorization.


 
 Example:  /v3/egld/node/asdlkfjnqunalkwjf12341kljl/network/config
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server during the processing of the request.


get/v3/egld/node/{xApiKey}/*
Request samples 
Response samples 
application/json
{
  • "config": {
    }
}
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.
SecurityX-API-Key 
Responses 
200
OK


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server during the processing of the request.


get/v3/egld/block/current
Request samples 
Response samples 
application/json
649127
Get EGLD block by hash
1 credit per API call.

 
Get EGLD block by block hash or block number.  EGLD docs 
SecurityX-API-Key 
Request 
path Parameters
hash
required
string
Block hash or nonce


 
 Example:  a6f2ac15a6b1bafdde9afff2297cef49c4c523c516f8ee12fed54be070e9512b
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server during the processing of the request.


get/v3/egld/block/{hash}
Request samples 
Response samples 
application/json
{
  • "nonce": 5440076,
  • "round": 186582,
  • "hash": "bd2de3618929b696807f6ef8a619f93d29d639aec9277f9c6f8569a8487141b1",
  • "prevBlockHash": "2a11aad21e933be58200839ff875f0ca7e955b8c483a0e117cb92409e5d2a5da",
  • "epoch": 18,
  • "numTxs": 8,
  • "shardBlocks": [
    ],
  • "transactions": [
    ]
}
Get EGLD Account balance
1 credit per API call.

 
Get account balance in EGLD.
SecurityX-API-Key 
Request 
path Parameters
address
required
string
Account address you want to get balance of


 
 Example:  erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server during the processing of the request.


get/v3/egld/account/balance/{address}
Request samples 
Response samples 
application/json
{
  • "balance": "10.52"
}
Get EGLD Transaction
1 credit per API call.

 
Get EGLD transaction by transaction hash. Detail result please find here  EGLD docs 
SecurityX-API-Key 
Request 
path Parameters
hash
required
string
Transaction hash


 
 Example:  99996224823736c1e9b8484ed74c1573049478f871d6f94b86811fb1c7b2addd
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server during the processing of the request.


get/v3/egld/transaction/{hash}
Request samples 
Response samples 
application/json
{
  • "type": null,
  • "nonce": 2,
  • "round": 186580,
  • "epoch": 12,
  • "value": "1000000000000000000",
  • "receiver": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7",
  • "sender": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq1",
  • "gasPrice": 1000000000,
  • "gasLimit": 70000,
  • "data": "Zm9yIHRlc3Rz",
  • "signature": "c6ab10b401f14b122caf9d2ef80d532b986aa82b589dac77d77929da27ae2382c6ab10b401f14b122caf9d2ef80d532b986aa82b589dac77d77929da27ae238",
  • "sourceShard": 2,
  • "destinationShard": 1,
  • "blockNonce": 186535,
  • "blockHash": "bd2de3618929b696807f6ef8a619f93d29d639aec9277f9c6f8569a8487141b1",
  • "miniblockHash": "7cb0a10cf9e9ec9ff719ffe99349db3feac3ec217b6de62f6cf7756647194bbf",
  • "timestamp": 1569600592,
  • "status": "Success",
  • "hyperblockNonce": 123321,
  • "hyperblockHash": "715224f1f7d8330e3837500d1f82431954e30db6149f3ee4644d0950576d8dfe"
}
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.


SecurityX-API-Key 
Request 
path Parameters
address
required
string  = 62 characters 
address


 
 Example:  erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server during the processing of the request.


get/v3/egld/transaction/address/{address}
Request samples 
Response samples 
application/json
[
  • { }
]
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.


SecurityX-API-Key 
Request 
path Parameters
address
required
string  = 62 characters 
address


 
 Example:  erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


500
Internal server error. There was an error on the server during the processing of the request.


get/v3/egld/transaction/count/{address}
Request samples 
Response samples 
application/json
5
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.



SecurityX-API-Key 
Request 
Request Body schema: application/json
One of:
from
required
string  = 62 characters 
Account address of the sender


 
to
required
string  = 62 characters 
Account address of the receiver or smart contract


 
amount
required
string
Value to be sent.


 
object
Custom defined fee. If not present, it will be calculated automatically.


 
gasLimit
string^[+]?\d+$
Gas limit for transaction. If transfer to a smart contract, then 500000 + an appropriate amount for the method call


 
gasPrice
string^[+]?\d+$
Gas price.


 
data
string
Additional data that can be passed to a blockchain transaction as a data property; must be in the hexadecimal format


 
fromPrivateKey
required
string  = 64 characters 
Private key of sender address. Private key, or signature Id must be present.


 
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server during the processing of the request.


post/v3/egld/transaction
Request samples 
application/json
{
  • "from": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7",
  • "to": "erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq6",
  • "amount": "0",
  • "fromPrivateKey": "0cd8e6217b4a218807b858ffb508483cdcdadbb7a21196727f764a510a692760"
}
Response samples 
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}
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.


SecurityX-API-Key 
Request 
Request Body schema: application/json
txData
required
string  [ 1 .. 500000 ] characters 
Raw signed transaction to be published to network.


 
signatureId
string <uuid> 
ID of prepared payment template to sign. Required only, when broadcasting transaction signed by Tatum KMS.


 
index
number  [ 0 .. 2147483647 ] 
(Only if the signature ID is mnemonic-based and you run KMS v6.2 or later) The index of the address to send the assets from that was generated from the mnemonic


 
Responses 
200
OK


400
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.


401
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.


403
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.


500
Internal server error. There was an error on the server during the processing of the request.


post/v3/egld/broadcast
Request samples 
application/json
{
  • "txData": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D"
}
Response samples 
application/json
{
  • "txId": "c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9"
}
➔ Next to Ethereum