# Table of Contents - [Mirror Node REST API | Hedera](#mirror-node-rest-api-hedera) - [Blocks | Hedera](#blocks-hedera) - [Balances | Hedera](#balances-hedera) - [Schedule Transactions | Hedera](#schedule-transactions-hedera) - [Topics | Hedera](#topics-hedera) - [Accounts | Hedera](#accounts-hedera) - [Transactions | Hedera](#transactions-hedera) - [Tokens | Hedera](#tokens-hedera) - [Smart Contracts | Hedera](#smart-contracts-hedera) - [Network | Hedera](#network-hedera) --- # Mirror Node REST API | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api#overview) Overview -------------------------------------------------------------------------------- The **Hedera Mirror Node REST API** enables developers to access historical transaction data from Hedera's mainnet, testnet, and previewnet. Each transaction generates a record stored in a record file, which can be accessed via the Mirror Node REST APIs. * * * [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api#making-a-request) Making a Request ------------------------------------------------------------------------------------------------ To make a request, use the network endpoint and the REST API of choice. For example, To get a list of transactions on the **Hedera mainnet**, use the following API endpoint: Copy https://mainnet.mirrornode.hedera.com/api/v1/transactions This will return a JSON response containing transaction details such as transaction ID, timestamps, and fees. If you are using `curl`, you can make a request like this: Copy curl -X GET "https://mainnet.mirrornode.hedera.com/api/v1/transactions" -H "Accept: application/json" * * * [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api#hedera-mirror-node-swagger-ui-environments) Hedera Mirror Node Swagger UI Environments ---------------------------------------------------------------------------------------------------------------------------------------------------- Hedera provides interactive Swagger UI for its Mirror Node REST API. Developers can use these environments to explore available endpoints, check request parameters, and test API calls without writing code. #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api#available-environments) **Available Environments:** Network Swagger UI URL **Mainnet** [Mainnet Swagger UI](https://mainnet.mirrornode.hedera.com/api/v1/docs/) **Testnet** [Testnet Swagger UI](https://testnet.mirrornode.hedera.com/api/v1/docs/) **Previewnet** [Previewnet Swagger UI](https://previewnet.mirrornode.hedera.com/api/v1/docs/) * * * [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api#hedera-mirror-node-environments) **Hedera Mirror Node Environments** ---------------------------------------------------------------------------------------------------------------------------------- Hedera provides three different network environments for interacting with the Mirror Node API. Network Base URL **Mainnet** `https://mainnet.mirrornode.hedera.com/` **Testnet** `https://testnet.mirrornode.hedera.com/` **Previewnet** `https://previewnet.mirrornode.hedera.com/` Each of these base URLs serves as the foundation for all API calls. #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api#community-providers) Community Providers You may also check out these community providers as alternatives: * [**LinkPool**](https://linkpool.com/) * `https://hedera-mirror.linkpool.pro/` * [**Validation Cloud**](https://validationcloud.io/) * `https://mainnet.hedera.validationcloud.io/` * [**DragonGlass**](https://app.dragonglass.me/hedera/pricing) * `https://api.dragonglass.me/hedera/` 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. [PreviousLocal Provider](https://docs.hedera.com/hedera/sdks-and-apis/sdks/signature-provider/local-provider) [NextAccounts](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts) Last updated 2 months ago Was this helpful? --- # Blocks | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/blocks#overview) Overview --------------------------------------------------------------------------------------- The **Block endpoints** in the Hedera Mirror Node REST API allows developers to query **block data** on the Hedera network. These endpoints are essential for retrieving block metadata, including hashes, timestamps, and transactions within blocks. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/blocks#endpoints) Endpoints ----------------------------------------------------------------------------------------- The following Block endpoints are available: **Endpoint** **Description** `GET /api/v1/blocks` Retrieves a list of blocks on the network. `GET /api/v1/blocks/{hash_or_number}` Fetches details of a specific block by hash or block number. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/blocks#blocks) Blocks ----------------------------------------------------------------------------------- ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/blocks#get-api-v1-blocks) List blocks get /api/v1/blocks Returns a list of blocks on the network. Query parameters block.numberstringOptional The block's number Example: `{"summary":"--","value":""}`Pattern: `^((eq|gt|gte|lt|lte):)?\d{1,19}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/blocks HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/blocks HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "blocks": [\ {\ "count": 3,\ "gas_used": 300000,\ "hapi_version": "0.11.0",\ "hash": "0x3c08bbbee74d287b1dcd3f0ca6d1d2cb92c90883c4acf9747de9f3f3162ad25b999fc7e86699f60f2a3fb3ed9a646c6b",\ "logs_bloom": "0x00000020002000001000000000000000000000000000000000000000000010000000000004000000000000000000000000108000000000000000000080000000000004000000000000000000000000880000000000000000000101000000000000000000000000000000000000008000000000000400000080000000000001000000000000000000000000000000000000000000002000000000100000100000200000040000100000001000000000000000000000000000000001001000004000000000000000000001000000000000000000100000000000100000000000000000000000000000000000000000000000080000100800000000000000120080",\ "name": "2022-05-03T06_46_26.060890949Z.rcd",\ "number": 77,\ "previous_hash": "0xf7d6481f659c866c35391ee230c374f163642ebf13a5e604e04a95a9ca48a298dc2dfa10f51bcbaab8ae23bc6d662a0b",\ "size": 8192,\ "timestamp": {\ "from": "1651560386.060890949",\ "to": "1651560386.661997287"\ }\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/blocks#get-api-v1-blocks-hashornumber) Get block by hash or number get /api/v1/blocks/{hashOrNumber} Returns the block information by given hash or number. Path parameters hashOrNumberstringRequired Accepts both eth and hedera hash format or block number Pattern: `^(\d{1,10}|(0x)?([A-Fa-f0-9]{64}|[A-Fa-f0-9]{96}))$` Responses 200 OK application/json ResponseobjectExample: `{"count":3,"gas_used":300000,"hapi_version":"0.11.0","hash":"0x3c08bbbee74d287b1dcd3f0ca6d1d2cb92c90883c4acf9747de9f3f3162ad25b999fc7e86699f60f2a3fb3ed9a646c6b","logs_bloom":"0x00000020002000001000000000000000000000000000000000000000000010000000000004000000000000000000000000108000000000000000000080000000000004000000000000000000000000880000000000000000000101000000000000000000000000000000000000008000000000000400000080000000000001000000000000000000000000000000000000000000002000000000100000100000200000040000100000001000000000000000000000000000000001001000004000000000000000000001000000000000000000100000000000100000000000000000000000000000000000000000000000080000100800000000000000120080","name":"2022-05-03T06_46_26.060890949Z.rcd","number":77,"previous_hash":"0xf7d6481f659c866c35391ee230c374f163642ebf13a5e604e04a95a9ca48a298dc2dfa10f51bcbaab8ae23bc6d662a0b","size":8192,"timestamp":{"from":"1651560386.060890949","to":"1651560386.661997287"}}` Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/blocks/{hashOrNumber} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/blocks/{hashOrNumber} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "count": 3, "gas_used": 300000, "hapi_version": "0.11.0", "hash": "0x3c08bbbee74d287b1dcd3f0ca6d1d2cb92c90883c4acf9747de9f3f3162ad25b999fc7e86699f60f2a3fb3ed9a646c6b", "logs_bloom": "0x00000020002000001000000000000000000000000000000000000000000010000000000004000000000000000000000000108000000000000000000080000000000004000000000000000000000000880000000000000000000101000000000000000000000000000000000000008000000000000400000080000000000001000000000000000000000000000000000000000000002000000000100000100000200000040000100000001000000000000000000000000000000001001000004000000000000000000001000000000000000000100000000000100000000000000000000000000000000000000000000000080000100800000000000000120080", "name": "2022-05-03T06_46_26.060890949Z.rcd", "number": 77, "previous_hash": "0xf7d6481f659c866c35391ee230c374f163642ebf13a5e604e04a95a9ca48a298dc2dfa10f51bcbaab8ae23bc6d662a0b", "size": 8192, "timestamp": { "from": "1651560386.060890949", "to": "1651560386.661997287" } } [PreviousBalances](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances) [NextSchedule Transactions](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions) Last updated 2 months ago Was this helpful? --- # Balances | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances#overview) Overview ----------------------------------------------------------------------------------------- The **Balances endpoints** in the Hedera Mirror Node REST API allows developers to query **account balances** on the Hedera network. These endpoints provides real-time and historical balance data, essential for wallets, explorers, and financial applications. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances#endpoints) Endpoints ------------------------------------------------------------------------------------------- The following endpoint is available for the Balances object: **Endpoint** **Description** `GET /api/v1/balances` Retrieves a list of account balances. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances#balances) 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 HBAR. Balances are checked on a periodic basis and thus return the most recent snapshot of time captured prior to the request. The **balance object** represents the balance of accounts on the Hedera network. It allows you to retrieve the **most recent** snapshot of all account balances on the network at a given time. Since balances are updated periodically, the returned values reflect the latest recorded state before the request. Each **balance object** includes: * **Account ID** – The Hedera account being queried. * **Balance (in HBAR)** – The most recent balance available. * **Token Balances (if applicable)** – Associated token balances for the account. #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances#note) Note Balance information returned by this API has a 15 minute granularity when using the `timestamp` query parameter, as it's generated by an asynchronous balance snapshot process. When not using the `timestamp` parameter, the API returns real-time balance data. ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances#get-api-v1-balances) List account balances get /api/v1/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. Query parameters account.idstringOptional Account id or account alias with no shard realm or evm address with no shard realm Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` account.balancestringOptional The optional balance value to compare against Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?\d{1,10}$` account.publickeystringOptional The account's public key to compare against Example: `3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/balances HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/balances HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "timestamp": "1586567700.453054000", "balances": [\ {\ "account": "0.15.10",\ "balance": 80,\ "tokens": [\ {\ "token_id": "0.0.200001",\ "balance": 8\ }\ ]\ }\ ], "links": { "next": null } } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances#response-details-1) Response Details Response Item Description **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 #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances#optional-filtering-1) Optional Filtering Operator Example Description `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 #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances#additional-examples) Additional Examples Example Requests Description `/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 [PreviousAccounts](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts) [NextBlocks](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/blocks) Last updated 2 months ago Was this helpful? --- # Schedule Transactions | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions#overview) Overview ------------------------------------------------------------------------------------------------------ The **Scheduled Transactions endpoints** in the Hedera Mirror Node REST API allows developers to query **scheduled transactions** on the Hedera network. These endpoints are essential for tracking transaction scheduling, execution status, and metadata related to scheduled transactions. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions#endpoints) Endpoints -------------------------------------------------------------------------------------------------------- The following endpoints are available for the Scheduled Transactions object: **Endpoint** **Description** `GET /api/v1/schedules` Retrieves a list of scheduled transactions on the network. `GET /api/v1/schedules/{id}` Fetches details of a specific scheduled transaction by ID. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions#schedule-transactions) Schedule Transactions -------------------------------------------------------------------------------------------------------------------------------- ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions#get-api-v1-schedules) List schedules entities get /api/v1/schedules Lists schedules on the network that govern the execution logic of scheduled transactions. This includes executed and non executed schedules. Query parameters account.idstringOptional The ID of the account to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` schedule.idstringOptional The ID of the schedule to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/schedules HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/schedules HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "schedules": [\ {\ "admin_key": {\ "_type": "ProtobufEncoded",\ "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"\ },\ "consensus_timestamp": "1586567700.453054000",\ "creator_account_id": "0.0.2",\ "deleted": false,\ "executed_timestamp": "1586567700.453054000",\ "expiration_time": "1586567700.453054000",\ "memo": "created on 02/10/2021",\ "payer_account_id": "0.0.2",\ "schedule_id": "0.0.2",\ "signatures": [\ {\ "consensus_timestamp": "1586567700.453054000",\ "public_key_prefix": "AAEBAwuqAwzB",\ "signature": "3q2+7wABAQMLqgMMwQ==",\ "type": "ED25519"\ }\ ],\ "transaction_body": "Kd6tvu8=",\ "wait_for_expiry": true\ }\ ], "links": { "next": null } } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions#response-details-1) Response Details Response Item Description **schedules** List of schedules **admin\_key** The admin key on the schedule **admin\_key\_type** The type of key **admin\_key\_key** The admin public key **consensus\_timestamp** The consensus timestamp of when the schedule was created **creator\_account\_id** The account ID of the creator of the schedule **executed\_timestamp** The timestamp at which the transaction that was scheduled was executed at **memo** A string of characters associated with the memo if set **payer\_account\_id** The account ID of the account paying for the execution of the transaction **schedule\_id** The ID of the schedule entity **signatures** The list of keys that signed the transaction **signatures.public\_key\_prefix** The signatures public key prefix **signatures.signature** The signature of the key that signed the schedule transaction **signatures.type** The type of signature (ED5519 or ECDSA) **transaction\_body** The transaction body of the transaction that was scheduled. The transaction body is base64 encoded binary protobuf data. Deserialize the data by using the [ScheduleableTransactionBody](https://github.com/hashgraph/hedera-protobufs/blob/main/services/schedulable_transaction_body.proto) proto parser. **wait\_for\_expiry** Whether or not the schedule transaction specified a specific time to expire by **links.next** Hyperlink to the next page of results ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions#get-api-v1-schedules-scheduleid) Get schedule by id get /api/v1/schedules/{scheduleId} Returns schedule information based on the given schedule id Path parameters scheduleIdstring | nullableRequired Network entity ID in the format of `shard.realm.num` Example: `0.0.2`Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/schedules/{scheduleId} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/schedules/{scheduleId} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "admin_key": { "_type": "ProtobufEncoded", "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743" }, "consensus_timestamp": "1586567700.453054000", "creator_account_id": "0.0.2", "deleted": false, "executed_timestamp": "1586567700.453054000", "expiration_time": "1586567700.453054000", "memo": "created on 02/10/2021", "payer_account_id": "0.0.2", "schedule_id": "0.0.2", "signatures": [\ {\ "consensus_timestamp": "1586567700.453054000",\ "public_key_prefix": "AAEBAwuqAwzB",\ "signature": "3q2+7wABAQMLqgMMwQ==",\ "type": "ED25519"\ }\ ], "transaction_body": "Kd6tvu8=", "wait_for_expiry": true } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions#response-details-1-1) Response Details Response Item Description **adminKey** The admin key on the schedule **adminKey.\_type** The type of key **adminKey.key** The admin public key **consensus\_timestamp** The consensus timestamp of when the schedule was created **creator\_account\_id** The account ID of the creator of the schedule **executed\_timestamp** The timestamp at which the transaction that was scheduled was executed at **memo** A string of characters associated with the memo if set **payer\_account\_id** The account ID of the account paying for the execution of the transaction **schedule\_id** The ID of the schedule entity **signatures** The list of keys that signed the transaction **signatures.consensus\_timestamp** The consensus timestamp at which the signature was added **signatures.public\_key\_prefix** The signatures public key prefix **signatures.signature** The signature of the key that signed the schedule transaction **signatures.type** The type of signature (ED5519 or ECDSA) **transaction\_body** The transaction body of the transaction that was scheduled. The transaction body is base64 encoded binary protobuf data. Deserialize the data by using the [ScheduleableTransactionBody](https://github.com/hashgraph/hedera-protobufs/blob/main/services/schedulable_transaction_body.proto) proto parser. **wait\_for\_expiry** Whether or not the schedule transaction specified a specific time to expire by [PreviousBlocks](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/blocks) [NextSmart Contracts](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts) Last updated 2 months ago Was this helpful? --- # Topics | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/topics#overview) Overview --------------------------------------------------------------------------------------- The **Topics endpoints** in the Hedera Mirror Node REST API allows developers to query **topics and messages**. These endpoints are crucial for retrieving topic details, message history, and tracking consensus events on the network. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/topics#endpoints) Endpoints ----------------------------------------------------------------------------------------- The following endpoints are available for the Topics object: **Endpoint** **Description** `GET /api/v1/topics/{id}/messages` Retrieves messages for a specific topic by ID. `GET /api/v1/topics/{id}/messages/{sequence_number}` Fetches a specific message from a topic using sequence number. `GET /api/v1/topics/{id}/messages/{consensusTimestamp}` Retrieves a topic message by consensus timestamp. `GET /api/v1/topics/{topicid}` Retrieves the topic details for the given topic ID. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/topics#topics) Topics ----------------------------------------------------------------------------------- ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/topics#get-api-v1-topics-topicid-messages) List topic messages by id get /api/v1/topics/{topicId}/messages Returns the list of topic messages for the given topic id. Path parameters topicIdstring | nullableRequired Network entity ID in the format of `shard.realm.num` Example: `0.0.2`Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}$` Query parameters encodingstringOptionalExample: `base64` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` sequencenumberinteger · int64OptionalExample: `2` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Topic Not Found application/json get /api/v1/topics/{topicId}/messages HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/topics/{topicId}/messages HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "messages": [\ {\ "chunk_info": {\ "initial_transaction_id": "0.0.10-1234567890-000000321",\ "nonce": 3,\ "number": 1,\ "total": 2,\ "scheduled": true\ },\ "consensus_timestamp": "1234567890.000000001",\ "message": "bWVzc2FnZQ==",\ "payer_account_id": "0.0.10",\ "running_hash": "cnVubmluZ19oYXNo",\ "running_hash_version": 2,\ "sequence_number": 1,\ "topic_id": "0.0.7"\ }\ ], "links": { "next": null } } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/topics#response-details) Response Details Response Item Description **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 ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/topics#get-api-v1-topics-topicid-messages-sequencenumber) Get topic message by id and sequence number get /api/v1/topics/{topicId}/messages/{sequenceNumber} Returns a single topic message for the given topic id and sequence number. Path parameters topicIdstring | nullableRequired Network entity ID in the format of `shard.realm.num` Example: `0.0.2`Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}$` sequenceNumberinteger · int64Required Topic message sequence number Example: `2` Responses 200 OK application/json ResponseobjectExample: `{"chunk_info":{"initial_transaction_id":"0.0.10-1234567890-000000321","nonce":3,"number":1,"total":2,"scheduled":true},"consensus_timestamp":"1234567890.000000001","message":"bWVzc2FnZQ==","payer_account_id":"0.0.10","running_hash":"cnVubmluZ19oYXNo","running_hash_version":2,"sequence_number":1,"topic_id":"0.0.7"}` Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/topics/{topicId}/messages/{sequenceNumber} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/topics/{topicId}/messages/{sequenceNumber} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "chunk_info": { "initial_transaction_id": "0.0.10-1234567890-000000321", "nonce": 3, "number": 1, "total": 2, "scheduled": true }, "consensus_timestamp": "1234567890.000000001", "message": "bWVzc2FnZQ==", "payer_account_id": "0.0.10", "running_hash": "cnVubmluZ19oYXNo", "running_hash_version": 2, "sequence_number": 1, "topic_id": "0.0.7" } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/topics#get-api-v1-topics-messages-timestamp) Get topic message by consensusTimestamp get /api/v1/topics/messages/{timestamp} Returns a topic message the given the consensusTimestamp. Path parameters timestampstringRequired The Unix timestamp in seconds.nanoseconds format, the timestamp at which the associated transaction reached consensus. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `1234567890.0000007`Pattern: `^\d{1,10}(.\d{1,9})?$` Responses 200 OK application/json ResponseobjectExample: `{"chunk_info":{"initial_transaction_id":"0.0.10-1234567890-000000321","nonce":3,"number":1,"total":2,"scheduled":true},"consensus_timestamp":"1234567890.000000001","message":"bWVzc2FnZQ==","payer_account_id":"0.0.10","running_hash":"cnVubmluZ19oYXNo","running_hash_version":2,"sequence_number":1,"topic_id":"0.0.7"}` Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/topics/messages/{timestamp} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/topics/messages/{timestamp} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "chunk_info": { "initial_transaction_id": "0.0.10-1234567890-000000321", "nonce": 3, "number": 1, "total": 2, "scheduled": true }, "consensus_timestamp": "1234567890.000000001", "message": "bWVzc2FnZQ==", "payer_account_id": "0.0.10", "running_hash": "cnVubmluZ19oYXNo", "running_hash_version": 2, "sequence_number": 1, "topic_id": "0.0.7" } [PreviousTokens](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens) [NextTransactions](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions) Last updated 2 months ago Was this helpful? --- # Accounts | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#overview) Overview ----------------------------------------------------------------------------------------- The **Account** endpoints in the Hedera Mirror Node REST API provides endpoints to retrieve account details, crypto allowances, token relationships, NFTs owned by accounts, and staking reward payouts. These endpoints are crucial for tracking account balances, permissions, and historical activity. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#endpoints) Endpoints ------------------------------------------------------------------------------------------- The following endpoints are available for the Accounts object: Endpoint Description `GET /api/v1/accounts` Retrieves a list of accounts on the network. `GET /api/v1/accounts/{idOrAliasOrEvmAddress}` Fetches details of a specific account by ID, alias, or EVM address. `GET /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/crypto` Retrieves hbar allowances granted by an account. `GET /api/v1/accounts/{idOrAliasOrEvmAddress}/rewards` Gets past staking reward payouts for an account. `GET /api/v1/accounts/{idOrAliasOrEvmAddress}/airdrops/outstanding` Fetches the outstanding token airdrops for a given account. `GET /api/v1/accounts/{idOrAliasOrEvmAddress}/airdrops/pending` Fetech the pending token airdrops for a given account. `GET /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/tokens` Retrieves token allowances granted by an account. `GET /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/nfts` Retrieves nft allowances granted by an account. `GET /api/v1/accounts/{idOrAliasOrEvmAddress}/nfts` Fetches the nfts for an account. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#accounts) 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.**.‌ 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. ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts) List account entities on network get /api/v1/accounts Returns a list of all account entity items on the network. Query parameters account.balancestringOptional The optional balance value to compare against Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?\d{1,10}$` account.idstringOptional The ID of the account to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` account.publickeystringOptional The account's public key to compare against Example: `3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be` balancebooleanOptional 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. Default: `true`Example: `true` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/accounts HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "accounts": [\ {\ "account": "0.0.8",\ "alias": "HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA",\ "auto_renew_period": null,\ "balance": {\ "timestamp": "0.000002345",\ "balance": 80,\ "tokens": [\ {\ "token_id": "0.0.200001",\ "balance": 8\ }\ ]\ },\ "created_timestamp": "1562591528.000123456",\ "decline_reward": false,\ "deleted": false,\ "ethereum_nonce": 10,\ "evm_address": "0xac384c53f03855fa1b3616052f8ba32c6c2a2fec",\ "expiry_timestamp": null,\ "key": null,\ "max_automatic_token_associations": 200,\ "memo": "entity memo",\ "pending_reward": 100,\ "receiver_sig_required": false,\ "staked_account_id": null,\ "staked_node_id": 3,\ "stake_period_start": "172800000.000000000"\ }\ ], "links": { "next": null } } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#response-details) Response Details Response Item Description **account** The ID of the 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 #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#optional-filtering) Optional Filtering Operator Example Description `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 #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#additional-examples) Additional Examples Example Requests Description `/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. ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts-idoraliasorevmaddress) Get account by alias, id, or evm address get /api/v1/accounts/{idOrAliasOrEvmAddress} 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. Path parameters idOrAliasOrEvmAddressstringRequired Account alias or account id or evm address Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` transactiontypestring · enumOptionalExample: `cryptotransfer`Possible values: `ATOMICBATCH``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` transactionsbooleanOptional If provided and set to false transactions will not be included in the response Default: `true`Example: `true` Responses 200 OK application/json Responseall of objectOptionalExample: `{"account":"0.0.8","alias":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA","auto_renew_period":null,"balance":{"timestamp":"0.000002345","balance":80,"tokens":[{"token_id":"0.0.200001","balance":8}]},"created_timestamp":"1562591528.000123456","decline_reward":false,"deleted":false,"ethereum_nonce":10,"evm_address":"0xac384c53f03855fa1b3616052f8ba32c6c2a2fec","expiry_timestamp":null,"key":null,"max_automatic_token_associations":200,"memo":"entity memo","pending_reward":100,"receiver_sig_required":false,"staked_account_id":null,"staked_node_id":3,"stake_period_start":"172800000.000000000"}` Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/accounts/{idOrAliasOrEvmAddress} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts/{idOrAliasOrEvmAddress} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "account": "0.0.8", "alias": "HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA", "auto_renew_period": null, "balance": { "timestamp": "0.000002345", "balance": 80, "tokens": [\ {\ "token_id": "0.0.200001",\ "balance": 8\ }\ ] }, "created_timestamp": "1562591528.000123456", "decline_reward": false, "deleted": false, "ethereum_nonce": 10, "evm_address": "0xac384c53f03855fa1b3616052f8ba32c6c2a2fec", "expiry_timestamp": null, "key": null, "max_automatic_token_associations": 200, "memo": "entity memo", "pending_reward": 100, "receiver_sig_required": false, "staked_account_id": null, "staked_node_id": 3, "stake_period_start": "172800000.000000000", "transactions": [\ {\ "batch_key": "0xae8bebf1c9fa0f309356e48057f6047af7cde63037d0509d16ddc3b20e085158bfdf14d15345c1b18b199b72fed4dead",\ "bytes": null,\ "charged_tx_fee": 7,\ "consensus_timestamp": "1234567890.000000007",\ "entity_id": "0.0.2281979",\ "max_custom_fees": [\ {\ "account_id": "0.0.8",\ "amount": 1000,\ "denominating_token_id": "0.0.2000"\ },\ {\ "account_id": "0.0.8",\ "amount": 1500,\ "denominating_token_id": null\ }\ ],\ "max_fee": 33,\ "memo_base64": null,\ "name": "CRYPTOTRANSFER",\ "nft_transfers": [\ {\ "is_approval": true,\ "receiver_account_id": "0.0.121",\ "sender_account_id": "0.0.122",\ "serial_number": 1,\ "token_id": "0.0.123"\ },\ {\ "is_approval": true,\ "receiver_account_id": "0.0.321",\ "sender_account_id": "0.0.422",\ "serial_number": 2,\ "token_id": "0.0.123"\ }\ ],\ "node": "0.0.3",\ "nonce": 0,\ "parent_consensus_timestamp": "1234567890.000000007",\ "result": "SUCCESS",\ "scheduled": false,\ "staking_reward_transfers": [\ {\ "account": 3,\ "amount": 150\ },\ {\ "account": 9,\ "amount": 200\ }\ ],\ "transaction_hash": "vigzKe2J7fv4ktHBbNTSzQmKq7Lzdq1/lJMmHT+a2KgvdhAuadlvS4eKeqKjIRmW",\ "transaction_id": "0.0.8-1234567890-000000006",\ "token_transfers": [\ {\ "token_id": "0.0.90000",\ "account": "0.0.9",\ "amount": 1200,\ "is_approval": false\ },\ {\ "token_id": "0.0.90000",\ "account": "0.0.8",\ "amount": -1200,\ "is_approval": false\ }\ ],\ "transfers": [\ {\ "account": "0.0.3",\ "amount": 2,\ "is_approval": false\ },\ {\ "account": "0.0.8",\ "amount": -3,\ "is_approval": false\ },\ {\ "account": "0.0.98",\ "amount": 1,\ "is_approval": false\ },\ {\ "account": "0.0.800",\ "amount": 150,\ "is_approval": false\ },\ {\ "account": "0.0.800",\ "amount": 200,\ "is_approval": false\ }\ ],\ "valid_duration_seconds": 11,\ "valid_start_timestamp": "1234567890.000000006"\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts-idoraliasorevmaddress-allowances-crypto) Get crypto allowances for an account info get /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/crypto Returns information for all crypto allowances for an account. Path parameters idOrAliasOrEvmAddressstringRequired Account alias or account id or evm address Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` spender.idstringOptional The ID of the spender to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/crypto HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/crypto HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "allowances": [\ {\ "amount": 1,\ "amount_granted": 1,\ "owner": "0.0.2",\ "spender": "0.0.2",\ "timestamp": {\ "from": null,\ "to": null\ }\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts-idoraliasorevmaddress-rewards) Get past staking reward payouts for an account get /api/v1/accounts/{idOrAliasOrEvmAddress}/rewards Returns information for all past staking reward payouts for an account. Path parameters idOrAliasOrEvmAddressstringRequired Account alias or account id or evm address Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/accounts/{idOrAliasOrEvmAddress}/rewards HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts/{idOrAliasOrEvmAddress}/rewards HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "rewards": [\ {\ "account_id": "0.0.1000",\ "amount": 10,\ "timestamp": "1234567890.000000001"\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts-idoraliasorevmaddress-tokens) Get token relationships info for an account get /api/v1/accounts/{idOrAliasOrEvmAddress}/tokens Returns information for all token relationships for an account. Path parameters idOrAliasOrEvmAddressstringRequired Account alias or account id or evm address Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` token.idstringOptional The ID of the token to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/accounts/{idOrAliasOrEvmAddress}/tokens HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts/{idOrAliasOrEvmAddress}/tokens HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "tokens": [\ {\ "automatic_association": true,\ "balance": 5,\ "created_timestamp": "123456789.000000001",\ "decimals": 3,\ "freeze_status": "UNFROZEN",\ "kyc_status": "GRANTED",\ "token_id": "0.0.27335"\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts-idoraliasorevmaddress-airdrops-outstanding) Get outstanding token airdrops sent by an account get /api/v1/accounts/{idOrAliasOrEvmAddress}/airdrops/outstanding Returns outstanding token airdrops that have been sent by an account. Path parameters idOrAliasOrEvmAddressstringRequired Account alias or account id or evm address Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` receiver.idstringOptional The ID of the receiver to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` serialnumberstringOptional The nft serial number (64 bit type). Requires a tokenId value also be populated. Example: `{"summary":"--","value":""}`Pattern: `^((eq|gt|gte|lt|lte):)?\d{1,19}?$` token.idstringOptional The ID of the token to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/accounts/{idOrAliasOrEvmAddress}/airdrops/outstanding HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts/{idOrAliasOrEvmAddress}/airdrops/outstanding HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "airdrops": [\ {\ "amount": 10,\ "receiver_id": "0.0.15",\ "sender_id": "0.0.10",\ "serial_number": null,\ "timestamp": {\ "from": "1651560386.060890949",\ "to": "1651560386.661997287"\ },\ "token_id": "0.0.99"\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts-idoraliasorevmaddress-airdrops-pending) Get pending token airdrops received by an account get /api/v1/accounts/{idOrAliasOrEvmAddress}/airdrops/pending Returns pending token airdrops that have been received by an account. Path parameters idOrAliasOrEvmAddressstringRequired Account alias or account id or evm address Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` sender.idstringOptional The ID of the sender to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` serialnumberstringOptional The nft serial number (64 bit type). Requires a tokenId value also be populated. Example: `{"summary":"--","value":""}`Pattern: `^((eq|gt|gte|lt|lte):)?\d{1,19}?$` token.idstringOptional The ID of the token to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/accounts/{idOrAliasOrEvmAddress}/airdrops/pending HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts/{idOrAliasOrEvmAddress}/airdrops/pending HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "airdrops": [\ {\ "amount": 10,\ "receiver_id": "0.0.15",\ "sender_id": "0.0.10",\ "serial_number": null,\ "timestamp": {\ "from": "1651560386.060890949",\ "to": "1651560386.661997287"\ },\ "token_id": "0.0.99"\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts-idoraliasorevmaddress-allowances-tokens) Get fungible token allowances for an account get /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/tokens Returns information for fungible token allowances for an account. ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#) 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 ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#) 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. Path parameters idOrAliasOrEvmAddressstringRequired Account alias or account id or evm address Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` spender.idstringOptional The ID of the spender to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` token.idstringOptional The ID of the token to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/tokens HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/tokens HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "allowances": [\ {\ "amount": 75,\ "amount_granted": 100,\ "owner": "0.0.2",\ "spender": "0.0.2",\ "timestamp": {\ "from": null,\ "to": null\ },\ "token_id": "0.0.2"\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts-idoraliasorevmaddress-allowances-nfts) Get non fungible token allowances for an account get /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/nfts Returns an account's non-fungible token allowances. ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#) 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. ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#) 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. Path parameters idOrAliasOrEvmAddressstringRequired Account alias or account id or evm address Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` account.idstringOptional The ID of the account to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` token.idstringOptional The ID of the token to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` ownerbooleanOptional When 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. Default: `true`Example: `true` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/nfts HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts/{idOrAliasOrEvmAddress}/allowances/nfts HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "allowances": [\ {\ "approved_for_all": false,\ "owner": "0.0.11",\ "payer_account_id": "0.0.10",\ "spender": "0.0.15",\ "timestamp": {\ "from": "1651560386.060890949",\ "to": "1651560386.661997287"\ },\ "token_id": "0.0.99"\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#get-api-v1-accounts-idoraliasorevmaddress-nfts) Get nfts for an account info get /api/v1/accounts/{idOrAliasOrEvmAddress}/nfts Returns information for all non-fungible tokens for an account. ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#) 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 1. **All NFTs in ASC order**: 1-1, 1-3, 1-5, 2-2, 2-4, 3-3, 3-4 2. **All NFTs in DESC order**: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3, 1-1 3. **NFTs above 1-1 in ASC order**: 1-3, 1-5, 2-2, 2-4, 3-3, 3-4 4. **NFTs below 3-3 in ASC order**: 1-1, 1-3, 1-5, 2-2, 2-4 5. **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 ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/accounts#) 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. Path parameters idOrAliasOrEvmAddressstringRequired Account alias or account id or evm address Example: `{"value":"HIQQEXWKW53RKN4W6XXC4Q232SYNZ3SZANVZZSUME5B5PRGXL663UAQA"}`Pattern: `^(\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}))$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` serialnumberstringOptional The nft serial number (64 bit type). Requires a tokenId value also be populated. Example: `{"summary":"--","value":""}`Pattern: `^((eq|gt|gte|lt|lte):)?\d{1,19}?$` spender.idstringOptional The ID of the spender to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` token.idstringOptional The ID of the token to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/accounts/{idOrAliasOrEvmAddress}/nfts HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/accounts/{idOrAliasOrEvmAddress}/nfts HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "nfts": [\ {\ "account_id": "0.1.2",\ "created_timestamp": "1234567890.000000001",\ "delegating_spender": "0.0.400",\ "deleted": false,\ "metadata": "VGhpcyBpcyBhIHRlc3QgTkZU",\ "modified_timestamp": "1610682445.003266001",\ "serial_number": 124,\ "spender_id": "0.0.500",\ "token_id": "0.0.222"\ }\ ], "links": { "next": null } } [PreviousMirror Node REST API](https://docs.hedera.com/hedera/sdks-and-apis/rest-api) [NextBalances](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/balances) Last updated 2 months ago Was this helpful? --- # Transactions | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions#overview) Overview --------------------------------------------------------------------------------------------- The **Transactions endpoints** in the Hedera Mirror Node REST API allows developers to query **transaction history, details, and status** on the Hedera network. These endpoints is essential for tracking payments, token transfers, smart contract executions, and other network activities. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions#endpoints) Endpoints ----------------------------------------------------------------------------------------------- The following endpoints are available for the Network activity object: **Endpoint** **Description** `GET /api/v1/transactions` Retrieves a list of transactions on the network. `GET /api/v1/transactions/{id}` Fetches details of a specific transaction by transaction ID. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions#fetching-transactions) Fetching 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](https://www.hedera.com/fees) . ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions#get-api-v1-transactions) List transactions get /api/v1/transactions Lists transactions on the network. This includes successful and unsuccessful transactions. Query parameters account.idstringOptional The ID of the account to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` transactiontypestring · enumOptionalExample: `cryptotransfer`Possible values: `ATOMICBATCH``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` resultundefined · enumOptional The transaction success type. Possible values: `success``fail` typeundefined · enumOptional The transaction account balance modification type. Possible values: `credit``debit` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/transactions HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/transactions HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "transactions": [\ {\ "batch_key": "0xae8bebf1c9fa0f309356e48057f6047af7cde63037d0509d16ddc3b20e085158bfdf14d15345c1b18b199b72fed4dead",\ "bytes": null,\ "charged_tx_fee": 7,\ "consensus_timestamp": "1234567890.000000007",\ "entity_id": "0.0.2281979",\ "max_custom_fees": [\ {\ "account_id": "0.0.8",\ "amount": 1000,\ "denominating_token_id": "0.0.2000"\ },\ {\ "account_id": "0.0.8",\ "amount": 1500,\ "denominating_token_id": null\ }\ ],\ "max_fee": 33,\ "memo_base64": null,\ "name": "CRYPTOTRANSFER",\ "nft_transfers": [\ {\ "is_approval": true,\ "receiver_account_id": "0.0.121",\ "sender_account_id": "0.0.122",\ "serial_number": 1,\ "token_id": "0.0.123"\ },\ {\ "is_approval": true,\ "receiver_account_id": "0.0.321",\ "sender_account_id": "0.0.422",\ "serial_number": 2,\ "token_id": "0.0.123"\ }\ ],\ "node": "0.0.3",\ "nonce": 0,\ "parent_consensus_timestamp": "1234567890.000000007",\ "result": "SUCCESS",\ "scheduled": false,\ "staking_reward_transfers": [\ {\ "account": 3,\ "amount": 150\ },\ {\ "account": 9,\ "amount": 200\ }\ ],\ "transaction_hash": "vigzKe2J7fv4ktHBbNTSzQmKq7Lzdq1/lJMmHT+a2KgvdhAuadlvS4eKeqKjIRmW",\ "transaction_id": "0.0.8-1234567890-000000006",\ "token_transfers": [\ {\ "token_id": "0.0.90000",\ "account": "0.0.9",\ "amount": 1200,\ "is_approval": false\ },\ {\ "token_id": "0.0.90000",\ "account": "0.0.8",\ "amount": -1200,\ "is_approval": false\ }\ ],\ "transfers": [\ {\ "account": "0.0.3",\ "amount": 2,\ "is_approval": false\ },\ {\ "account": "0.0.8",\ "amount": -3,\ "is_approval": false\ },\ {\ "account": "0.0.98",\ "amount": 1,\ "is_approval": false\ },\ {\ "account": "0.0.800",\ "amount": 150,\ "is_approval": false\ },\ {\ "account": "0.0.800",\ "amount": 200,\ "is_approval": false\ }\ ],\ "valid_duration_seconds": 11,\ "valid_start_timestamp": "1234567890.000000006"\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions#get-api-v1-transactions-transactionid) Get transaction by id get /api/v1/transactions/{transactionId} Returns transaction information based on the given transaction id Path parameters transactionIdstringRequired Transaction id Example: `0.0.10-1234567890-000000000` Query parameters nonceinteger · int32Optional 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. Example: `0` scheduledbooleanOptional 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. Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/transactions/{transactionId} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/transactions/{transactionId} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "transactions": [\ {\ "batch_key": "0xae8bebf1c9fa0f309356e48057f6047af7cde63037d0509d16ddc3b20e085158bfdf14d15345c1b18b199b72fed4dead",\ "bytes": null,\ "charged_tx_fee": 7,\ "consensus_timestamp": "1234567890.000000007",\ "entity_id": "0.0.2281979",\ "max_custom_fees": [\ {\ "account_id": "0.0.8",\ "amount": 1000,\ "denominating_token_id": "0.0.2000"\ },\ {\ "account_id": "0.0.8",\ "amount": 1500,\ "denominating_token_id": null\ }\ ],\ "max_fee": 33,\ "memo_base64": null,\ "name": "CRYPTOTRANSFER",\ "nft_transfers": [\ {\ "is_approval": true,\ "receiver_account_id": "0.0.121",\ "sender_account_id": "0.0.122",\ "serial_number": 1,\ "token_id": "0.0.123"\ },\ {\ "is_approval": true,\ "receiver_account_id": "0.0.321",\ "sender_account_id": "0.0.422",\ "serial_number": 2,\ "token_id": "0.0.123"\ }\ ],\ "node": "0.0.3",\ "nonce": 0,\ "parent_consensus_timestamp": "1234567890.000000007",\ "result": "SUCCESS",\ "scheduled": false,\ "staking_reward_transfers": [\ {\ "account": 3,\ "amount": 150\ },\ {\ "account": 9,\ "amount": 200\ }\ ],\ "transaction_hash": "vigzKe2J7fv4ktHBbNTSzQmKq7Lzdq1/lJMmHT+a2KgvdhAuadlvS4eKeqKjIRmW",\ "transaction_id": "0.0.8-1234567890-000000006",\ "token_transfers": [\ {\ "token_id": "0.0.90000",\ "account": "0.0.9",\ "amount": 1200,\ "is_approval": false\ },\ {\ "token_id": "0.0.90000",\ "account": "0.0.8",\ "amount": -1200,\ "is_approval": false\ }\ ],\ "transfers": [\ {\ "account": "0.0.3",\ "amount": 2,\ "is_approval": false\ },\ {\ "account": "0.0.8",\ "amount": -3,\ "is_approval": false\ },\ {\ "account": "0.0.98",\ "amount": 1,\ "is_approval": false\ },\ {\ "account": "0.0.800",\ "amount": 150,\ "is_approval": false\ },\ {\ "account": "0.0.800",\ "amount": 200,\ "is_approval": false\ }\ ],\ "valid_duration_seconds": 11,\ "valid_start_timestamp": "1234567890.000000006",\ "assessed_custom_fees": [\ {\ "amount": 1,\ "collector_account_id": "0.0.2",\ "effective_payer_account_ids": [\ "0.0.2"\ ],\ "token_id": "0.0.2"\ }\ ]\ }\ ] } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions#response-details-2) Response Details Response Item Description **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](https://www.hedera.com/fees) , the transfer of the [network fee](https://www.hedera.com/fees) , and the transfer of the [service fee](https://www.hedera.com/fees) for that transaction. If the transaction was not processed, a [network fee](https://www.hedera.com/fees) 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 #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions#optional-filtering-2) Optional Filtering Operator Example Description `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. Parameter Description `{transaction_ID}` A specific transaction can be returned by specifying a transaction ID #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions#additional-examples-1) Additional Examples Example Request Description `/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 #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions#undefined) [PreviousTopics](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/topics) [NextNetwork](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/network) Last updated 2 months ago Was this helpful? --- # Tokens | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#overview) Overview --------------------------------------------------------------------------------------- The **Tokens endpoints** in the Hedera Mirror Node REST API allow developers to retrieve token details, token balances, NFT metadata, and transaction history. These endpoints are essential for tracking tokenized assets and interactions on the Hedera network. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#endpoints) Endpoints ----------------------------------------------------------------------------------------- The following endpoints are available for the Tokens object: **Endpoint** **Description** `GET /api/v1/tokens` Retrieves a list of all tokens on the network. `GET /api/v1/tokens/balances` Lists token balances across accounts. `GET /api/v1/tokens/{id}` Fetches details of a specific token by ID. `GET /api/v1/tokens/nfts` Retrieves a list of all NFTs on the network. `GET /api/v1/tokens/nfts/{serialNumber}` Fetches metadata and details for a specific NFT. `GET /api/v1/tokens/nfts/{id}/transactions` Retrieves the transaction history of a specific NFT. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#tokens) Tokens ----------------------------------------------------------------------------------- ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#get-api-v1-tokens) List tokens get /api/v1/tokens Returns a list of tokens on the network. Query parameters account.idstringOptional The ID of the account to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` namestring · min: 3 · max: 100Optional 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. orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` publickeystringOptional The public key to compare against Example: `3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be` token.idstringOptional The ID of the token to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` typestring\[\]OptionalExample: `["ALL","FUNGIBLE_COMMON","NON_FUNGIBLE_UNIQUE"]` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/tokens HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/tokens HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "tokens": [\ {\ "admin_key": null,\ "decimals": 3,\ "metadata": "VGhpcyBpcyBhIHRlc3QgTkZU",\ "name": "First Mover",\ "symbol": "FIRSTMOVERLPDJH",\ "token_id": "0.0.1",\ "type": "FUNGIBLE_COMMON"\ }\ ], "links": { "next": null } } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#response-details) Response Details Response Item Description **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) **decimals** The decimal numbers of the token **metadata** The metadata of the token #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#additional-examples) Additional Examples Example Request Description `/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 #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#undefined) ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#get-api-v1-tokens-tokenid-balances) List token balances get /api/v1/tokens/{tokenId}/balances Returns a list of token balances given the id. This represents the Token supply distribution across the network Path parameters tokenIdstring | nullableRequired Network entity ID in the format of `shard.realm.num` Example: `0.0.2`Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}$` Query parameters account.balancestringOptional The optional balance value to compare against Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?\d{1,10}$` account.idstringOptional The ID of the account to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` account.publickeystringOptional The account's public key to compare against Example: `3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/tokens/{tokenId}/balances HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/tokens/{tokenId}/balances HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "timestamp": "1586567700.453054000", "balances": [\ {\ "account": "0.15.2",\ "balance": 1000,\ "decimals": 3\ }\ ], "links": { "next": null } } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#response-details-1) Response Details Response Item Description **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 **balances.balance** The balance of the token associated with the account #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#additional-examples-1) Additional Examples Example Request Description `/api/v1/tokens//balances?order=asc` The balance of the token in ascending order `/api/v1/tokens//balances?account.id=0.0.1000` The balance of the token for account ID 0.0.1000 `/api/v1/tokens//balances?account.balance=gt:1000` The balance for the token greater than 1000 `/api/v1/tokens//balances?timestamp=1566562500.040961001` The token balances for the specified timestamp ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#get-api-v1-tokens-tokenid) Get token by id get /api/v1/tokens/{tokenId} Returns token entity information given the id Path parameters tokenIdstring | nullableRequired Network entity ID in the format of `shard.realm.num` Example: `0.0.2`Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}$` Query parameters timestampstringOptional The Unix timestamp in seconds.nanoseconds format. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}`Pattern: `^((eq|lt|lte):)?\d{1,10}(.\d{1,9})?$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/tokens/{tokenId} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/tokens/{tokenId} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "admin_key": { "_type": "ProtobufEncoded", "key": 10101 }, "auto_renew_account": "0.1.2", "auto_renew_period": null, "created_timestamp": "1234567890.000000001", "deleted": false, "decimals": 1000, "expiry_timestamp": null, "freeze_default": false, "freeze_key": { "_type": "ProtobufEncoded", "key": 10101 }, "initial_supply": 1000000, "kyc_key": { "_type": "ProtobufEncoded", "key": 10101 }, "max_supply": 9223372036854776000, "memo": "token memo", "modified_timestamp": "1234567890.000000001", "name": "Token name", "pause_key": { "_type": "ProtobufEncoded", "key": 10101 }, "pause_status": "UNPAUSED", "supply_key": { "_type": "ProtobufEncoded", "key": 10101 }, "supply_type": "INFINITE", "symbol": "ORIGINALRDKSE", "token_id": "0.10.1", "total_supply": 1000000, "treasury_account_id": "0.1.2", "type": "FUNGIBLE_COMMON", "wipe_key": { "_type": "ProtobufEncoded", "key": 10101 }, "custom_fees": { "created_timestamp": "1234567890.000000001", "fixed_fees": [\ {\ "amount": 100,\ "collector_account_id": "0.1.5",\ "denominating_token_id": "0.10.8"\ }\ ], "fractional_fees": [\ {\ "amount": {\ "numerator": 12,\ "denominator": 29\ },\ "collector_account_id": "0.1.6",\ "denominating_token_id": "0.10.9",\ "maximum": 120,\ "minimum": 30,\ "net_of_transfers": true\ }\ ] } } FungibleToken #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#response-details-2) Response Details Response Item Description **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\_suppl**y 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 ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#get-api-v1-tokens-tokenid-nfts) List nfts get /api/v1/tokens/{tokenId}/nfts Returns a list of non-fungible tokens Path parameters tokenIdstring | nullableRequired Network entity ID in the format of `shard.realm.num` Example: `0.0.2`Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}$` Query parameters account.idstringOptional The ID of the account to return information for Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` serialnumberstringOptional The nft serial number (64 bit type). Requires a tokenId value also be populated. Example: `{"summary":"--","value":""}`Pattern: `^((eq|gt|gte|lt|lte):)?\d{1,19}?$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/tokens/{tokenId}/nfts HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/tokens/{tokenId}/nfts HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "nfts": [\ {\ "account_id": "0.1.2",\ "created_timestamp": "1234567890.000000001",\ "delegating_spender": "0.0.400",\ "deleted": false,\ "metadata": "VGhpcyBpcyBhIHRlc3QgTkZU",\ "modified_timestamp": "1610682445.003266001",\ "serial_number": 124,\ "spender_id": "0.0.500",\ "token_id": "0.0.222"\ }\ ], "links": { "next": null } } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#response-details-3) Response Details Response Item Description **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 #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#undefined-1) ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#get-api-v1-tokens-tokenid-nfts-serialnumber) Get nft info get /api/v1/tokens/{tokenId}/nfts/{serialNumber} Returns information for a non-fungible token Path parameters tokenIdstring | nullableRequired Network entity ID in the format of `shard.realm.num` Example: `0.0.2`Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}$` serialNumberinteger · int64 · min: 1 · max: 9223372036854776000Required The nft serial number Default: `1`Example: `1` Responses 200 OK application/json ResponseobjectExample: `{"account_id":"0.1.2","created_timestamp":"1234567890.000000001","delegating_spender":"0.0.400","deleted":false,"metadata":"VGhpcyBpcyBhIHRlc3QgTkZU","modified_timestamp":"1610682445.003266001","serial_number":124,"spender_id":"0.0.500","token_id":"0.0.222"}` Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/tokens/{tokenId}/nfts/{serialNumber} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/tokens/{tokenId}/nfts/{serialNumber} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "account_id": "0.1.2", "created_timestamp": "1234567890.000000001", "delegating_spender": "0.0.400", "deleted": false, "metadata": "VGhpcyBpcyBhIHRlc3QgTkZU", "modified_timestamp": "1610682445.003266001", "serial_number": 124, "spender_id": "0.0.500", "token_id": "0.0.222" } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#response-details-4) Response Details Response Item Description **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 ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#get-api-v1-tokens-tokenid-nfts-serialnumber-transactions) Get an nfts transction history get /api/v1/tokens/{tokenId}/nfts/{serialNumber}/transactions Returns a list of transactions for a given non-fungible token Path parameters tokenIdstring | nullableRequired Network entity ID in the format of `shard.realm.num` Example: `0.0.2`Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}$` serialNumberinteger · int64 · min: 1 · max: 9223372036854776000Required The nft serial number Default: `1`Example: `1` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 206 Partial Content application/json 400 Invalid parameter application/json get /api/v1/tokens/{tokenId}/nfts/{serialNumber}/transactions HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/tokens/{tokenId}/nfts/{serialNumber}/transactions HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "transactions": [\ {\ "consensus_timestamp": "1618591023.997420021",\ "is_approval": false,\ "nonce": 0,\ "receiver_account_id": "0.0.11",\ "sender_account_id": "0.0.10",\ "transaction_id": "0.0.19789-1618591023-997420021",\ "type": "CRYPTOTRANSFER"\ }\ ], "links": { "next": null } } #### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens#response-details-5) Response Details Response Item Description **consensus\_timestamp** 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 **transaction\_id** The ID of the transaction **token\_id** The token ID of the NFT [PreviousSmart Contracts](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts) [NextTopics](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/topics) Last updated 2 months ago Was this helpful? --- # Smart Contracts | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#overview) Overview ------------------------------------------------------------------------------------------------ The **Smart Contracts endpoints** in the Hedera Mirror Node REST API allows developers to query **smart contract metadata, execution results, state changes, and logs**. These endpoints are essential for tracking contract interactions, retrieving transaction results, and debugging contract executions on the Hedera network. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#endpoints) Endpoints -------------------------------------------------------------------------------------------------- The following endpoints are available for the Smart Contracts object: **Endpoint** **Description** `GET /api/v1/contracts` Retrieves a list of smart contract entities on the network. `GET /api/v1/contracts/{contractIdOrAddress}` Fetches details of a specific contract by ID. `GET /api/v1/contracts/results/{transactionIdOrhash}` Retrieves execution results for a specific contract transaction ID. `GET /api/v1/contracts/{contractIdOrAddress}/results` Retrieves execution results for a specific contract. `GET /api/v1/contracts/{id}/state` Fetches the state of a contract. `GET /api/v1/contracts/results` Lists execution results for all contracts. `GET /api/v1/contracts/results/{transactionIdOrHash}/results` Get contract actions by transaction ID or transaction hash. `GET /api/v1/contracts/results/{timestamp}` Retrieves execution results for a contract at a given timestamp. `GET /api/v1/contracts/logs` Lists logs emitted from contracts. `GET /api/v1/contracts/{id}/results/logs` Fetches logs for a specific contract. `GET /api/v1/contracts/{id}/results/opcodes` Get the opcode traces for historical transactions `POST /api/v1/contracts/call` Invokes a smart contract method. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#smart-contracts) Smart Contracts -------------------------------------------------------------------------------------------------------------- ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts) List contract entities on network get /api/v1/contracts Returns a list of all contract entity items on the network. Query parameters contract.idstringOptional The ID of the smart contract Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}|(\d{1,10}\.){0,2}[A-Fa-f0-9]{40}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/contracts HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "contracts": [\ {\ "admin_key": {\ "_type": "ProtobufEncoded",\ "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"\ },\ "auto_renew_account": "0.0.2",\ "auto_renew_period": 7776000,\ "contract_id": "0.0.2",\ "created_timestamp": "1586567700.453054000",\ "deleted": false,\ "evm_address": "0000000000000000000000000000000000001f41",\ "expiration_timestamp": "1586567700.453054000",\ "file_id": "0.0.2",\ "max_automatic_token_associations": 1,\ "memo": "contract memo",\ "obtainer_id": "0.0.2",\ "permanent_removal": true,\ "proxy_account_id": "0.0.2",\ "timestamp": {\ "from": null,\ "to": null\ }\ }\ ], "links": { "next": null } } Response Item Description **admin\_key** The admin key of the contract, if specified **auto\_renew\_account** The account paying the auto renew fees, if set **auto\_renew\_period** The period at which the contract auto renews **bytecode** The bytecode of the contract **contract\_id** The contract ID **created\_timestamp** The timestamp the contract was created at **deleted** Whether or not the contract is deleted **evm\_address** The EVM address of the contract **expiration\_timestamp** The timestamp of when the contract is set to expire **file\_id** The ID of the file that stored the contract bytecode **max\_automatic\_token\_associations** The number of automatic token association slots **memo** The memo of the contract, if specified **obtainer\_id** The ID of the account or contract that will receive any remaining balance when the contract is deleted **permanent\_removal** Set to `true` when the system expires a contract **proxy\_account\_id** The proxy account ID (disabled) **solidity\_address** The solidity address **timestamp** The period for which the attributes are valid for ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-contractidoraddress) Get contract by id get /api/v1/contracts/{contractIdOrAddress} Return the contract information given an id Path parameters contractIdOrAddressstringRequired The ID or hex encoded EVM address (with or without 0x prefix) associated with this contract. Pattern: `^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40})$` Query parameters timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseall of objectOptional Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/contracts/{contractIdOrAddress} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/{contractIdOrAddress} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "admin_key": { "_type": "ProtobufEncoded", "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743" }, "auto_renew_account": "0.0.2", "auto_renew_period": 7776000, "contract_id": "0.0.2", "created_timestamp": "1586567700.453054000", "deleted": false, "evm_address": "0000000000000000000000000000000000001f41", "expiration_timestamp": "1586567700.453054000", "file_id": "0.0.2", "max_automatic_token_associations": 1, "memo": "contract memo", "obtainer_id": "0.0.2", "permanent_removal": true, "proxy_account_id": "0.0.2", "timestamp": { "from": null, "to": null }, "bytecode": "0x01021a1fdc9b", "runtime_bytecode": "0x0302fa1ad39c" } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-results) List contract results from all contracts on the network get /api/v1/contracts/results Returns a list of all ContractResults for all contract's function executions. Query parameters fromstringOptional Account ID or EVM address executing the contract Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}|(0x)?[A-Fa-f0-9]{40}$` block.hashstringOptional The block's hash. If multiple values are provided the last value will be the only value used. Example: `{"summary":"--","value":""}`Pattern: `^(eq:)?(0x)?([0-9A-Fa-f]{64}|[0-9A-Fa-f]{96})$` block.numberstringOptional The block's number Example: `{"summary":"--","value":""}`Pattern: `^(eq:)?(\d{1,19}|0x[a-fA-f0-9]+)$` internalbooleanOptional Whether to include child transactions or not Default: `false`Example: `true` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` transaction.indexinteger · int32Optional The transaction index in the block Example: `1` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/contracts/results HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/results HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "results": [\ {\ "access_list": "0xabcd",\ "address": "0x25fe26adc577cc89172e6156c9e24f7b9751b762",\ "amount": 10,\ "block_gas_used": 2000,\ "block_hash": "0x6ceecd8bb224da491",\ "block_number": 10,\ "bloom": null,\ "call_result": "0x2b048531b38d2882e86044bc972e940ee0a01938",\ "chain_id": "0x0127",\ "contract_id": "0.0.2",\ "created_contract_ids": [\ "0.0.2"\ ],\ "error_message": "Out of gas",\ "failed_initcode": "0x856739",\ "from": "0x0000000000000000000000000000000000001f41",\ "function_parameters": "0xbb9f02dc6f0e3289f57a1f33b71c73aa8548ab8b",\ "gas_consumed": 35000,\ "gas_limit": 100000,\ "gas_price": "0x4a817c800",\ "gas_used": 80000,\ "hash": "0xfebbaa29c513d124a6377246ea3506ad917d740c21a88f61a1c55ba338fc2bb1",\ "max_fee_per_gas": "0x5",\ "max_priority_fee_per_gas": "0x100",\ "nonce": 1,\ "r": "0xd693b532a80fed6392b428604171fb32fdbf953728a3a7ecc7d4062b1652c043",\ "result": "SUCCESS",\ "s": "0x24e9c602ac800b983b035700a14b23f78a253ab762deab5dc27e3555a750b355",\ "status": 1,\ "timestamp": "1586567700.453054000",\ "to": "0x0000000000000000000000000000000000001f41",\ "transaction_index": 1,\ "type": 2,\ "v": 1\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-results-transactionidorhash) Get the contract result from a contract on the network for a given transactionId or ethereum transaction hash get /api/v1/contracts/results/{transactionIdOrHash} Returns a single ContractResult for a contract's function executions for a given transactionId or ethereum transaction hash. Path parameters transactionIdOrHashstringRequired Transaction Id or a 32 byte hash with optional 0x prefix Example: `{"value":"0.0.10-1234567890-000000000"}`Pattern: `^(0x)?[A-Fa-f0-9]{64}|(\d{1,10})\.(\d{1,10})\.(\d{1,10})-(\d{1,19})-(\d{1,9})$` Query parameters nonceinteger · int32Optional 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. Default is 0 when not specified. Default: `0`Example: `1` Responses 200 OK application/json Responseall of objectOptional Show properties 206 Partial Content application/json 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/contracts/results/{transactionIdOrHash} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/results/{transactionIdOrHash} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "access_list": "0xabcd", "address": "0x25fe26adc577cc89172e6156c9e24f7b9751b762", "amount": 10, "block_gas_used": 2000, "block_hash": "0x6ceecd8bb224da491", "block_number": 10, "bloom": null, "call_result": "0x2b048531b38d2882e86044bc972e940ee0a01938", "chain_id": "0x0127", "contract_id": "0.0.2", "created_contract_ids": [\ "0.0.2"\ ], "error_message": "Out of gas", "failed_initcode": "0x856739", "from": "0x0000000000000000000000000000000000001f41", "function_parameters": "0xbb9f02dc6f0e3289f57a1f33b71c73aa8548ab8b", "gas_consumed": 35000, "gas_limit": 100000, "gas_price": "0x4a817c800", "gas_used": 80000, "hash": "0x3531396130303866616264653464", "max_fee_per_gas": "0x5", "max_priority_fee_per_gas": "0x100", "nonce": 1, "r": "0xd693b532a80fed6392b428604171fb32fdbf953728a3a7ecc7d4062b1652c043", "result": "SUCCESS", "s": "0x24e9c602ac800b983b035700a14b23f78a253ab762deab5dc27e3555a750b355", "status": 1, "timestamp": "1586567700.453054000", "to": "0x0000000000000000000000000000000000001f41", "transaction_index": 1, "type": 2, "v": 1, "logs": [\ {\ "address": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",\ "bloom": null,\ "contract_id": "0.0.2",\ "data": "0x00000000000000000000000000000000000000000000000000000000000000fa",\ "index": 0,\ "topics": [\ "0xf4757a49b326036464bec6fe419a4ae38c8a02ce3e68bf0809674f6aab8ad300"\ ]\ }\ ], "state_changes": [\ {\ "address": "0000000000000000000000000000000000001f41",\ "contract_id": "0.0.2",\ "slot": "0x00000000000000000000000000000000000000000000000000000000000000fa",\ "value_read": "0x97c1fc0a6ed5551bc831571325e9bdb365d06803100dc20648640ba24ce69750",\ "value_written": "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925"\ }\ ] } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-contractidoraddress-results) List contract results from a contract on the network get /api/v1/contracts/{contractIdOrAddress}/results Returns a list of all ContractResults for a contract's function executions. Path parameters contractIdOrAddressstringRequired The ID or hex encoded EVM address (with or without 0x prefix) associated with this contract. Pattern: `^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40})$` Query parameters block.hashstringOptional The block's hash. If multiple values are provided the last value will be the only value used. Example: `{"summary":"--","value":""}`Pattern: `^(eq:)?(0x)?([0-9A-Fa-f]{64}|[0-9A-Fa-f]{96})$` block.numberstringOptional The block's number Example: `{"summary":"--","value":""}`Pattern: `^(eq:)?(\d{1,19}|0x[a-fA-f0-9]+)$` fromstringOptional Account ID or EVM address executing the contract Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}|(0x)?[A-Fa-f0-9]{40}$` internalbooleanOptional Whether to include child transactions or not Default: `false`Example: `true` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` transaction.indexinteger · int32Optional The transaction index in the block Example: `1` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/contracts/{contractIdOrAddress}/results HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/{contractIdOrAddress}/results HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "results": [\ {\ "access_list": "0xabcd",\ "address": "0x25fe26adc577cc89172e6156c9e24f7b9751b762",\ "amount": 10,\ "block_gas_used": 2000,\ "block_hash": "0x6ceecd8bb224da491",\ "block_number": 10,\ "bloom": null,\ "call_result": "0x2b048531b38d2882e86044bc972e940ee0a01938",\ "chain_id": "0x0127",\ "contract_id": "0.0.2",\ "created_contract_ids": [\ "0.0.2"\ ],\ "error_message": "Out of gas",\ "failed_initcode": "0x856739",\ "from": "0x0000000000000000000000000000000000001f41",\ "function_parameters": "0xbb9f02dc6f0e3289f57a1f33b71c73aa8548ab8b",\ "gas_consumed": 35000,\ "gas_limit": 100000,\ "gas_price": "0x4a817c800",\ "gas_used": 80000,\ "hash": "0xfebbaa29c513d124a6377246ea3506ad917d740c21a88f61a1c55ba338fc2bb1",\ "max_fee_per_gas": "0x5",\ "max_priority_fee_per_gas": "0x100",\ "nonce": 1,\ "r": "0xd693b532a80fed6392b428604171fb32fdbf953728a3a7ecc7d4062b1652c043",\ "result": "SUCCESS",\ "s": "0x24e9c602ac800b983b035700a14b23f78a253ab762deab5dc27e3555a750b355",\ "status": 1,\ "timestamp": "1586567700.453054000",\ "to": "0x0000000000000000000000000000000000001f41",\ "transaction_index": 1,\ "type": 2,\ "v": 1\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-contractidoraddress-state) The contract state from a contract on the network get /api/v1/contracts/{contractIdOrAddress}/state Returns a list of all contract's slots. If no timestamp is provided, returns the current state. Path parameters contractIdOrAddressstringRequired The ID or hex encoded EVM address (with or without 0x prefix) associated with this contract. Pattern: `^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40})$` Query parameters limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` slotstringOptional The slot's number Example: `{"summary":"--","value":""}`Pattern: `^((eq|gte?|lte?)\:)?(0x)?[0-9A-Fa-f]{1,64}$` timestampstring\[\]Optional The consensus timestamp of the contract state as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/contracts/{contractIdOrAddress}/state HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/{contractIdOrAddress}/state HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "state": [\ {\ "address": "0000000000000000000000000000000000001f41",\ "contract_id": "0.0.2",\ "timestamp": "1586567700.453054000",\ "slot": "0x00000000000000000000000000000000000000000000000000000000000000fa",\ "value": "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925"\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-results-1) List contract results from all contracts on the network get /api/v1/contracts/results Returns a list of all ContractResults for all contract's function executions. Query parameters fromstringOptional Account ID or EVM address executing the contract Pattern: `^\d{1,10}\.\d{1,10}\.\d{1,10}|(0x)?[A-Fa-f0-9]{40}$` block.hashstringOptional The block's hash. If multiple values are provided the last value will be the only value used. Example: `{"summary":"--","value":""}`Pattern: `^(eq:)?(0x)?([0-9A-Fa-f]{64}|[0-9A-Fa-f]{96})$` block.numberstringOptional The block's number Example: `{"summary":"--","value":""}`Pattern: `^(eq:)?(\d{1,19}|0x[a-fA-f0-9]+)$` internalbooleanOptional Whether to include child transactions or not Default: `false`Example: `true` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` transaction.indexinteger · int32Optional The transaction index in the block Example: `1` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/contracts/results HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/results HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "results": [\ {\ "access_list": "0xabcd",\ "address": "0x25fe26adc577cc89172e6156c9e24f7b9751b762",\ "amount": 10,\ "block_gas_used": 2000,\ "block_hash": "0x6ceecd8bb224da491",\ "block_number": 10,\ "bloom": null,\ "call_result": "0x2b048531b38d2882e86044bc972e940ee0a01938",\ "chain_id": "0x0127",\ "contract_id": "0.0.2",\ "created_contract_ids": [\ "0.0.2"\ ],\ "error_message": "Out of gas",\ "failed_initcode": "0x856739",\ "from": "0x0000000000000000000000000000000000001f41",\ "function_parameters": "0xbb9f02dc6f0e3289f57a1f33b71c73aa8548ab8b",\ "gas_consumed": 35000,\ "gas_limit": 100000,\ "gas_price": "0x4a817c800",\ "gas_used": 80000,\ "hash": "0xfebbaa29c513d124a6377246ea3506ad917d740c21a88f61a1c55ba338fc2bb1",\ "max_fee_per_gas": "0x5",\ "max_priority_fee_per_gas": "0x100",\ "nonce": 1,\ "r": "0xd693b532a80fed6392b428604171fb32fdbf953728a3a7ecc7d4062b1652c043",\ "result": "SUCCESS",\ "s": "0x24e9c602ac800b983b035700a14b23f78a253ab762deab5dc27e3555a750b355",\ "status": 1,\ "timestamp": "1586567700.453054000",\ "to": "0x0000000000000000000000000000000000001f41",\ "transaction_index": 1,\ "type": 2,\ "v": 1\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-results-transactionidorhash-actions) Get the contract actions from a contract on the network for a given transactionId or ethereum transaction hash get /api/v1/contracts/results/{transactionIdOrHash}/actions Returns a list of ContractActions for a contract's function executions for a given transactionId or ethereum transaction hash. Path parameters transactionIdOrHashstringRequired Transaction Id or a 32 byte hash with optional 0x prefix Example: `{"value":"0.0.10-1234567890-000000000"}`Pattern: `^(0x)?[A-Fa-f0-9]{64}|(\d{1,10})\.(\d{1,10})\.(\d{1,10})-(\d{1,19})-(\d{1,9})$` Query parameters indexstringOptional The index of a contract action Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?\d{1,10}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/contracts/results/{transactionIdOrHash}/actions HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/results/{transactionIdOrHash}/actions HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "actions": [\ {\ "call_depth": 1,\ "call_operation_type": "CALL",\ "call_type": "CALL",\ "caller": "0.0.2",\ "caller_type": "ACCOUNT",\ "from": "0x0000000000000000000000000000000000000065",\ "gas": 50000,\ "gas_used": 50000,\ "index": 0,\ "input": "0x123456",\ "recipient": "0.0.2",\ "recipient_type": "ACCOUNT",\ "result_data": "0x123456",\ "result_data_type": "OUTPUT",\ "timestamp": "1586567700.453054000",\ "to": "0x0000000000000000000000000000000000001f41",\ "value": 50000\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-contractidoraddress-results-timestamp) Get the contract result from a contract on the network executed at a given timestamp get /api/v1/contracts/{contractIdOrAddress}/results/{timestamp} Returns a single ContractResult for a contract's function executions at a specific timestamp. Path parameters contractIdOrAddressstringRequired The ID or hex encoded EVM address (with or without 0x prefix) associated with this contract. Pattern: `^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40})$` timestampstringRequired The Unix timestamp in seconds.nanoseconds format, the timestamp at which the associated transaction reached consensus. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `1234567890.0000007`Pattern: `^\d{1,10}(.\d{1,9})?$` Responses 200 OK application/json Responseall of objectOptional Show properties 206 Partial Content application/json 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/contracts/{contractIdOrAddress}/results/{timestamp} HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/{contractIdOrAddress}/results/{timestamp} HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "access_list": "0xabcd", "address": "0x25fe26adc577cc89172e6156c9e24f7b9751b762", "amount": 10, "block_gas_used": 2000, "block_hash": "0x6ceecd8bb224da491", "block_number": 10, "bloom": null, "call_result": "0x2b048531b38d2882e86044bc972e940ee0a01938", "chain_id": "0x0127", "contract_id": "0.0.2", "created_contract_ids": [\ "0.0.2"\ ], "error_message": "Out of gas", "failed_initcode": "0x856739", "from": "0x0000000000000000000000000000000000001f41", "function_parameters": "0xbb9f02dc6f0e3289f57a1f33b71c73aa8548ab8b", "gas_consumed": 35000, "gas_limit": 100000, "gas_price": "0x4a817c800", "gas_used": 80000, "hash": "0x3531396130303866616264653464", "max_fee_per_gas": "0x5", "max_priority_fee_per_gas": "0x100", "nonce": 1, "r": "0xd693b532a80fed6392b428604171fb32fdbf953728a3a7ecc7d4062b1652c043", "result": "SUCCESS", "s": "0x24e9c602ac800b983b035700a14b23f78a253ab762deab5dc27e3555a750b355", "status": 1, "timestamp": "1586567700.453054000", "to": "0x0000000000000000000000000000000000001f41", "transaction_index": 1, "type": 2, "v": 1, "logs": [\ {\ "address": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",\ "bloom": null,\ "contract_id": "0.0.2",\ "data": "0x00000000000000000000000000000000000000000000000000000000000000fa",\ "index": 0,\ "topics": [\ "0xf4757a49b326036464bec6fe419a4ae38c8a02ce3e68bf0809674f6aab8ad300"\ ]\ }\ ], "state_changes": [\ {\ "address": "0000000000000000000000000000000000001f41",\ "contract_id": "0.0.2",\ "slot": "0x00000000000000000000000000000000000000000000000000000000000000fa",\ "value_read": "0x97c1fc0a6ed5551bc831571325e9bdb365d06803100dc20648640ba24ce69750",\ "value_written": "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925"\ }\ ] } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-contractidoraddress-results-logs) List contract logs from a contract on the network get /api/v1/contracts/{contractIdOrAddress}/results/logs 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. ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#) 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 ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#) 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. Path parameters contractIdOrAddressstringRequired The ID or hex encoded EVM address (with or without 0x prefix) associated with this contract. Pattern: `^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40})$` Query parameters indexstringOptional Contract log index Example: `{"summary":"--","value":""}`Pattern: `^((eq|gt|gte|lt|lte):)?\d{1,10}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` topic0string\[\]Optional The first topic associated with a contract log. Requires a timestamp range also be populated. topic1string\[\]Optional The second topic associated with a contract log. Requires a timestamp range also be populated. topic2string\[\]Optional The third topic associated with a contract log. Requires a timestamp range also be populated. topic3string\[\]Optional The fourth topic associated with a contract log. Requires a timestamp range also be populated. Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/contracts/{contractIdOrAddress}/results/logs HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/{contractIdOrAddress}/results/logs HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "logs": [\ {\ "address": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",\ "bloom": null,\ "contract_id": "0.0.2",\ "data": "0x00000000000000000000000000000000000000000000000000000000000000fa",\ "index": 0,\ "topics": [\ "0xf4757a49b326036464bec6fe419a4ae38c8a02ce3e68bf0809674f6aab8ad300"\ ],\ "block_hash": "0x553f9311833391c0a3b2f9ed64540a89f2190a511986cd94889f1c0cf7fa63e898b1c6730f14a61755d1fb4ca05fb073",\ "block_number": 10,\ "root_contract_id": null,\ "timestamp": "1586567700.453054000",\ "transaction_hash": "0x397022d1e5baeb89d0ab66e6bf602640610e6fb7e55d78638db861e2c6339aa9",\ "transaction_index": 1\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-results-logs) List contracts logs across many contracts on the network get /api/v1/contracts/results/logs 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. ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#) 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 ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#) 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. Query parameters indexstringOptional Contract log index Example: `{"summary":"--","value":""}`Pattern: `^((eq|gt|gte|lt|lte):)?\d{1,10}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` orderundefined · enumOptional The order in which items are listed Default: `desc`Example: `asc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` topic0string\[\]Optional The first topic associated with a contract log. Requires a timestamp range also be populated. topic1string\[\]Optional The second topic associated with a contract log. Requires a timestamp range also be populated. topic2string\[\]Optional The third topic associated with a contract log. Requires a timestamp range also be populated. topic3string\[\]Optional The fourth topic associated with a contract log. Requires a timestamp range also be populated. transaction.hashstringOptional A hex encoded 32-byte ethereum transaction hash or 48-byte hedera transaction hash. Example: `{"value":"ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef"}`Pattern: `^(eq:)?(0x)?([0-9A-Fa-f]{64}|[0-9A-Fa-f]{96})$` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/contracts/results/logs HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/results/logs HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "logs": [\ {\ "address": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",\ "bloom": null,\ "contract_id": "0.0.2",\ "data": "0x00000000000000000000000000000000000000000000000000000000000000fa",\ "index": 0,\ "topics": [\ "0xf4757a49b326036464bec6fe419a4ae38c8a02ce3e68bf0809674f6aab8ad300"\ ],\ "block_hash": "0x553f9311833391c0a3b2f9ed64540a89f2190a511986cd94889f1c0cf7fa63e898b1c6730f14a61755d1fb4ca05fb073",\ "block_number": 10,\ "root_contract_id": null,\ "timestamp": "1586567700.453054000",\ "transaction_hash": "0x397022d1e5baeb89d0ab66e6bf602640610e6fb7e55d78638db861e2c6339aa9",\ "transaction_index": 1\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#get-api-v1-contracts-results-transactionidorhash-opcodes) Get the opcode traces for a historical transaction on the network with the given transaction ID or hash get /api/v1/contracts/results/{transactionIdOrHash}/opcodes 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. Path parameters transactionIdOrHashstringRequired Transaction Id or a 32 byte hash with optional 0x prefix Example: `{"value":"0.0.10-1234567890-000000000"}`Pattern: `^(0x)?[A-Fa-f0-9]{64}|(\d{1,10})\.(\d{1,10})\.(\d{1,10})-(\d{1,19})-(\d{1,9})$` Query parameters stackbooleanOptional If provided and set to false, stack information will not be included in the response Default: `true`Example: `true` memorybooleanOptional If provided and set to true, memory information will be included in the response Default: `false`Example: `false` storagebooleanOptional If provided and set to true, storage information will be included in the response Default: `false`Example: `false` Responses 200 OK application/json Responseobject Show properties 400 Validation error application/json 404 Transaction or record file not found application/json 429 Too many requests application/json get /api/v1/contracts/results/{transactionIdOrHash}/opcodes HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/contracts/results/{transactionIdOrHash}/opcodes HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "address": "binary", "contract_id": "0.0.2", "failed": true, "gas": 1, "opcodes": [\ {\ "depth": 1,\ "gas": 1,\ "gas_cost": 1,\ "memory": [\ "binary"\ ],\ "op": "text",\ "pc": 1,\ "reason": "binary",\ "stack": [\ "binary"\ ],\ "storage": {\ "ANY_ADDITIONAL_PROPERTY": "binary"\ }\ }\ ], "return_value": "binary" } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/smart-contracts#post-api-v1-contracts-call) Invoke a smart contract post /api/v1/contracts/call 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](https://github.com/hiero-ledger/hiero-mirror-node/blob/main/docs/web3/README.md#supported/unsupported-operations) The operations types which are not currently supported should return 501 error status. Body blockstring | nullableOptional Hexadecimal block number or the string "latest", "pending", "earliest". Defaults to "latest". Example: `latest`Pattern: `^((0x)?[0-9a-fA-F]+|(earliest|pending|latest))$` datastring · binary | nullableOptional Hexadecimal method signature and encoded parameters. Up to 131072 bytes as at most 262146 hexadecimal digits including optional leading 0x. Example: `0x47f1aae7`Pattern: `^(0x)?[0-9a-fA-F]+$` estimateboolean | nullableOptional Whether gas estimation is called. Defaults to false. Example: `true` fromstring · binary | nullableOptional The 20-byte hexadecimal EVM address the transaction is sent from. Example: `00000000000000000000000000000000000004e2`Pattern: `^(0x)?[A-Fa-f0-9]{40}$` gasinteger · int64 | nullableOptional Gas provided for the transaction execution. Defaults to 15000000. Example: `15000000` gasPriceinteger · int64 | nullableOptional Gas price used for each paid gas. Example: `100000000` tostring · binary · min: 40 · max: 42Required The 20-byte hexadecimal EVM address the transaction is directed to. Example: `0xd9d0c5c0ff85758bdf05a7636f8036d4d065f5b6`Pattern: `^(0x)?[A-Fa-f0-9]{40}$` valueinteger · int64 | nullableOptional Value sent with this transaction. Defaults to 0. Example: `0` Responses 200 OK application/json Responseobject Show properties 400 Validation error application/json 404 Not found error application/json 415 Unsupported media type error application/json 429 Too many requests application/json 500 Generic error application/json 501 Not implemented error application/json post /api/v1/contracts/call HTTP HTTPcURLJavaScriptPython Copy POST /api/v1/contracts/call HTTP/1.1 Host: Content-Type: application/json Accept: */* Content-Length: 200 { "block": "latest", "data": "0x47f1aae7", "estimate": true, "from": "00000000000000000000000000000000000004e2", "gas": 15000000, "gasPrice": 100000000, "to": "0xd9d0c5c0ff85758bdf05a7636f8036d4d065f5b6", "value": 0 } Test it 200 OK Copy { "result": "0x0000000000006d8d" } [PreviousSchedule Transactions](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/schedule-transactions) [NextTokens](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/tokens) Last updated 17 days ago Was this helpful? --- # Network | Hedera [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/network#overview) Overview ---------------------------------------------------------------------------------------- The **Network Object** in the Hedera Mirror Node REST API allows developers to query **network-related information**, such as network supply, fees, exchange rates, and node details. These object are essential for monitoring network status, estimating transaction costs, and retrieving staking information. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/network#endpoints) Endpoints ------------------------------------------------------------------------------------------ The following endpoints are available for the Network object: Endpoint Description `GET /api/v1/network/supply` Retrieves the current total supply of HBAR. `GET /api/v1/network/fees` Fetches the latest transaction fee schedules. `GET /api/v1/network/exchangerate` Retrieves exchange rates to estimate transaction costs. `GET /api/v1/network/nodes` Lists the network address book nodes. `GET /api/v1/network/stake` Fetches staking-related information. [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/network#network) Network -------------------------------------------------------------------------------------- ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/network#get-api-v1-network-supply) Get the network supply get /api/v1/network/supply Returns the network's released supply of hbars Query parameters timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json get /api/v1/network/supply HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/network/supply HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "released_supply": "3999999999999999949", "timestamp": null, "total_supply": "5000000000000000000" } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/network#get-api-v1-network-fees) Get the network fees get /api/v1/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. Query parameters orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json 500 Service Unavailable application/json get /api/v1/network/fees HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/network/fees HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "fees": [\ {\ "gas": 1,\ "transaction_type": "text"\ }\ ], "timestamp": "1586567700.453054000" } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/network#get-api-v1-network-exchangerate) Get the network exchange rate to estimate costs get /api/v1/network/exchangerate Returns the network's exchange rate, current and next. Query parameters timestampstring\[\]Optional The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See [unixtimestamp.com](https://www.unixtimestamp.com/) for a simple way to convert a date to the 'seconds' part of the Unix time. Example: `{"summary":"--","value":""}` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json 404 Not Found application/json 500 Service Unavailable application/json get /api/v1/network/exchangerate HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/network/exchangerate HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "current_rate": { "cent_equivalent": 596987, "expiration_time": 1649689200, "hbar_equivalent": 30000 }, "next_rate": { "cent_equivalent": 596987, "expiration_time": 1649689200, "hbar_equivalent": 30000 }, "timestamp": "1586567700.453054000" } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/network#get-api-v1-network-nodes) Get the network address book nodes get /api/v1/network/nodes Returns the network's list of nodes used in consensus Query parameters file.idstringOptional The ID of the file entity Example: `{"summary":"--","value":""}`Pattern: `^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$` limitinteger · int32 · min: 1 · max: 100Optional The maximum number of items to return Default: `25`Example: `2` node.idstringOptional The ID of the node Example: `{"summary":"--","value":""}`Pattern: `^((eq|gt|gte|lt|lte):)?\d{1,19}$` orderundefined · enumOptional The order in which items are listed Default: `asc`Example: `desc`Possible values: `asc``desc` Responses 200 OK application/json Responseobject Show properties 400 Invalid parameter application/json get /api/v1/network/nodes HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/network/nodes HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "nodes": [\ {\ "admin_key": {\ "_type": "ED25519",\ "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"\ },\ "decline_reward": false,\ "description": "address book 1",\ "file_id": "0.0.102",\ "max_stake": 50000,\ "memo": "0.0.4",\ "min_stake": 1000,\ "node_account_id": "0.0.4",\ "node_cert_hash": "0x01d173753810c0aae794ba72d5443c292e9ff962b01046220dd99f5816422696e0569c977e2f169e1e5688afc8f4aa16",\ "node_id": 1,\ "public_key": "0x4a5ad514f0957fa170a676210c9bdbddf3bc9519702cf915fa6767a40463b96f",\ "reward_rate_start": 1000000,\ "service_endpoints": [\ {\ "ip_address_v4": "128.0.0.6",\ "port": 50216\ }\ ],\ "stake": 20000,\ "stake_not_rewarded": 19900,\ "stake_rewarded": 100,\ "staking_period": {\ "from": "1655164800.000000000",\ "to": "1655251200.000000000"\ },\ "timestamp": {\ "from": "187654.000123457",\ "to": null\ }\ }\ ], "links": { "next": null } } ### [](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/network#get-api-v1-network-stake) Get network stake information get /api/v1/network/stake Returns the network's current stake information. Responses 200 OK application/json ResponseobjectExample: `{"max_stake_rewarded":10,"max_staking_reward_rate_per_hbar":17808,"max_total_reward":20,"node_reward_fee_fraction":1,"reserved_staking_rewards":30,"reward_balance_threshold":40,"stake_total":35000000000000000,"staking_period":{"from":"1655164800.000000000","to":"1655251200.000000000"},"staking_period_duration":1440,"staking_periods_stored":365,"staking_reward_fee_fraction":1,"staking_reward_rate":100000000000,"staking_start_threshold":25000000000000000,"unreserved_staking_reward_balance":50}` Show properties 400 Invalid parameter application/json 404 Not Found application/json 500 Service Unavailable application/json get /api/v1/network/stake HTTP HTTPcURLJavaScriptPython Copy GET /api/v1/network/stake HTTP/1.1 Host: Accept: */* Test it 200 OK Copy { "max_stake_rewarded": 10, "max_staking_reward_rate_per_hbar": 17808, "max_total_reward": 20, "node_reward_fee_fraction": 1, "reserved_staking_rewards": 30, "reward_balance_threshold": 40, "stake_total": 35000000000000000, "staking_period": { "from": "1655164800.000000000", "to": "1655251200.000000000" }, "staking_period_duration": 1440, "staking_periods_stored": 365, "staking_reward_fee_fraction": 1, "staking_reward_rate": 100000000000, "staking_start_threshold": 25000000000000000, "unreserved_staking_reward_balance": 50 } [PreviousTransactions](https://docs.hedera.com/hedera/sdks-and-apis/rest-api/transactions) [NextHedera Consensus Service gRPC API](https://docs.hedera.com/hedera/sdks-and-apis/hedera-consensus-service-api) Last updated 2 months ago Was this helpful? ---