General

Get ledger info

Changed on

Get the latest ledger information, including data such as chain ID, role type, ledger versions, epoch, etc.

get/

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/
  • Auth
    none declared

Response

chain_idinteger required

Chain ID of the current chain

epochstring uint64 required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

ledger_versionstring uint64 required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

oldest_ledger_versionstring uint64 required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

ledger_timestampstring uint64 required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

node_role'validator' | 'full_node' required
oldest_block_heightstring uint64 required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

block_heightstring uint64 required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

git_hashstring

Git hash of the build of the API endpoint. Can be used to determine the exact software version used by the API endpoint.

Example response

{
  "epoch": "32425224034",
  "ledger_version": "32425224034",
  "oldest_ledger_version": "32425224034",
  "ledger_timestamp": "32425224034",
  "oldest_block_height": "32425224034",
  "block_height": "32425224034"
}

Changes

  • 5bfbbc5f3ce7Revision changes
    • breaking

      the mandatory response header X-APTOS-BLOCK-HEIGHT removed for the status 200

    • breaking

      the mandatory response header X-APTOS-CHAIN-ID removed for the status 200

    • breaking

      the mandatory response header X-APTOS-EPOCH removed for the status 200

    • breaking

      the mandatory response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 200

    • breaking

      the mandatory response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 200

    • breaking

      the mandatory response header X-APTOS-LEDGER-VERSION removed for the status 200

    • breaking

      the mandatory response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 200

    • warning

      the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 400

    • warning

      the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 403

    • warning

      the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 500

    • warning

      the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 503

    • warning

      the optional response header X-APTOS-CHAIN-ID removed for the status 400

    • warning

      the optional response header X-APTOS-CHAIN-ID removed for the status 403

    • warning

      the optional response header X-APTOS-CHAIN-ID removed for the status 500

    • warning

      the optional response header X-APTOS-CHAIN-ID removed for the status 503

    • warning

      the optional response header X-APTOS-CURSOR removed for the status 200

    • warning

      the optional response header X-APTOS-EPOCH removed for the status 400

    • warning

      the optional response header X-APTOS-EPOCH removed for the status 403

    • warning

      the optional response header X-APTOS-EPOCH removed for the status 500

    • warning

      the optional response header X-APTOS-EPOCH removed for the status 503

    • warning

      the optional response header X-APTOS-GAS-USED removed for the status 200

    • warning

      the optional response header X-APTOS-GAS-USED removed for the status 400

    • warning

      the optional response header X-APTOS-GAS-USED removed for the status 403

    • warning

      the optional response header X-APTOS-GAS-USED removed for the status 500

    • warning

      the optional response header X-APTOS-GAS-USED removed for the status 503

    • warning

      the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 400

    • warning

      the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 403

    • warning

      the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 500

    • warning

      the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 503

    • warning

      the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 400

    • warning

      the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 403

    • warning

      the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 500

    • warning

      the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 503

    • warning

      the optional response header X-APTOS-LEDGER-VERSION removed for the status 400

    • warning

      the optional response header X-APTOS-LEDGER-VERSION removed for the status 403

    • warning

      the optional response header X-APTOS-LEDGER-VERSION removed for the status 500

    • warning

      the optional response header X-APTOS-LEDGER-VERSION removed for the status 503

    • warning

      the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 400

    • warning

      the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 403

    • warning

      the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 500

    • warning

      the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 503

  • 6a8502f67ac1Revision changes
    • warning

      added the new rejected_by_filter enum value to the response property for the response status

    • warning

      added the new rejected_by_filter enum value to the response property for the response status

    • warning

      added the new rejected_by_filter enum value to the response property for the response status

    • warning

      added the new rejected_by_filter enum value to the response property for the response status