Ctrlk
HomeWebsite
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Core

Blockchain network monitoring endpoints. Retrieve block height, blockchain statistics, node lists, node counts by geography, total ZTX supply, and circulating supply.

Get current block height

get

Returns the current (latest) block height of the Zetrix blockchain. The block height is a sequential integer representing the most recently confirmed block.

Use Cases:

  • Verify the network is active and progressing

  • Use as a reference point for auditing transaction timing

  • Monitor chain health during integration testing

Authorizations
AuthorizationstringRequired

Bearer access token. Include in all requests as: Authorization: Bearer <your_access_token>

Header parameters
X-API-KeystringRequired

API key for authentication. Include in all requests.

Example: ehg7q2i6aN8jY6BbHqN5q42KsHQFRwl260jqAkAU
Responses
200

Current block height.

*/*
objectinteger · int64Optional

The numeric value (e.g., block height).

successbooleanOptional
timestampstring · date-timeOptional
traceIdstringOptional
get/ztx/core/block-height
GET /ztx/core/block-height HTTP/1.1
Host: api-sandbox.zetrix.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: text
Accept: */*
200

Current block height.

{
  "success": true,
  "object": 8472910,
  "messages": [],
  "timestamp": "2026-01-01T10:00:00Z",
  "traceId": "trace-015"
}

Get blockchain overview

get

Returns a comprehensive snapshot of the Zetrix blockchain's current state, including transaction counts, account counts, TPS metrics, average block generation time, and the latest ledgers and transactions.

Returned Metrics:

  • blockchainHeight — Current block height

  • transactionNum — Total transactions on-chain

  • accountNum — Total accounts created

  • txTpsMax / currentTps — Maximum and current transactions per second

  • blockAverageGeneTime — Average block generation time in milliseconds

  • netStatus — Network health status (NORMAL, DEGRADED)

  • lastLedgerList — Most recent blocks

  • lastTxList — Most recent transactions

Authorizations
AuthorizationstringRequired

Bearer access token. Include in all requests as: Authorization: Bearer <your_access_token>

Header parameters
X-API-KeystringRequired

API key for authentication. Include in all requests.

Example: ehg7q2i6aN8jY6BbHqN5q42KsHQFRwl260jqAkAU
Responses
200

Blockchain overview and statistics.

*/*
successbooleanOptional
timestampstring · date-timeOptional
traceIdstringOptional
get/ztx/core/blockchain-info
GET /ztx/core/blockchain-info HTTP/1.1
Host: api-sandbox.zetrix.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: text
Accept: */*
200

Blockchain overview and statistics.

{
  "success": true,
  "object": {
    "chainId": 1,
    "blockchainHeight": 8472910,
    "transactionNum": 1500000,
    "accountNum": 50000,
    "txTpsMax": 1000,
    "currentTps": 12,
    "blockAverageGeneTime": 3000,
    "netStatus": "NORMAL",
    "chainName": "Zetrix Mainnet"
  },
  "messages": [],
  "timestamp": "2026-01-01T10:00:00Z",
  "traceId": "trace-016"
}

Get node statistics

get

Returns aggregated statistics for all validator and synchronous nodes on the Zetrix network.

Returned Data:

  • total — Total number of nodes

  • validatorNodeStat — Online/offline/warning counts for validator nodes

  • synchronousNodeStat — Online/offline/warning counts for sync nodes

Use Cases:

  • Monitor network health and node availability

  • Alert on high offline or warning node counts

Authorizations
AuthorizationstringRequired

Bearer access token. Include in all requests as: Authorization: Bearer <your_access_token>

Header parameters
X-API-KeystringRequired

API key for authentication. Include in all requests.

Example: ehg7q2i6aN8jY6BbHqN5q42KsHQFRwl260jqAkAU
Responses
200

Node statistics for validator and synchronous nodes.

*/*
successbooleanOptional
timestampstring · date-timeOptional
traceIdstringOptional
get/ztx/core/node-stat
GET /ztx/core/node-stat HTTP/1.1
Host: api-sandbox.zetrix.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: text
Accept: */*
200

Node statistics for validator and synchronous nodes.

{
  "success": true,
  "object": {
    "total": 30,
    "validatorNodeStat": {
      "total": 20,
      "onlineCount": 18,
      "offlineCount": 1,
      "warnCount": 1
    },
    "synchronousNodeStat": {
      "total": 10,
      "onlineCount": 10,
      "offlineCount": 0,
      "warnCount": 0
    }
  },
  "messages": [],
  "timestamp": "2026-01-01T10:00:00Z",
  "traceId": "trace-017"
}

Get paginated node list

get

Returns a paginated list of blockchain nodes, filterable by node type. Each entry includes address, status, type, OS, block sync state, and certificate/license expiry.

Parameters:

  • nodeType — Filter by type: VALIDATOR or SYNCHRONOUS

  • pageNo — Page number (1-based)

  • pageSize — Records per page

Authorizations
AuthorizationstringRequired

Bearer access token. Include in all requests as: Authorization: Bearer <your_access_token>

Query parameters
nodeTypestringRequired

Type of node to list. Accepted values: VALIDATOR, SYNCHRONOUS.

Example: VALIDATOR
pageNointeger · int32Required

Page number (1-based).

Example: 1
pageSizeinteger · int32Required

Number of records per page.

Example: 10
Header parameters
X-API-KeystringRequired

API key for authentication. Include in all requests.

Example: ehg7q2i6aN8jY6BbHqN5q42KsHQFRwl260jqAkAU
Responses
200

Paginated node list.

*/*
successbooleanOptional
timestampstring · date-timeOptional
traceIdstringOptional
get/ztx/core/node-list
GET /ztx/core/node-list?nodeType=text&pageNo=1&pageSize=1 HTTP/1.1
Host: api-sandbox.zetrix.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: text
Accept: */*
200

Paginated node list.

{
  "success": true,
  "object": {
    "pageNum": 1,
    "pageSize": 10,
    "total": 20,
    "content": [
      {
        "nodeName": "validator-node-01",
        "nodeAddress": "ZTX3PGkYe55MJdKLMEQDShy5tR1as7kYJFZbU",
        "nodeType": "VALIDATOR",
        "nodeStatus": "ONLINE",
        "blockSeq": "8472910"
      }
    ]
  },
  "messages": [],
  "timestamp": "2026-01-01T10:00:00Z",
  "traceId": "trace-018"
}

Get node count by geography

get

Returns the count of blockchain nodes grouped by geography code. Useful for visualizing the geographic distribution of the Zetrix network.

Response: A list of objects, each with a geographyCode (numeric ISO region identifier) and a total node count for that region.

Authorizations
AuthorizationstringRequired

Bearer access token. Include in all requests as: Authorization: Bearer <your_access_token>

Header parameters
X-API-KeystringRequired

API key for authentication. Include in all requests.

Example: ehg7q2i6aN8jY6BbHqN5q42KsHQFRwl260jqAkAU
Responses
200

Node counts grouped by geography code.

*/*
successbooleanOptional
timestampstring · date-timeOptional
traceIdstringOptional
get/ztx/core/node-count
GET /ztx/core/node-count HTTP/1.1
Host: api-sandbox.zetrix.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: text
Accept: */*
200

Node counts grouped by geography code.

{
  "success": true,
  "object": [
    {
      "geographyCode": 458,
      "total": 12
    },
    {
      "geographyCode": 840,
      "total": 5
    },
    {
      "geographyCode": 156,
      "total": 3
    }
  ],
  "messages": [],
  "timestamp": "2026-01-01T10:00:00Z",
  "traceId": "trace-019"
}

Get total ZTX supply

get

Returns the total supply of ZTX tokens ever created on the Zetrix blockchain — the maximum possible supply including all tokens in circulation, locked, or staked.

Note: Returns a string to preserve precision for large integer values.

Authorizations
AuthorizationstringRequired

Bearer access token. Include in all requests as: Authorization: Bearer <your_access_token>

Header parameters
X-API-KeystringRequired

API key for authentication. Include in all requests.

Example: ehg7q2i6aN8jY6BbHqN5q42KsHQFRwl260jqAkAU
Responses
200

Total ZTX token supply as a string.

*/*
stringOptional
get/ztx/core/total-supply
GET /ztx/core/total-supply HTTP/1.1
Host: api-sandbox.zetrix.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: text
Accept: */*
200

Total ZTX token supply as a string.

10000000000000000

Get circulating ZTX supply

get

Returns the current circulating supply of ZTX tokens — the amount actively in circulation, excluding locked, burned, or reserved tokens.

Note: Returns a string to preserve precision for large integer values.

Authorizations
AuthorizationstringRequired

Bearer access token. Include in all requests as: Authorization: Bearer <your_access_token>

Header parameters
X-API-KeystringRequired

API key for authentication. Include in all requests.

Example: ehg7q2i6aN8jY6BbHqN5q42KsHQFRwl260jqAkAU
Responses
200

Current circulating ZTX supply as a string.

*/*
stringOptional
get/ztx/core/circulation-supply
GET /ztx/core/circulation-supply HTTP/1.1
Host: api-sandbox.zetrix.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: text
Accept: */*
200

Current circulating ZTX supply as a string.

7500000000000000
PreviousZetrix Service
NextTransaction

Last updated