Hiero (Hedera Mirror Node)

Mirror Node REST API

The REST API offers the ability to query transactions and entity information from a mirror node. Base url: [/api/v1](/api/v1) OpenAPI Spec:…

Finance & banking#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The REST API offers the ability to query transactions and entity information from a mirror node.

Base url: /api/v1

OpenAPI Spec: /api/v1/docs/openapi.yml

Endpoints 49

accounts

  • GETList account entities on network/api/v1/accountsReturns a list of all account entity items on the network.
  • GETGet account by alias, id, or evm address/api/v1/accounts/:idOrAliasOrEvmAddressReturn 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…
  • GETList hooks for an account/api/v1/accounts/:idOrAliasOrEvmAddress/hooksReturns a list of hooks associated with a given account ID, alias, or EVM address.
  • GETGet hook storage slots/api/v1/accounts/:idOrAliasOrEvmAddress/hooks/:hookId/storageReturns a list of hook storage slots associated with a given hook.
  • GETGet nfts for an account info/api/v1/accounts/:idOrAliasOrEvmAddress/nftsReturns information for all non-fungible tokens for an account. Ordering When considering NFTs, their order is governed by a combination of their numerical…
  • GETGet past staking reward payouts for an account/api/v1/accounts/:idOrAliasOrEvmAddress/rewardsReturns information for all past staking reward payouts for an account.
  • GETGet token relationships info for an account/api/v1/accounts/:idOrAliasOrEvmAddress/tokensReturns information for all token relationships for an account.
  • GETGet crypto allowances for an account info/api/v1/accounts/:idOrAliasOrEvmAddress/allowances/cryptoReturns information for all crypto allowances for an account.
  • GETGet fungible token allowances for an account/api/v1/accounts/:idOrAliasOrEvmAddress/allowances/tokensReturns 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,…
  • GETGet non fungible token allowances for an account/api/v1/accounts/:idOrAliasOrEvmAddress/allowances/nftsReturns an account's non-fungible token allowances. Ordering The order is governed by a combination of the account ID and the token ID values, with account ID…

balances

  • GETList account balances/api/v1/balancesReturns a list of account and token balances on the network. The latest balance information is returned when there is no timestamp query parameter, otherwise,…

contracts

  • POSTInvoke a smart contract/api/v1/contracts/callReturns a result from EVM execution such as cost-free execution of read-only smart contract queries, gas estimation, and transient simulation of read-write…
  • GETList contract entities on network/api/v1/contractsReturns a list of all contract entity items on the network.
  • GETGet contract by id/api/v1/contracts/:contractIdOrAddressReturn the contract information given an id
  • GETList contract results from a contract on the network/api/v1/contracts/:contractIdOrAddress/resultsReturns a list of all ContractResults for a contract's function executions.
  • GETThe contract state from a contract on the network/api/v1/contracts/:contractIdOrAddress/stateReturns a list of all contract's slots. If no timestamp is provided, returns the current state.
  • GETGet the contract result from a contract on the network executed at a given timestamp/api/v1/contracts/:contractIdOrAddress/results/:timestampReturns a single ContractResult for a contract's function executions at a specific timestamp.
  • GETList contract results from all contracts on the network/api/v1/contracts/resultsReturns a list of all ContractResults for all contract's function executions.
  • GETGet the contract result from a contract on the network for a given transactionId or ethereum transaction hash/api/v1/contracts/results/:transactionIdOrHashReturns a single ContractResult for a contract's function executions for a given transactionId or ethereum transaction hash.
  • GETGet the contract actions from a contract on the network for a given transactionId or ethereum transaction hash/api/v1/contracts/results/:transactionIdOrHash/actionsReturns a list of ContractActions for a contract's function executions for a given transactionId or ethereum transaction hash.
  • GETGet the opcode traces for a historical transaction on the network with the given transaction ID or hash/api/v1/contracts/results/:transactionIdOrHash/opcodesRe-executes a transaction and returns a result containing detailed information for the execution, including all values from the {@code stack}, {@code memory}…
  • GETGet the account traces for a historical transaction on the network with the given transaction ID or hash/api/v1/contracts/results/:transactionIdOrHash/prestateInspects contract result related data for a transaction and returns a response containing detailed information for the accounts needed for the transaction…
  • GETList contract logs from a contract on the network/api/v1/contracts/:contractIdOrAddress/results/logsSearch the logs of a specific contract across multiple contract calls. Chained logs are not included but can be found by calling…
  • GETList contracts logs across many contracts on the network/api/v1/contracts/results/logsSearch the logs across many contracts with multiple contract calls. Chained logs are not included but can be found by calling…

schedules

  • GETList schedules entities/api/v1/schedulesLists schedules on the network that govern the execution logic of scheduled transactions. This includes executed and non executed schedules.
  • GETGet schedule by id/api/v1/schedules/:scheduleIdReturns schedule information based on the given schedule id

transactions

  • GETList transactions/api/v1/transactionsLists transactions on the network. This includes successful and unsuccessful transactions.
  • GETGet transaction by id/api/v1/transactions/:transactionIdReturns transaction information based on the given transaction id

topics

  • GETGet topic by ID/api/v1/topics/:topicIdReturns the topic details for the given topic ID.
  • GETList topic messages by id/api/v1/topics/:topicId/messagesReturns the list of topic messages for the given topic id.
  • GETGet topic message by id and sequence number/api/v1/topics/:topicId/messages/:sequenceNumberReturns a single topic message for the given topic id and sequence number.
  • GETGet topic message by consensusTimestamp/api/v1/topics/messages/:timestampReturns a topic message the given the consensusTimestamp.

tokens

  • GETList tokens/api/v1/tokensReturns a list of tokens on the network.
  • GETGet token by id/api/v1/tokens/:tokenIdReturns token entity information given the id
  • GETList token balances/api/v1/tokens/:tokenId/balancesReturns a list of token balances given the id. This represents the Token supply distribution across the network
  • GETList nfts/api/v1/tokens/:tokenId/nftsReturns a list of non-fungible tokens
  • GETGet nft info/api/v1/tokens/:tokenId/nfts/:serialNumberReturns information for a non-fungible token
  • GETGet an nfts transction history/api/v1/tokens/:tokenId/nfts/:serialNumber/transactionsReturns a list of transactions for a given non-fungible token

airdrops

  • GETGet outstanding token airdrops sent by an account/api/v1/accounts/:idOrAliasOrEvmAddress/airdrops/outstandingReturns outstanding token airdrops that have been sent by an account.
  • GETGet pending token airdrops received by an account/api/v1/accounts/:idOrAliasOrEvmAddress/airdrops/pendingReturns pending token airdrops that have been received by an account.

blocks

  • GETList blocks/api/v1/blocksReturns a list of blocks on the network.
  • GETGet block by hash or number/api/v1/blocks/:hashOrNumberReturns the block information by given hash or number.

network

  • GETGet the network exchange rate to estimate costs/api/v1/network/exchangerateReturns the network's exchange rate, current and next.
  • GETGet the network fees/api/v1/network/feesReturns the estimated gas in tinybars per each transaction type. Default order is ASC. Currently only ContractCall, ContractCreate and EthereumTransaction…
  • POSTEstimate network fees/api/v1/network/feesGiven a HAPI transaction, estimate the network fees in tinycents.
  • GETGet the network address book nodes/api/v1/network/nodesReturns the network's list of nodes used in consensus
  • GETGet registered nodes/api/v1/network/registered-nodesReturns the list of registered nodes
  • GETGet network stake information/api/v1/network/stakeReturns the network's current stake information.
  • GETGet the network supply/api/v1/network/supplyReturns the network's released supply of hbars

API details

Authentication
None declared in the description
Operations
49 operations on 48 pathsGET 47POST 2
Main resources
contracts 13accounts 10network 7tokens 6topics 4airdrops 2blocks 2schedules 2transactions 2balances 1
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 0.168.0-SNAPSHOT

How to test the Mirror Node REST API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Mirror Node REST API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List account entities on network” (GET /api/v1/accounts), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Mirror Node REST API?

The REST API offers the ability to query transactions and entity information from a mirror node. Base url: [/api/v1](/api/v1) OpenAPI Spec:… It is listed under Finance & banking and has 49 endpoints.

Who publishes the Mirror Node REST API?

It is listed from Hiero (Hedera Mirror Node)'s public API description (an OpenAPI document), not published by Hiero (Hedera Mirror Node) on Swastik Codes. Anyone who controls hiero.org can claim the profile by adding a DNS TXT record.

How do I authenticate with the Mirror Node REST API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Mirror Node REST API have?

49 operations on 48 paths (47 GET, 2 POST). The largest groups are contracts, accounts, network, tokens.

Is forking the Mirror Node REST API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.