Addresses
This component of the REST API allows one to query information about Addresses (Accounts).
GET Get Address
https://gateway.multiversx.com/address/:bech32Address
This endpoint allows one to retrieve basic information about an Address (Account).
- Request
- Response
Path Parameters
Param | Required | Type | Description |
---|---|---|---|
nonce | REQUIRED | number | The Block nonce (height). |
🟢 200: OK
Block details retrieved successfully.
{
"hyperblock": {
"nonce": 185833,
"round": 186582,
"hash": "6a33...",
"prevBlockHash": "aa7e...",
"epoch": 12,
"numTxs": 1,
"shardBlocks": [
{
"hash": "cba4...",
"nonce": 186556,
"shard": 0
},
{
"hash": "50a16...",
"nonce": 186535,
"shard": 1
},
{
"hash": "7981...",
"nonce": 186536,
"shard": 2
}
],
"transactions": [
{
"type": "normal",
"hash": "b035...",
"nonce": 3,
"value": "1000000000000000000",
"receiver": "erd1...",
"sender": "erd1...",
"gasPrice": 1000000000,
"gasLimit": 70000,
"data": "Zm9yIHRlc3Rz",
"signature": "1047...",
"status": "executed"
}
]
}
}
GET Get Address Nonce
https://gateway.multiversx.com/address/:bech32Address/nonce
This endpoint allows one to retrieve the nonce of an Address.
- Request
- Response
Path Parameters
Param | Required | Type | Description |
---|---|---|---|
bech32Address | REQUIRED | string | The Address to query. |
🟢 200: OK
Nonce successfully retrieved.
{
"data": {
"nonce": 5
},
"error": "",
"code": "successful"
}
GET Get Address Balance
https://gateway.multiversx.com/address/:bech32Address/balance
This endpoint allows one to retrieve the balance of an Address.
- Request
- Response
Path Parameters
Param | Required | Type | Description |
---|---|---|---|
bech32Address | REQUIRED | string | The Address to query. |
🟢 200: OK
Balance successfully retrieved.
{
"data": {
"balance": "100000000000000000000"
},
"error": "",
"code": "successful"
}
GET Get Address Username (herotag)
https://gateway.multiversx.com/address/:bech32Address/username
This endpoint allows one to retrieve the username / herotag of an Address (if any).
- Request
- Response
Path Parameters
Param | Required | Type | Description |
---|---|---|---|
bech32Address | REQUIRED | string | The Address to query. |
🟢 200: OK
Balance successfully retrieved.
{
"data": {
"username": "docs.elrond"
},
"error": "",
"code": "successful"
}
GET Get Address Transactions
https://gateway.multiversx.com/address/:bech32Address/transactions
This endpoint allows one to retrieve the latest 20 Transactions sent from an Address.
- Request
- Response
Path Parameters
Param | Required | Type | Description |
---|---|---|---|
bech32Address | REQUIRED | string | The Address to query. |
🟢 200: OK
Transactions successfully retrieved.
{
"data": {
"transactions": [
{
"hash": "1a3e...",
"fee": "10000000000000000",
"miniBlockHash": "9673...",
"nonce": 68,
"round": 33688,
"value": "1000000000000000000",
"receiver": "erd1...",
"sender": "erd1l453hd0gt5gzdp7czpuall8ggt2dcv5zwmfdf3sd3lguxseux2fsmsgldz",
"receiverShard": 0,
"senderShard": 0,
"gasPrice": 200000000000,
"gasLimit": 50000,
"gasUsed": 50000,
"data": "",
"signature": "ed75...",
"timestamp": 1591258128,
"status": "Success",
"scResults": null
},
{
"hash": "d72d...",
"fee": "10000000000000000",
"miniBlockHash": "fd45...",
"nonce": 67,
"round": 27353,
"value": "100000000000000000000000000",
"receiver": "erd1...",
"sender": "erd1l453hd0gt5gzdp7czpuall8ggt2dcv5zwmfdf3sd3lguxseux2fsmsgldz",
"receiverShard": 1,
"senderShard": 0,
"gasPrice": 200000000000,
"gasLimit": 50000,
"gasUsed": 50000,
"data": "",
"signature": "bb98...",
"timestamp": 1591220142,
"status": "Success",
"scResults": null
},
...
]
},
"error": "",
"code": "successful"
}
This endpoint is not available on Observer Nodes. It is only available on MultiversX Proxy.
Currently, this endpoint is only available on the Official MultiversX Proxy instance.
This endpoint requires the presence of an Elasticsearch instance (populated through Observers) as well.
GET Get Storage Value for Address
https://gateway.multiversx.com/address/:bech32Address/key/:key
This endpoint allows one to retrieve a value stored within the Blockchain for a given Address.
- Request
- Response
Path Parameters
Param | Required | Type | Description |
---|---|---|---|
bech32Address | REQUIRED | string | The Address to query. |
key | REQUIRED | string | The key entry to fetch. |
The key must be hex-encoded.
🟢 200: OK
Value (hex-encoded) successfully retrieved.
{
"data": {
"value": "abba"
},
"error": "",
"code": "successful"
}
GET Get all storage for Address
https://gateway.multiversx.com/address/:bech32Address/keys
This endpoint allows one to retrieve all the key-value pairs stored under a given account.
- Request
- Response
Path Parameters
Param | Required | Type | Description |
---|---|---|---|
bech32Address | REQUIRED | string | The Address to query. |
🟢 200: OK
Key-value pairs (both hex-encoded) successfully retrieved.
{
"data": {
"pairs": {
"abba": "6f6b"
...
}
},
"error": "",
"code": "successful"
}
ESDT tokens endpoints
There are a number of ESDT tokens endpoints that one can use to check all tokens of an address, balance for specific fungible or non-fungible tokens or so on.
Fungible tokens endpoints can be found here and non-fungible tokens endpoints can be found here.