Network

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.

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.

Network

Get the network supply

Returns the network's released supply of hbars

get

/api/v1/network/supply

Query parameters
timestampstring[]

The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.

Responses
curl -L \
  --url '/api/v1/network/supply'
{
  "released_supply": "3999999999999999949",
  "total_supply": "5000000000000000000",
  "timestamp": null
}

OK

Get the network fees

Returns the estimated gas in tinybars per each transaction type. Default order is ASC. Currently only ContractCall, ContractCreate and EthereumTransaction transaction types are supported.

get

/api/v1/network/fees

Query parameters
orderenum

The order in which items are listed

Example: desc
Options: asc, desc
timestampstring[]

The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.

Responses
curl -L \
  --url '/api/v1/network/fees'
{
  "fees": [
    {
      "gas": 1,
      "transaction_type": "text"
    }
  ],
  "timestamp": "1586567700.453054000"
}

OK

Get the network exchange rate to estimate costs

Returns the network's exchange rate, current and next.

get

/api/v1/network/exchangerate

Query parameters
timestampstring[]

The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.

Responses
curl -L \
  --url '/api/v1/network/exchangerate'
{
  "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"
}

OK

Get the network address book nodes

Returns the network's list of nodes used in consensus

get

/api/v1/network/nodes

Query parameters
file.idstring

The ID of the file entity

Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$
limitinteger int32

The maximum number of items to return

Example: 2
node.idstring

The ID of the node

Pattern: ^((eq|gt|gte|lt|lte):)?\d{1,19}$
orderenum

The order in which items are listed

Example: desc
Options: asc, desc
Responses
curl -L \
  --url '/api/v1/network/nodes'
{
  "nodes": [
    {
      "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,
      "stake": 20000,
      "stake_not_rewarded": 19900,
      "stake_rewarded": 100,
      "admin_key": {
        "_type": "ED25519",
        "key": "15706b229b3ba33d4a5a41ff54ce1cfe0a3d308672a33ff382f81583e02bd743"
      },
      "staking_period": {
        "from": "1655164800.000000000",
        "to": "1655251200.000000000"
      },
      "timestamp": {
        "from": "187654.000123457",
        "to": null
      },
      "service_endpoints": [
        {
          "ip_address_v4": "128.0.0.6",
          "port": 50216
        }
      ],
      "x-description-html": "<p>address book 1</p>"
    }
  ],
  "links": {
    "next": null
  }
}

OK

Get network stake information

Returns the network's current stake information.

get

/api/v1/network/stake

Responses
curl -L \
  --url '/api/v1/network/stake'
{
  "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_duration": 1440,
  "staking_periods_stored": 365,
  "staking_reward_fee_fraction": 1,
  "staking_reward_rate": 100000000000,
  "staking_start_threshold": 25000000000000000,
  "unreserved_staking_reward_balance": 50,
  "staking_period": {
    "from": "1655164800.000000000",
    "to": "1655251200.000000000"
  }
}

OK

PreviousTransactionsNextHedera Consensus Service gRPC API

Last updated

Was this helpful?