Information

GET /network/information

status: stable

Responses

  • 406 application/json

    Not Acceptable

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Accept' header.

    • code string Required

      Value is not_acceptable.

  • 200 application/json

    Ok

    Hide response attributes Show response attributes object
    • sync_progress object Required

      Estimated synchronization progress of the node with the underlying network. Note that this may change quite arbitrarily as the node may switch to shorter or longer chain forks.

      Hide sync_progress attributes Show sync_progress attributes object
      • status string Required

        Values are ready, syncing, or not_responding.

      • progress object

        if: status == syncing

        Hide progress attributes Show progress attributes object
        • quantity number Required

          Minimum value is 0, maximum value is 100.

        • unit string Required

          Value is percent.

    • node_tip object Required

      Underlying node's tip

      Hide node_tip attributes Show node_tip attributes object
      • absolute_slot_number integer Required

        The 0-based slot index starting from genesis of the blockchain.

        Minimum value is 0.

      • slot_number integer Required

        The zero-based slot index within an epoch.

        Minimum value is 0.

      • epoch_number integer Required

        An epoch is a time period which is divided into slots.

        Minimum value is 0.

      • time string(iso-8601-date-and-time) Required
      • height object Required
        Hide height attributes Show height attributes object
        • quantity integer Required

          Minimum value is 0.

        • unit string Required

          Value is block.

    • The time slot corresponding the network tip.

      Hide network_tip attributes Show network_tip attributes object
      • absolute_slot_number integer Required

        The 0-based slot index starting from genesis of the blockchain.

        Minimum value is 0.

      • epoch_number integer Required

        An epoch is a time period which is divided into slots.

        Minimum value is 0.

      • slot_number integer Required

        The zero-based slot index within an epoch.

        Minimum value is 0.

      • time string(iso-8601-date-and-time) Required
    • Hide next_epoch attributes Show next_epoch attributes object
      • epoch_number integer Required

        An epoch is a time period which is divided into slots.

        Minimum value is 0.

      • epoch_start_time string(iso-8601-date-and-time) Required
    • node_era string Required

      Values are byron, shelley, allegra, mary, alonzo, babbage, or conway.

    • network_info object Required
      Hide network_info attributes Show network_info attributes object
      • protocol_magic integer Required

        The unique magic number defining the network the wallet is working on.

      • network_id string Required

        A name just distinguishing mainnet from testnets

        Values are mainnet or testnet.

    • wallet_mode string Required

      Values are light or node.

GET /network/information
curl \
 --request GET https://localhost:8090/v2/network/information
Response examples (406)
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (200)
{
  "sync_progress": {
    "status": "ready"
  },
  "node_tip": {
    "absolute_slot_number": 8086,
    "slot_number": 1337,
    "epoch_number": 14,
    "time": "2019-02-27T14:46:45Z",
    "height": {
      "quantity": 1337,
      "unit": "block"
    }
  },
  "network_tip": {
    "absolute_slot_number": 8086,
    "epoch_number": 14,
    "slot_number": 1337,
    "time": "2019-02-27T14:46:45Z"
  },
  "next_epoch": {
    "epoch_number": 14,
    "epoch_start_time": "2019-02-27T14:46:45Z"
  },
  "node_era": "byron",
  "network_info": {
    "protocol_magic": 42,
    "network_id": "mainnet"
  },
  "wallet_mode": "light"
}