Hedera
v1.0.0https://hedera.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
General
accounts
List account entities on network
Returns a list of all account entity items on the network.
Parameters
account.balancestringqueryThe optional balance value to compare against
account.idEntityIdQueryqueryThe ID of the account to return information for
account.publickeystringqueryThe account's public key to compare against
balancebooleantruequeryWhether 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.
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
Response
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerGet 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.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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.
transactiontypeTransactionTypesATOMICBATCHCONSENSUSCREATETOPICCONSENSUSDELETETOPICCONSENSUSSUBMITMESSAGECONSENSUSUPDATETOPICCONTRACTCALLCONTRACTCREATEINSTANCECONTRACTDELETEINSTANCECONTRACTUPDATEINSTANCECRYPTOADDLIVEHASHCRYPTOAPPROVEALLOWANCECRYPTOCREATEACCOUNTCRYPTODELETECRYPTODELETEALLOWANCECRYPTODELETELIVEHASHCRYPTOTRANSFERCRYPTOUPDATEACCOUNTETHEREUMTRANSACTIONFILEAPPENDFILECREATEFILEDELETEFILEUPDATEFREEZENODENODECREATENODEDELETENODESTAKEUPDATENODEUPDATESCHEDULECREATESCHEDULEDELETESCHEDULESIGNSYSTEMDELETESYSTEMUNDELETETOKENAIRDROPTOKENASSOCIATETOKENBURNTOKENCANCELAIRDROPTOKENCLAIMAIRDROPTOKENCREATIONTOKENDELETIONTOKENDISSOCIATETOKENFEESCHEDULEUPDATETOKENFREEZETOKENGRANTKYCTOKENMINTTOKENPAUSETOKENREJECTTOKENREVOKEKYCTOKENUNFREEZETOKENUNPAUSETOKENUPDATETOKENUPDATENFTSTOKENWIPEUNCHECKEDSUBMITUNKNOWNUTILPRNGquerytransactionsbooleantruequeryIf provided and set to false transactions will not be included in the response
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerList hooks for an account
Returns a list of hooks associated with a given account ID, alias, or EVM address.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
hook.idinteger<int64>[1, 9223372036854776000]queryThe ID of the hook
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet 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.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
serialnumberstringqueryThe nft serial number (64 bit type). Requires a tokenId value also be populated.
spender.idEntityIdQueryqueryThe ID of the spender to return information for
token.idEntityIdQueryqueryThe ID of the token to return information for
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet past staking reward payouts for an account
Returns information for all past staking reward payouts for an account.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet token relationships info for an account
Returns information for all token relationships for an account.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
token.idEntityIdQueryqueryThe ID of the token to return information for
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet crypto allowances for an account info
Returns information for all crypto allowances for an account.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
spender.idEntityIdQueryqueryThe ID of the spender to return information for
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet 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.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
spender.idEntityIdQueryqueryThe ID of the spender to return information for
token.idEntityIdQueryqueryThe ID of the token to return information for
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet non fungible token allowances for an account
Returns 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 being the parent column. The token ID value governs its order within the given account ID.
Note: The default order for this API is currently ascending. The account ID can be the owner or the spender ID depending upon the owner flag.
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 |
|---|---|---|---|---|
| account.id | eq | Y | Single occurrence only. | ?account.id=X |
| ne | N | |||
| lt(e) | Y | Single occurrence only. | ?account.id=lte:X | |
| gt(e) | Y | Single occurrence only. | ?account.id=gte:X | |
| token.id | eq | Y | Single occurrence only. Requires the presence of an account.id parameter | ?account.id=X&token.id=eq:Y |
| ne | N | |||
| lt(e) | Y | Single occurrence only. Requires the presence of an lte or eq account.id parameter | ?account.id=lte:X&token.id=lt:Y | |
| gt(e) | Y | Single occurrence only. Requires the presence of an gte or eq account.id parameter | ?account.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.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
account.idEntityIdQueryqueryThe ID of the account to return information for
token.idEntityIdQueryqueryThe ID of the token to return information for
ownerbooleantruequeryWhen the owner value is true or omitted, the accountId path parameter will specify the ID of the owner, and the API will retrieve the allowances that the owner has granted to different spenders. Conversely, when the owner value is false, the accountId path parameter will indicate the ID of the spender who has an allowance, and the API will instead provide the allowances granted to the spender by different owners of those tokens.
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerairdrops
Get outstanding token airdrops sent by an account
Returns outstanding token airdrops that have been sent by an account.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
receiver.idEntityIdQueryqueryThe ID of the receiver to return information for
serialnumberstringqueryThe nft serial number (64 bit type). Requires a tokenId value also be populated.
token.idEntityIdQueryqueryThe ID of the token to return information for
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet pending token airdrops received by an account
Returns pending token airdrops that have been received by an account.
Parameters
idOrAliasOrEvmAddressstringrequiredpathAccount alias or account id or evm address
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
sender.idEntityIdQueryqueryThe ID of the sender to return information for
serialnumberstringqueryThe nft serial number (64 bit type). Requires a tokenId value also be populated.
token.idEntityIdQueryqueryThe ID of the token to return information for
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerbalances
List account balances
Returns a list of account and token balances on the network. The latest balance information is returned when there is no timestamp query parameter, otherwise, the information is retrieved from snapshots with 15-minute granularity. 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.
Parameters
account.idstringqueryAccount id or account alias with no shard realm or evm address with no shard realm
account.balancestringqueryThe optional balance value to compare against
account.publickeystringqueryThe account's public key to compare against
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerblocks
List blocks
Returns a list of blocks on the network.
Parameters
block.numberstringqueryThe block's number
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerGet block by hash or number
Returns the block information by given hash or number.
Parameters
hashOrNumberstringrequiredpathAccepts both eth and hedera hash format or block number
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headercontracts
Invoke a smart contract
Returns a result from EVM execution such as cost-free execution of read-only smart contract queries, gas estimation, and transient simulation of read-write operations. If the estimate field is set to true gas estimation is executed. However, gas estimation only supports the latest block. When estimate is false, it can process calls against the earliest block and specific historical blocks when a hexadecimal or decimal block number is provided in the block field for eth_call operations. Link to Supported/Unsupported Operations Table
The operations types which are not currently supported should return 501 error status.
Body
blockstring | nullHexadecimal block number or the string "latest", "pending", "earliest". Defaults to "latest".
datastring<binary> | nullHexadecimal method signature and encoded parameters. Up to 131072 bytes as at most 262146 hexadecimal digits including optional leading 0x.
estimateboolean | nullWhether gas estimation is called. Defaults to false.
fromstring<binary> | nullThe 20-byte hexadecimal EVM address the transaction is sent from.
gasinteger<int64> | null>= 0Gas provided for the transaction execution. Defaults to 15000000.
gasPriceinteger<int64> | null>= 0Gas price used for each paid gas.
tostring<binary>requiredThe 20-byte hexadecimal EVM address the transaction is directed to.
valueinteger<int64> | null>= 0Value sent with this transaction. Defaults to 0.
Response
OK
Validation error
Not found error
Unsupported media type error
Too many requests
Generic error
Not implemented error
Authorization
api-keyAuthapiKey in headerList contract entities on network
Returns a list of all contract entity items on the network.
Parameters
contract.idstringqueryThe ID of the smart contract
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
Response
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerGet contract by id
Return the contract information given an id
Parameters
contractIdOrAddressstringrequiredpathThe ID or hex encoded EVM address (with or without 0x prefix) associated with this contract.
timestampArray<string>queryThe 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
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerList contract results from a contract on the network
Returns a list of all ContractResults for a contract's function executions.
Parameters
contractIdOrAddressstringrequiredpathThe ID or hex encoded EVM address (with or without 0x prefix) associated with this contract.
block.hashstringqueryThe block's hash. If multiple values are provided the last value will be the only value used.
block.numberstringqueryThe block's number
fromstringqueryAccount ID or EVM address executing the contract
internalbooleanfalsequeryWhether to include child transactions or not
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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.
transaction.indexinteger<int32>>= 0queryThe transaction index in the block
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerThe contract state from a contract on the network
Returns a list of all contract's slots. If no timestamp is provided, returns the current state.
Parameters
contractIdOrAddressstringrequiredpathThe ID or hex encoded EVM address (with or without 0x prefix) associated with this contract.
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
slotstringqueryThe slot's number
timestampArray<string>queryThe consensus timestamp of the contract state 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
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet the contract result from a contract on the network executed at a given timestamp
Returns a single ContractResult for a contract's function executions at a specific timestamp.
Parameters
contractIdOrAddressstringrequiredpathThe ID or hex encoded EVM address (with or without 0x prefix) associated with this contract.
timestampstringrequiredpathThe 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.
Response
OK
Partial Content
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerList contract results from all contracts on the network
Returns a list of all ContractResults for all contract's function executions.
Parameters
fromstringqueryAccount ID or EVM address executing the contract
block.hashstringqueryThe block's hash. If multiple values are provided the last value will be the only value used.
block.numberstringqueryThe block's number
internalbooleanfalsequeryWhether to include child transactions or not
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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.
transaction.indexinteger<int32>>= 0queryThe transaction index in the block
Response
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerGet the contract result from a contract on the network for a given transactionId or ethereum transaction hash
Returns a single ContractResult for a contract's function executions for a given transactionId or ethereum transaction hash.
Parameters
transactionIdOrHashstringrequiredpathTransaction Id or a 32 byte hash with optional 0x prefix
nonceinteger<int32>>= 00queryFilter 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. Default is 0 when not specified.
Response
OK
Partial Content
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet the contract actions from a contract on the network for a given transactionId or ethereum transaction hash
Returns a list of ContractActions for a contract's function executions for a given transactionId or ethereum transaction hash.
Parameters
transactionIdOrHashstringrequiredpathTransaction Id or a 32 byte hash with optional 0x prefix
indexstringqueryThe index of a contract action
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet the opcode traces for a historical transaction on the network with the given transaction ID or hash
Re-executes a transaction and returns a result containing detailed information for the execution, including all values from the {@code stack}, {@code memory} and {@code storage} and the entire trace of opcodes that were executed during the replay.
Note that to provide the output, the transaction needs to be re-executed on the EVM, which may take a significant amount of time to complete if stack and memory information is requested.
Parameters
transactionIdOrHashstringrequiredpathTransaction Id or a 32 byte hash with optional 0x prefix
stackbooleantruequeryIf provided and set to false, stack information will not be included in the response
memorybooleanfalsequeryIf provided and set to true, memory information will be included in the response
storagebooleanfalsequeryIf provided and set to true, storage information will be included in the response
Response
OK
Validation error
Transaction or record file not found
Too many requests
Authorization
api-keyAuthapiKey in headerList contract logs from a contract on the network
Search the logs of a specific contract across multiple contract calls. Chained logs are not
included but can be found by calling /api/v1/contracts/{contractId}/results/{timestamp}
or /api/v1/contracts/results/{transactionId}. When searching by topic a timestamp parameter must be supplied
and span a time range of at most seven days.
Ordering
The order is governed by the combination of timestamp and index values. If the index param is omitted, the order is determined by the timestamp only.
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 endpoint
| Query Param | Comparison Operator | Support | Description | Example |
|---|---|---|---|---|
| index | eq | Y | Single occurrence only. Requires the presence of timestamp | ?index=X |
| ne | N | |||
| lt(e) | Y | Single occurrence only. Requires the presence of timestamp | ?index=lte:X | |
| gt(e) | Y | Single occurrence only. Requires the presence of timestamp | ?index=gte:X | |
| timestamp | eq | Y | Single occurrence only. | ?timestamp=Y |
| ne | N | |||
| lt(e) | Y | Single occurrence only. Optional second timestamp gt(e) | ?timestamp=lte:Y | |
| gt(e) | Y | Single occurrence only. Optional second timestamp lt(e) | ?timestamp=gte:Y |
Both filters must be a single occurrence of gt(e) or lt(e) which provide a lower and or upper boundary for search.
Parameters
contractIdOrAddressstringrequiredpathThe ID or hex encoded EVM address (with or without 0x prefix) associated with this contract.
indexstringqueryContract log index
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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.
topic0Array<string>queryThe first topic associated with a contract log. Requires a timestamp range also be populated.
topic1Array<string>queryThe second topic associated with a contract log. Requires a timestamp range also be populated.
topic2Array<string>queryThe third topic associated with a contract log. Requires a timestamp range also be populated.
topic3Array<string>queryThe fourth topic associated with a contract log. Requires a timestamp range also be populated.
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerList contracts logs across many contracts on the network
Search the logs across many contracts with multiple contract calls. Chained logs are not
included but can be found by calling /api/v1/contracts/{contractId}/results/{timestamp}
or /api/v1/contracts/results/{transactionId}. When searching by topic a timestamp parameter must be supplied
and span a time range of at most seven days.
Ordering
The order is governed by the combination of timestamp and index values. If the index param is omitted, the order is determined by the timestamp only.
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 endpoint
| Query Param | Comparison Operator | Support | Description | Example |
|---|---|---|---|---|
| index | eq | Y | Single occurrence only. Requires the presence of timestamp | ?index=X |
| ne | N | |||
| lt(e) | Y | Single occurrence only. Requires the presence of timestamp | ?index=lte:X | |
| gt(e) | Y | Single occurrence only. Requires the presence of timestamp | ?index=gte:X | |
| timestamp | eq | Y | Single occurrence only. | ?timestamp=Y |
| ne | N | |||
| lt(e) | Y | Single occurrence only. Optional second timestamp gt(e) | ?timestamp=lte:Y | |
| gt(e) | Y | Single occurrence only. Optional second timestamp lt(e) | ?timestamp=gte:Y |
Both filters must be a single occurrence of gt(e) or lt(e) which provide a lower and or upper boundary for search.
Parameters
indexstringqueryContract log index
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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.
topic0Array<string>queryThe first topic associated with a contract log. Requires a timestamp range also be populated.
topic1Array<string>queryThe second topic associated with a contract log. Requires a timestamp range also be populated.
topic2Array<string>queryThe third topic associated with a contract log. Requires a timestamp range also be populated.
topic3Array<string>queryThe fourth topic associated with a contract log. Requires a timestamp range also be populated.
transaction.hashstringqueryA hex encoded 32-byte ethereum transaction hash or 48-byte hedera transaction hash.
Response
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headernetwork
Get the network exchange rate to estimate costs
Returns the network's exchange rate, current and next.
Parameters
timestampArray<string>queryThe 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
OK
Invalid parameter
Not Found
Service Unavailable
Authorization
api-keyAuthapiKey in headerGet the network fees
Returns the estimated gas in tinybars per each transaction type. Default order is ASC. Currently only ContractCall, ContractCreate and EthereumTransaction transaction types are supported.
Parameters
orderanyascdescascqueryThe order in which items are listed
timestampArray<string>queryThe 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
OK
Invalid parameter
Not Found
Service Unavailable
Authorization
api-keyAuthapiKey in headerGet the network address book nodes
Returns the network's list of nodes used in consensus
Parameters
file.idEntityIdQueryqueryThe ID of the file entity
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
node.idstringqueryThe ID of the node
orderanyascdescascqueryThe order in which items are listed
Response
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerGet network stake information
Returns the network's current stake information.
Response
OK
Invalid parameter
No network stake data found
Service Unavailable
Authorization
api-keyAuthapiKey in headerGet the network supply
Returns the network's released supply of hbars
Parameters
timestampArray<string>queryThe 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
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerschedules
List schedules entities
Lists schedules on the network that govern the execution logic of scheduled transactions. This includes executed and non executed schedules.
Parameters
account.idEntityIdQueryqueryThe ID of the account to return information for
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
schedule.idEntityIdQueryqueryThe ID of the schedule to return information for
Response
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerGet schedule by id
Returns schedule information based on the given schedule id
Parameters
scheduleIdEntityId | nullrequiredpathSchedule id
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headertransactions
List transactions
Lists transactions on the network. This includes successful and unsuccessful transactions.
Parameters
account.idEntityIdQueryqueryThe ID of the account to return information for
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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.
transactiontypeTransactionTypesATOMICBATCHCONSENSUSCREATETOPICCONSENSUSDELETETOPICCONSENSUSSUBMITMESSAGECONSENSUSUPDATETOPICCONTRACTCALLCONTRACTCREATEINSTANCECONTRACTDELETEINSTANCECONTRACTUPDATEINSTANCECRYPTOADDLIVEHASHCRYPTOAPPROVEALLOWANCECRYPTOCREATEACCOUNTCRYPTODELETECRYPTODELETEALLOWANCECRYPTODELETELIVEHASHCRYPTOTRANSFERCRYPTOUPDATEACCOUNTETHEREUMTRANSACTIONFILEAPPENDFILECREATEFILEDELETEFILEUPDATEFREEZENODENODECREATENODEDELETENODESTAKEUPDATENODEUPDATESCHEDULECREATESCHEDULEDELETESCHEDULESIGNSYSTEMDELETESYSTEMUNDELETETOKENAIRDROPTOKENASSOCIATETOKENBURNTOKENCANCELAIRDROPTOKENCLAIMAIRDROPTOKENCREATIONTOKENDELETIONTOKENDISSOCIATETOKENFEESCHEDULEUPDATETOKENFREEZETOKENGRANTKYCTOKENMINTTOKENPAUSETOKENREJECTTOKENREVOKEKYCTOKENUNFREEZETOKENUNPAUSETOKENUPDATETOKENUPDATENFTSTOKENWIPEUNCHECKEDSUBMITUNKNOWNUTILPRNGqueryresultanysuccessfailqueryThe transaction success type.
typeanycreditdebitqueryThe transaction account balance modification type.
Response
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerGet transaction by id
Returns transaction information based on the given transaction id
Parameters
transactionIdstringrequiredpathTransaction id
nonceinteger<int32>>= 0queryFilter 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.
scheduledbooleanqueryFilter 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
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headertopics
Get topic by ID
Returns the topic details for the given topic ID.
Parameters
topicIdEntityId | nullrequiredpathTopic id
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerList topic messages by id
Returns the list of topic messages for the given topic id.
Parameters
topicIdEntityId | nullrequiredpathTopic id
encodingstringquerylimitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescascqueryThe order in which items are listed
sequencenumberinteger<int64>>= 0querytimestampArray<string>queryThe 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
OK
Invalid parameter
Topic Not Found
Authorization
api-keyAuthapiKey in headerGet topic message by id and sequence number
Returns a single topic message for the given topic id and sequence number.
Parameters
topicIdEntityId | nullrequiredpathTopic id
sequenceNumberinteger<int64>>= 0requiredpathTopic message sequence number
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet topic message by consensusTimestamp
Returns a topic message the given the consensusTimestamp.
Parameters
timestampstringrequiredpathThe 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.
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headertokens
List tokens
Returns a list of tokens on the network.
Parameters
account.idEntityIdQueryqueryThe ID of the account to return information for
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
namestringqueryPartial 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.
orderanyascdescascqueryThe order in which items are listed
publickeystringqueryThe public key to compare against
token.idEntityIdQueryqueryThe ID of the token to return information for
typeArray<string>queryResponse
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerGet token by id
Returns token entity information given the id
Parameters
tokenIdEntityId | nullrequiredpathToken id
timestampstringqueryThe 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.
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerList token balances
Returns a list of token balances given the id. This represents the Token supply distribution across the network
Parameters
tokenIdEntityId | nullrequiredpathToken id
account.balancestringqueryThe optional balance value to compare against
account.idEntityIdQueryqueryThe ID of the account to return information for
account.publickeystringqueryThe account's public key to compare against
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerList nfts
Returns a list of non-fungible tokens
Parameters
tokenIdEntityId | nullrequiredpathToken id
account.idEntityIdQueryqueryThe ID of the account to return information for
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
serialnumberstringqueryThe nft serial number (64 bit type). Requires a tokenId value also be populated.
Response
OK
Invalid parameter
Authorization
api-keyAuthapiKey in headerGet nft info
Returns information for a non-fungible token
Parameters
tokenIdEntityId | nullrequiredpathToken id
serialNumberinteger<int64>[1, 9223372036854776000]1requiredpathThe nft serial number
Response
OK
Invalid parameter
Not Found
Authorization
api-keyAuthapiKey in headerGet an nfts transction history
Returns a list of transactions for a given non-fungible token
Parameters
tokenIdEntityId | nullrequiredpathToken id
serialNumberinteger<int64>[1, 9223372036854776000]1requiredpathThe nft serial number
limitinteger<int32>[1, 100]25queryThe maximum number of items to return
orderanyascdescdescqueryThe order in which items are listed
timestampArray<string>queryThe 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
OK
Partial Content
Invalid parameter
Authorization
api-keyAuthapiKey in header