Aptos · Schema

IndexResponse

The struct holding all data returned to the client by the index endpoint (i.e., GET "/"). Only for responding in JSON

BlockchainWeb3MoveLayer 1CryptocurrencyNFTSmart ContractsDeFiTransactionsAccountsGraphQLgRPC

Properties

Name	Type	Description
chain_id	integer	Chain ID of the current chain
epoch	object
ledger_version	object
oldest_ledger_version	object
ledger_timestamp	object
node_role	object
oldest_block_height	object
block_height	object
git_hash	string	Git hash of the build of the API endpoint. Can be used to determine the exact software version used by the API endpoint.
encryption_key	string	Per-epoch transaction encryption key (hex-encoded)

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/aptos/json-schema/IndexResponse.json",
  "title": "IndexResponse",
  "type": "object",
  "description": "The struct holding all data returned to the client by the\nindex endpoint (i.e., GET \"/\").  Only for responding in JSON",
  "required": [
    "chain_id",
    "epoch",
    "ledger_version",
    "oldest_ledger_version",
    "ledger_timestamp",
    "node_role",
    "oldest_block_height",
    "block_height"
  ],
  "properties": {
    "chain_id": {
      "type": "integer",
      "format": "uint8",
      "description": "Chain ID of the current chain"
    },
    "epoch": {
      "$ref": "#/components/schemas/U64"
    },
    "ledger_version": {
      "$ref": "#/components/schemas/U64"
    },
    "oldest_ledger_version": {
      "$ref": "#/components/schemas/U64"
    },
    "ledger_timestamp": {
      "$ref": "#/components/schemas/U64"
    },
    "node_role": {
      "$ref": "#/components/schemas/RoleType"
    },
    "oldest_block_height": {
      "$ref": "#/components/schemas/U64"
    },
    "block_height": {
      "$ref": "#/components/schemas/U64"
    },
    "git_hash": {
      "type": "string",
      "description": "Git hash of the build of the API endpoint.  Can be used to determine the exact\nsoftware version used by the API endpoint."
    },
    "encryption_key": {
      "type": "string",
      "description": "Per-epoch transaction encryption key (hex-encoded)"
    }
  }
}