REST API
The mirror node REST API offers the ability to query transaction information.
Hedera Mirror Nodes store the history of transactions that occurred on mainnet, testnet, and previewnet. Each transaction generates a record that is stored in a record file. The transaction contents can be accessed by the mirror node REST APIs
To make a request, use the network endpoint and the REST API of choice. For example, to get a list of transactions on mainnet you would make the following request.
MAINNET BASEURL
https://mainnet.mirrornode.hedera.com/
TESTNET BASEURL
https://testnet.mirrornode.hedera.com/
PREVIEWNET BASEURL
https://previewnet.mirrornode.hedera.com/
You may also check out Validation Cloud, DragonGlass, Arkhia or Ledger Works as alternatives.
Public mainnet mirror node requests per second (RPS) are currently throttled at 50 per IP address. These configurations may change in the future depending on performance or security considerations. At this time, no authentication is required.
Accounts
The accounts object represents the information associated with an account and returns a list of account information.
Account IDs take the following format: 0.0.<account number>.
Example: 0.0.1000
Account IDs can also take the account number as an input value. For example, for account ID 0.0.1000, the number 1000 can be specified in the request.
List account entities on network
Returns a list of all account entity items on the network.
/api/v1/accounts
The optional balance value to compare against
^((gte?|lte?|eq|ne)\:)?\d{1,10}$
The ID of the account to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
The account's public key to compare against
3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be
Whether to include balance information or not. If included, token balances are limited to at most 50 per account as outlined in HIP-367. If multiple values are provided the last value will be the only value used.
true
The maximum number of items to return
2
The order in which items are listed
desc
asc
, desc
Response Details
Response Item
Description
account
The ID of the account
allowances
The allowances granted to this account
alias
RFC4648 no-padding base32 encoded account alias
auto_renew_period
The period in which the account will auto renew
balance
The timestamp and account balance of the account
created_timestamp
The timestamp for the creation of that account
decline_reward
Whether or not the account has opted to decline a staking reward
deleted
Whether the account was deleted or not
ethereum_nonce
The ethereum transaction nonce associated with this account
evm_address
A network entity encoded as an EVM encoded hex
expiry_timestamp
The expiry date for the entity as set by a create or update transaction
key
The public key associated with the account
links.next
Hyperlink to the next page of results
max_automatic_token_associations
The number of automatic token associations, if any
memo
The account memo, if any
nfts
List of nfts informations belonging to this account
pending_reward
The account's pending staking reward that has not been transferred to the account
receiver_sig_required
Whether or not the account requires a signature to receive a transfer into the account
rewards
List of rewards which of the account
staked_account_id
The account ID the account is staked to, if set
staked_node_id
The node ID the account is staked to, if set
stake_period_start
The start of the staking period
tokens
The tokens and their balances associated to the specified account
Optional Filtering
lt
(less than)
/api/v1/accounts?account.id=lt:0.0.1000
Returns account IDs less then 1000
lte
(less than or equal to)
/api/v1/accounts?account.id=lte:0.0.1000
Returns account IDs less than or equal to 1000
gt
(greater than)
/api/v1/accounts?account.id=gt:0.0.1000
Returns account IDs greater than 1000
gte
(greater than or equal to)
/api/v1/accounts?account.id=gte:0.0.1000
Returns account IDs greater than or equal to 1000
order
(order asc
or desc
values)
/api/v1/accounts?order=asc
/api/v1/accounts?order=desc
Returns account information in ascending order
Returns account information in descending order
Additional Examples
/api/v1/accounts?account.id=0.0.1001
Returns the account information of account 1001
/api/v1/accounts?account.balance=gt:1000
Returns all account information that have a balance greater than 1000 tinybars
/api/v1/accounts?account.publickey=2b60955bcbf0cf5e9ea880b52e5b63f664b08edf6ed 15e301049517438d61864
Returns all account information for 2b60955bcbf0cf5e9ea880b52e5b63f664b08edf6ed15e301049517438d61864 public key
/api/v1/accounts/2?transactionType=cryptotransfer
Returns the crypto transfer transactions for account 2.
Get account by alias, id, or evm address
Return the account transactions and balance information given an account alias, an account id, or an evm address. The information will be limited to at most 1000 token balances for the account as outlined in HIP-367. When the timestamp parameter is supplied, we will return transactions and account state for the relevant timestamp query. Balance information will be accurate to within 15 minutes of the provided timestamp query. Historical ethereum nonce information is currently not available and may not be the exact value at a provided timestamp.
/api/v1/accounts/{idOrAliasOrEvmAddress}
Account alias or account id or evm address
^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$
The maximum number of items to return
2
The order in which items are listed
asc
asc
, desc
The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
cryptotransfer
CONSENSUSCREATETOPIC
, CONSENSUSDELETETOPIC
, CONSENSUSSUBMITMESSAGE
, CONSENSUSUPDATETOPIC
, CONTRACTCALL
, CONTRACTCREATEINSTANCE
, CONTRACTDELETEINSTANCE
, CONTRACTUPDATEINSTANCE
, CRYPTOADDLIVEHASH
, CRYPTOAPPROVEALLOWANCE
, CRYPTOCREATEACCOUNT
, CRYPTODELETE
, CRYPTODELETEALLOWANCE
, CRYPTODELETELIVEHASH
, CRYPTOTRANSFER
, CRYPTOUPDATEACCOUNT
, ETHEREUMTRANSACTION
, FILEAPPEND
, FILECREATE
, FILEDELETE
, FILEUPDATE
, FREEZE
, NODE
, NODECREATE
, NODEDELETE
, NODESTAKEUPDATE
, NODEUPDATE
, SCHEDULECREATE
, SCHEDULEDELETE
, SCHEDULESIGN
, SYSTEMDELETE
, SYSTEMUNDELETE
, TOKENAIRDROP
, TOKENASSOCIATE
, TOKENBURN
, TOKENCANCELAIRDROP
, TOKENCLAIMAIRDROP
, TOKENCREATION
, TOKENDELETION
, TOKENDISSOCIATE
, TOKENFEESCHEDULEUPDATE
, TOKENFREEZE
, TOKENGRANTKYC
, TOKENMINT
, TOKENPAUSE
, TOKENREJECT
, TOKENREVOKEKYC
, TOKENUNFREEZE
, TOKENUNPAUSE
, TOKENUPDATE
, TOKENUPDATENFTS
, TOKENWIPE
, UNCHECKEDSUBMIT
, UNKNOWN
, UTILPRNG
If provided and set to false transactions will not be included in the response
true
Get crypto allowances for an account info
Returns information for all crypto allowances for an account.
/api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/crypto
Account alias or account id or evm address
^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$
The maximum number of items to return
2
The order in which items are listed
asc
asc
, desc
The ID of the spender to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
Get token relationships info for an account
Returns information for all token relationships for an account.
/api/v1/accounts/{idOrAliasOrEvmAddress}/tokens
Account alias or account id or evm address
^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$
The maximum number of items to return
2
The order in which items are listed
desc
asc
, desc
The ID of the token to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
Get nfts for an account info
Returns information for all non-fungible tokens for an account.
Ordering
When considering NFTs, their order is governed by a combination of their numerical token.Id and serialnumber values, with token.id being the parent column. A serialnumbers value governs its order within the given token.id
In that regard, if a user acquired a set of NFTs in the order (2-2, 2-4 1-5, 1-1, 1-3, 3-3, 3-4), the following layouts illustrate the ordering expectations for ownership listing
- All NFTs in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
- All NFTs in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3, 1-1
- NFTs above 1-1 in ASC order: 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
- NFTs below 3-3 in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4
- NFTs between 1-3 and 3-3 inclusive in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3
Note: The default order for this API is currently DESC
Filtering
When filtering there are some restrictions enforced to ensure correctness and scalability.
The table below defines the restrictions and support for the NFT ownership endpoint
Query Param | Comparison Operator | Support | Description | Example |
---|---|---|---|---|
token.id | eq | Y | Single occurrence only. | ?token.id=X |
ne | N | |||
lt(e) | Y | Single occurrence only. | ?token.id=lte:X | |
gt(e) | Y | Single occurrence only. | ?token.id=gte:X | |
serialnumber | eq | Y | Single occurrence only. Requires the presence of a token.id query | ?serialnumber=Y |
ne | N | |||
lt(e) | Y | Single occurrence only. Requires the presence of an lte or eq token.id query | ?token.id=lte:X&serialnumber=lt:Y | |
gt(e) | Y | Single occurrence only. Requires the presence of an gte or eq token.id query | ?token.id=gte:X&serialnumber=gt:Y | |
spender.id | eq | Y | ?spender.id=Z | |
ne | N | |||
lt(e) | Y | ?spender.id=lt:Z | ||
gt(e) | Y | ?spender.id=gt:Z |
Note: When searching across a range for individual NFTs a serialnumber with an additional token.id query filter must be provided. Both filters must be a single occurrence of gt(e) or lt(e) which provide a lower and or upper boundary for search.
/api/v1/accounts/{idOrAliasOrEvmAddress}/nfts
Account alias or account id or evm address
^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$
The maximum number of items to return
2
The order in which items are listed
asc
asc
, desc
The nft serial number (64 bit type). Requires a tokenId value also be populated.
^((eq|gt|gte|lt|lte):)?\d{1,19}?$
The ID of the spender to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
The ID of the token to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
Get fungible token allowances for an account
Returns information for fungible token allowances for an account.
Ordering
The order is governed by a combination of the spender id and the token id values, with spender id being the parent column. The token id value governs its order within the given spender id.
Note: The default order for this API is currently ASC
Filtering
When filtering there are some restrictions enforced to ensure correctness and scalability.
The table below defines the restrictions and support for the endpoint
Query Param | Comparison Operator | Support | Description | Example |
---|---|---|---|---|
spender.id | eq | Y | Single occurrence only. | ?spender.id=X |
ne | N | |||
lt(e) | Y | Single occurrence only. | ?spender.id=lte:X | |
gt(e) | Y | Single occurrence only. | ?spender.id=gte:X | |
token.id | eq | Y | Single occurrence only. Requires the presence of a spender.id query | ?token.id=lt:Y |
ne | N | |||
lt(e) | Y | Single occurrence only. Requires the presence of an lte or eq spender.id query | ?spender.id=lte:X&token.id=lt:Y | |
gt(e) | Y | Single occurrence only. Requires the presence of an gte or eq spender.id query | ?spender.id=gte:X&token.id=gt:Y |
Both filters must be a single occurrence of gt(e) or lt(e) which provide a lower and or upper boundary for search.
/api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/tokens
Account alias or account id or evm address
^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$
The maximum number of items to return
2
The order in which items are listed
desc
asc
, desc
The ID of the spender to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
The ID of the token to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
Get past staking reward payouts for an account
Returns information for all past staking reward payouts for an account.
/api/v1/accounts/{idOrAliasOrEvmAddress}/rewards
Account alias or account id or evm address
^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$
The maximum number of items to return
2
The order in which items are listed
asc
asc
, desc
The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
Balances
The balance object represents the balance of accounts on the Hedera network. You can retrieve this to view the most recent balance of all the accounts on the network at that given time. The balances object returns the account ID and the balance in hbars. Balances are checked on a periodic basis and thus return the most recent snapshot of time captured prior to the request.
List account balances
Returns a list of account and token balances on the network. Balance information returned by this API has a 15 minute granularity as it's generated by an asynchronous balance snapshot process. This information is limited to at most 50 token balances per account as outlined in HIP-367. As such, it's not recommended for general use and we instead recommend using either /api/v1/accounts/{id}/tokens
or /api/v1/tokens/{id}/balances
to obtain the current token balance information and /api/v1/accounts/{id}
to return the current account balance.
/api/v1/balances
Account id or account alias with no shard realm or evm address with no shard realm
^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$
The optional balance value to compare against
^((gte?|lte?|eq|ne)\:)?\d{1,10}$
The account's public key to compare against
3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be
The maximum number of items to return
2
The order in which items are listed
asc
asc
, desc
The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
Response Details
timestamp
The seconds.nanoseconds of the timestamp at which the list of balances for each account are returned
balances
List of balances for each account
account
The ID of the account
balance
The balance of the account
tokens
The tokens that are associated to this account
tokens.token_id
The ID of the token associated to this account
tokens.balance
The token balance for the specified token associated to this account
links.next
Hyperlink to the next page of results
Optional Filtering
lt
(less than)
/api/v1/balances?account.id=lt:0.0.1000
Returns the balances of account IDs less than 1,000
lte
(less than or equal to)
/api/v1/balances?account.id=lte:0.0.1000
Returns the balances account IDs less than or equal to 1,000
gt
(greater than)
/api/v1/balances?account.id=gt:0.0.1000
Returns the balances of account IDs greater than to 1,000
gte
(greater than or equal to)
/api/v1/balances?account.id=gte:0.0.1000
Returns the balances of account IDs greater than or equal to 1,000
order
(order asc
or desc
values)
/api/v1/balances?order=asc
/api/v1/balances?order=desc
Lists balances in ascending order
Lists balances in descending order
Additional Examples
/api/v1/balances?account.id=0.0.1000
Returns balance for account ID 1,000
/api/v1/balances?account.balance=gt:1000
Returns all account IDs that have a balance greater than 1000 tinybars
/api/v1/balances?timestamp=1566562500.040961001
Returns all account balances referencing the latest snapshot that occurred prior to 1566562500 seconds and 040961001 nanoseconds
/api/v1/balances?account.publickey=2b60955bcbf0cf5e9ea880b52e5b6 3f664b08edf6ed15e301049517438d61864
Returns balance information for 2b60955bcbf0cf5e9ea880b52e5b63f664b08edf6ed 15e301049517438d61864 public key
Transactions
The transaction object represents the transactions processed on the Hedera network. You can retrieve this to view the transaction metadata information including transaction id, timestamp, transaction fee, transfer list, etc. If a transaction was submitted to multiple nodes, the successful transaction and duplicate transaction(s) will be returned as separate entries in the response with the same transaction ID. Duplicate transactions will still be assessed network fees.
List transactions
Lists transactions on the network. This includes successful and unsuccessful transactions.
/api/v1/transactions
The ID of the account to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
The maximum number of items to return
2
The order in which items are listed
asc
asc
, desc
The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
cryptotransfer
CONSENSUSCREATETOPIC
, CONSENSUSDELETETOPIC
, CONSENSUSSUBMITMESSAGE
, CONSENSUSUPDATETOPIC
, CONTRACTCALL
, CONTRACTCREATEINSTANCE
, CONTRACTDELETEINSTANCE
, CONTRACTUPDATEINSTANCE
, CRYPTOADDLIVEHASH
, CRYPTOAPPROVEALLOWANCE
, CRYPTOCREATEACCOUNT
, CRYPTODELETE
, CRYPTODELETEALLOWANCE
, CRYPTODELETELIVEHASH
, CRYPTOTRANSFER
, CRYPTOUPDATEACCOUNT
, ETHEREUMTRANSACTION
, FILEAPPEND
, FILECREATE
, FILEDELETE
, FILEUPDATE
, FREEZE
, NODE
, NODECREATE
, NODEDELETE
, NODESTAKEUPDATE
, NODEUPDATE
, SCHEDULECREATE
, SCHEDULEDELETE
, SCHEDULESIGN
, SYSTEMDELETE
, SYSTEMUNDELETE
, TOKENAIRDROP
, TOKENASSOCIATE
, TOKENBURN
, TOKENCANCELAIRDROP
, TOKENCLAIMAIRDROP
, TOKENCREATION
, TOKENDELETION
, TOKENDISSOCIATE
, TOKENFEESCHEDULEUPDATE
, TOKENFREEZE
, TOKENGRANTKYC
, TOKENMINT
, TOKENPAUSE
, TOKENREJECT
, TOKENREVOKEKYC
, TOKENUNFREEZE
, TOKENUNPAUSE
, TOKENUPDATE
, TOKENUPDATENFTS
, TOKENWIPE
, UNCHECKEDSUBMIT
, UNKNOWN
, UTILPRNG
The transaction success type.
success
, fail
The transaction account balance modification type.
credit
, debit
Get transaction by id
Returns transaction information based on the given transaction id
/api/v1/transactions/{transactionId}
Transaction id
0.0.10-1234567890-000000000
Filter the query result by the nonce of the transaction. A zero nonce represents user submitted transactions while a non-zero nonce is generated by main nodes. The filter honors the last value. If not specified, all transactions with specified payer account ID and valid start timestamp match. If multiple values are provided the last value will be the only value used.
0
Filter transactions by the scheduled flag. If true, return information for the scheduled transaction. If false, return information for the non-scheduled transaction. If not present, return information for all transactions matching transactionId. If multiple values are provided the last value will be the only value used.
Response Details
consensus timestamp
The consensus timestamp in seconds.nanoseconds
transaction hash
The hash value of the transaction processed on the Hedera network
valid start timestamp
The time the transaction is valid
charged tx fee
The transaction fee that was charged for that transaction
transaction id
The ID of the transaction
memo base64
The memo attached to the transaction encoded in Base64 format
result
Whether the cryptocurrency transaction was successful or not
entity ID
The entity ID that is created from create transactions (AccountCreateTransaction, TopicCreateTransaction, TokenCreateTransaction, ScheduleCreateTransaction, ContractCreateTransaction, FileCreateTransaction).
name
The type of transaction
max fee
The maximum transaction fee the client is willing to pay
valid duration seconds
The seconds for which a submitted transaction is to be deemed valid beyond the start time. The transaction is invalid if consensusTimestamp is greater than transactionValidStart + valid_duration_seconds.
node
The ID of the node that submitted the transaction to the network
transfers
A list of the account IDs the crypto transfer occurred between and the amount that was transferred. A negative (-) sign indicates a debit to that account. The transfer list includes the transfers between the from account and to account, the transfer of the node fee, the transfer of the network fee, and the transfer of the service fee for that transaction. If the transaction was not processed, a network fee is still assessed.
token transfers
The token ID, account, and amount that was transferred to by this account in this transaction. This will not be listed if it did not occur in the transaction
assessed custom fees
The fees that were charged for a custom fee token transfer
links.next
A hyperlink to the next page of responses
Optional Filtering
lt
(less than)
/api/v1/transactions?account.id=lt:0.0.1000
Returns account.id transactions less than 1,000
lte
(less than or equal to)
/api/v1/transactions?account.id=lte:0.0.1000
Returns account.id transactions less than or equal to 1,000
gt
(greater than)
/api/v1/transactions?account.id=gt:0.0.1000
Returns account.id transactions greater than 1,000
gte
(greater than or equal to)
api/v1/transactions?account.id=gte:0.0.1000
Returns account.id transactions greater than or equal to 1,000
order
(order asc
or desc
values)
/api/v1/transactions?order=asc
/api/v1/transactions?order=desc
Lists transactions in ascending order Lists transactions descending order
Note: It is recommended that the account.id query should not select no more than 1000 accounts in a query. If the range specified in the query results in selecting more than 1000 accounts, the API will automatically only search for the first 1000 accounts that match the query in the database and return the transactions for those. For example, if you use ?account.id=gt:0.0.15000
or if you use?account.id=gt:0.0.15000&account.id=lt:0.0.30000
, then the API will only return results or some 1000 accounts in this range that match the rest of the query filters.
A single transaction can also be returned by specifying the transaction ID in the request. If a transaction was submitted to multiple nodes, the response will return entries for the successful transaction along with separate entries for the duplicate transaction(s). The "result" key indicates "success" for the node that processed the transaction and "DUPLICATE_TRANSACTION" for each additional node submission. Duplicate entries are still charged network fees.
{transaction_ID}
A specific transaction can be returned by specifying a transaction ID
Additional Examples
/api/v1/transactions/?account.id=0.0.1000
Returns transaction for account ID 1,000
/api/v1/transactions?timestamp=1565779209.711927001
Returns transactions at 1565779209 seconds and 711927001 nanoseconds
/api/v1/transactions?result=fail
Returns all transactions that have failed
/api/v1/transactions?account.id=0.0.13622&type=credit
/api/v1/transactions?account.id=0.0.13622&type=debit
Returns all transactions that deposited into an account ID 0.0.13622
Returns all transactions that withdrew from account ID 0.0.13622
/api/v1/transactions?transactionType=cryptotransfer
Returns all cryptotransfer transactions
Topics
List topic messages by id
Returns the list of topic messages for the given topic id.
/api/v1/topics/{topicId}/messages
Network entity ID in the format of shard.realm.num
0.0.2
^\d{1,10}\.\d{1,10}\.\d{1,10}$
base64
The maximum number of items to return
2
The order in which items are listed
desc
asc
, desc
2
The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
Response Details
consensus_timestamp
The consensus timestamp of the message in seconds.nanoseconds
topic_id
The ID of the topic the message was submitted to
payer_account_id
The account ID that paid for the transaction to submit the message
message
The content of the message
running_hash
The new running hash of the topic that received the message
sequence_number
The sequence number of the message relative to all other messages for the same topic
Get topic message by id and sequence number
Returns a single topic message for the given topic id and sequence number.
/api/v1/topics/{topicId}/messages/{sequenceNumber}
Network entity ID in the format of shard.realm.num
0.0.2
^\d{1,10}\.\d{1,10}\.\d{1,10}$
Topic message sequence number
2
Get topic message by consensusTimestamp
Returns a topic message the given the consensusTimestamp.
/api/v1/topics/messages/{timestamp}
The Unix timestamp in seconds.nanoseconds format, the timestamp at which the associated transaction reached consensus. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
1234567890.0000007
^\d{1,10}(.\d{1,9})?$
Tokens
List tokens
Returns a list of tokens on the network.
/api/v1/tokens
The ID of the account to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
The maximum number of items to return
2
Partial or full token name. Not allowed to be used with token.id or account.id parameter. Pagination is not supported with the use of this parameter and results are ordered by token.id with respect to the order parameter.
The order in which items are listed
desc
asc
, desc
The public key to compare against
3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be
The ID of the token to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
["ALL","FUNGIBLE_COMMON","NON_FUNGIBLE_UNIQUE"]
Response Details
token_Id
The ID of the token in x.y.z format
symbol
The symbol of the token
admin_key
The admin key for the token
type
The type of token (fungible or non-fungible)
Additional Examples
/api/v1/tokens?publickey=3c3d546321ff6f63d70 1d2ec5c277095874e19f4a235bee1e6bb19258bf362be
All tokens with matching admin key
/api/v1/tokens?account.id=0.0.8
All tokens for matching account
/api/v1/tokens?token.id=gt:0.0.1001
All tokens in range
/api/v1/tokens?order=desc
All tokens in descending order of token.id
/api/v1/tokens?limit=x
All tokens taking the first x
number of tokens
List token balances
Returns a list of token balances given the id. This represents the Token supply distribution across the network
/api/v1/tokens/{tokenId}/balances
Network entity ID in the format of shard.realm.num
0.0.2
^\d{1,10}\.\d{1,10}\.\d{1,10}$
The optional balance value to compare against
^((gte?|lte?|eq|ne)\:)?\d{1,10}$
The ID of the account to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
The account's public key to compare against
3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be
The maximum number of items to return
2
The order in which items are listed
asc
asc
, desc
The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
Response Details
timestamp
The timestamp of the recorded balances in seconds.nanoseconds
balances
The balance of the tokens in those accounts
account
The ID of the account that has the token balance
balance
The balance of the token associated with the account
Additional Examples
/api/v1/tokens/<token_id>/balances?order=asc
The balance of the token in ascending order
/api/v1/tokens/<token_id>/balances?account.id=0.0.1000
The balance of the token for account ID 0.0.1000
/api/v1/tokens/<token_id>/balances?account.balance=gt:1000
The balance for the token greater than 1000
/api/v1/tokens/<token_id>/balances?timestamp=1566562500.040961001
The token balances for the specified timestamp
Get token by id
Returns token entity information given the id
/api/v1/tokens/{tokenId}
Network entity ID in the format of shard.realm.num
0.0.2
^\d{1,10}\.\d{1,10}\.\d{1,10}$
The Unix timestamp in seconds.nanoseconds format. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
^((eq|lt|lte):)?\d{1,10}(.\d{1,9})?$
Response Details
admin_key
The token's admin key, if specified
auto_renew_account
The auto renew account ID
auto_renew_period
The period at which the auto renew account will be charged a renewal fee
created_timestamp
The timestamp of when the token was created
decimals
The number of decimal places a token is divisible by
expiry_timestamp
The epoch second at which the token should expire
freeze_default
Whether or not accounts created
fee_schedule_key
The fee schedule key, if any
freeze_key
The freeze key for the token, if specified
initial_supply
The initial supply of the token
kyc_key
The KYC key for the token, if specified
modified_timestamp
The last time the token properties were modified
name
The name of the token
supply_key
The supply key for the token, if specified
symbol
The token symbol
token_id
The token ID
total_supply
The total supply of the token
treasury_account_id
The treasury account of the token
type
whether a token is a fungible or non-fungible token
wipe_key
The wipe key for the token, if specified
custom_fees
The custom fee schedule for the token, if any
pause_key
The pause key for a token, if specified
pause_status
Whether or not the token is paused
List nfts
Returns a list of non-fungible tokens
/api/v1/tokens/{tokenId}/nfts
Network entity ID in the format of shard.realm.num
0.0.2
^\d{1,10}\.\d{1,10}\.\d{1,10}$
The ID of the account to return information for
^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
The maximum number of items to return
2
The order in which items are listed
asc
asc
, desc
The nft serial number (64 bit type). Requires a tokenId value also be populated.
^((eq|gt|gte|lt|lte):)?\d{1,19}?$
Response Details
account_id
The account ID of the account associated with the NFT
created_timestamp
The timestamp of when the NFT was created
deleted
Whether the token was deleted or not
metadata
The meta data of the NFT
modified_timestamp
The last time the token properties were modified
serial_number
The serial number of the NFT
token_id
The token ID of the NFT
Get nft info
Returns information for a non-fungible token
/api/v1/tokens/{tokenId}/nfts/{serialNumber}
Network entity ID in the format of shard.realm.num
0.0.2
^\d{1,10}\.\d{1,10}\.\d{1,10}$
The nft serial number
1
Response Details
account_id
The account ID of the account associated with the NFT
created_timestamp
The timestamp of when the NFT was created
deleted
Whether the token was deleted or not
metadata
The meta data of the NFT
modified_timestamp
The last time the token properties were modified
serial_number
The serial number of the NFT
token_id
The token ID of the NFT
Get an nfts transction history
Returns a list of transactions for a given non-fungible token
/api/v1/tokens/{tokenId}/nfts/{serialNumber}/transactions
Network entity ID in the format of shard.realm.num
0.0.2
^\d{1,10}\.\d{1,10}\.\d{1,10}$
The nft serial number
1
The maximum number of items to return
2
The order in which items are listed
asc
asc
, desc
The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
Response Details
created_timestamp
The timestamp of the transaction
id
The timestamp of the transaction
receiver_account_id
The account that received the NFT
sender_account_id
The account that sent the NFT
type
The type of transaction
token_id
The token ID of the NFT
Get the network supply
Returns the network's released supply of hbars
/api/v1/network/supply
The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.