> For the complete documentation index, see [llms.txt](https://docs.zetrix.com/en/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zetrix.com/en/developer-resources/blockchain-as-a-services-baas/zetrix-service/core.md).

# 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

> 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

```json
{"openapi":"3.1.0","info":{"title":"Zetrix Microservice API","version":"1.0.0"},"tags":[{"name":"Core","description":"Blockchain network monitoring endpoints. Retrieve block height, blockchain statistics, node lists, node counts by geography, total ZTX supply, and circulating supply."}],"servers":[{"url":"https://api-sandbox.zetrix.com","description":"Sandbox Environment – Use this for development and testing."}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer access token. Include in all requests as: `Authorization: Bearer <your_access_token>`"}},"parameters":{"X-API-Key":{"name":"X-API-Key","in":"header","required":true,"description":"API key for authentication. Include in all requests.","schema":{"type":"string"}}},"schemas":{"ResponseWrapperLong":{"type":"object","properties":{"object":{"type":"integer","format":"int64","description":"The numeric value (e.g., block height)."},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ResponseMessage"}},"success":{"type":"boolean"},"timestamp":{"type":"string","format":"date-time"},"traceId":{"type":"string"}}},"ResponseMessage":{"type":"object","description":"A response message indicating informational, warning, or error details.","properties":{"type":{"type":"string","description":"Severity: `INFO`, `WARNING`, or `ERROR`.","enum":["INFO","ERROR","WARNING"]},"errorCode":{"type":"integer","format":"int32","description":"Numeric error code (0 = no error)."},"message":{"type":"string","description":"Human-readable description."}}}}},"paths":{"/ztx/core/block-height":{"get":{"tags":["Core"],"summary":"Get current block height","operationId":"getBlockHeight","description":"Returns the current (latest) block height of the Zetrix blockchain. The block height is a sequential integer representing the most recently confirmed block.\n\n**Use Cases:**\n- Verify the network is active and progressing\n- Use as a reference point for auditing transaction timing\n- Monitor chain health during integration testing","parameters":[{"$ref":"#/components/parameters/X-API-Key"}],"responses":{"200":{"description":"Current block height.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseWrapperLong"}}}}}}}}}
```

## Get blockchain overview

> 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

```json
{"openapi":"3.1.0","info":{"title":"Zetrix Microservice API","version":"1.0.0"},"tags":[{"name":"Core","description":"Blockchain network monitoring endpoints. Retrieve block height, blockchain statistics, node lists, node counts by geography, total ZTX supply, and circulating supply."}],"servers":[{"url":"https://api-sandbox.zetrix.com","description":"Sandbox Environment – Use this for development and testing."}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer access token. Include in all requests as: `Authorization: Bearer <your_access_token>`"}},"parameters":{"X-API-Key":{"name":"X-API-Key","in":"header","required":true,"description":"API key for authentication. Include in all requests.","schema":{"type":"string"}}},"schemas":{"ResponseWrapperDSMonitoringBlockchain":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/DSMonitoringBlockchain"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ResponseMessage"}},"success":{"type":"boolean"},"timestamp":{"type":"string","format":"date-time"},"traceId":{"type":"string"}}},"DSMonitoringBlockchain":{"type":"object","description":"Comprehensive blockchain network statistics.","properties":{"chainId":{"type":"integer","format":"int64"},"chainName":{"type":"string"},"blockchainHeight":{"type":"integer","format":"int64"},"transactionNum":{"type":"integer","format":"int64"},"accountNum":{"type":"integer","format":"int64"},"txTpsMax":{"type":"integer","format":"int32"},"currentTps":{"type":"integer","format":"int32"},"txNumLastDay":{"type":"integer","format":"int64"},"blockAverageGeneTime":{"type":"integer","format":"int32"},"netStatus":{"type":"string"},"lastLedgerList":{"type":"array","items":{"$ref":"#/components/schemas/DSMonitoringLedger"}},"lastTxList":{"type":"array","items":{"$ref":"#/components/schemas/DSMonitoringTx"}}}},"DSMonitoringLedger":{"type":"object","properties":{"seq":{"type":"integer","format":"int64","description":"Block sequence number."},"txNum":{"type":"integer","format":"int64","description":"Transactions in this block."},"ledgerAge":{"type":"integer","format":"int64","description":"Age in milliseconds."}}},"DSMonitoringTx":{"type":"object","properties":{"senderAddress":{"type":"string"},"txHash":{"type":"string"},"txTime":{"type":"integer","format":"int64"}}},"ResponseMessage":{"type":"object","description":"A response message indicating informational, warning, or error details.","properties":{"type":{"type":"string","description":"Severity: `INFO`, `WARNING`, or `ERROR`.","enum":["INFO","ERROR","WARNING"]},"errorCode":{"type":"integer","format":"int32","description":"Numeric error code (0 = no error)."},"message":{"type":"string","description":"Human-readable description."}}}}},"paths":{"/ztx/core/blockchain-info":{"get":{"tags":["Core"],"summary":"Get blockchain overview","operationId":"getBlockchainInfo","description":"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.\n\n**Returned Metrics:**\n- `blockchainHeight` — Current block height\n- `transactionNum` — Total transactions on-chain\n- `accountNum` — Total accounts created\n- `txTpsMax` / `currentTps` — Maximum and current transactions per second\n- `blockAverageGeneTime` — Average block generation time in milliseconds\n- `netStatus` — Network health status (`NORMAL`, `DEGRADED`)\n- `lastLedgerList` — Most recent blocks\n- `lastTxList` — Most recent transactions","parameters":[{"$ref":"#/components/parameters/X-API-Key"}],"responses":{"200":{"description":"Blockchain overview and statistics.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseWrapperDSMonitoringBlockchain"}}}}}}}}}
```

## Get node statistics

> 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

```json
{"openapi":"3.1.0","info":{"title":"Zetrix Microservice API","version":"1.0.0"},"tags":[{"name":"Core","description":"Blockchain network monitoring endpoints. Retrieve block height, blockchain statistics, node lists, node counts by geography, total ZTX supply, and circulating supply."}],"servers":[{"url":"https://api-sandbox.zetrix.com","description":"Sandbox Environment – Use this for development and testing."}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer access token. Include in all requests as: `Authorization: Bearer <your_access_token>`"}},"parameters":{"X-API-Key":{"name":"X-API-Key","in":"header","required":true,"description":"API key for authentication. Include in all requests.","schema":{"type":"string"}}},"schemas":{"ResponseWrapperDSMonitoringNodeStatWrapper":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/DSMonitoringNodeStatWrapper"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ResponseMessage"}},"success":{"type":"boolean"},"timestamp":{"type":"string","format":"date-time"},"traceId":{"type":"string"}}},"DSMonitoringNodeStatWrapper":{"type":"object","properties":{"total":{"type":"integer","format":"int32","description":"Total nodes across all types."},"validatorNodeStat":{"$ref":"#/components/schemas/DSMonitoringNodeStat"},"synchronousNodeStat":{"$ref":"#/components/schemas/DSMonitoringNodeStat"}}},"DSMonitoringNodeStat":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"onlineCount":{"type":"integer","format":"int32"},"offlineCount":{"type":"integer","format":"int32"},"warnCount":{"type":"integer","format":"int32"}}},"ResponseMessage":{"type":"object","description":"A response message indicating informational, warning, or error details.","properties":{"type":{"type":"string","description":"Severity: `INFO`, `WARNING`, or `ERROR`.","enum":["INFO","ERROR","WARNING"]},"errorCode":{"type":"integer","format":"int32","description":"Numeric error code (0 = no error)."},"message":{"type":"string","description":"Human-readable description."}}}}},"paths":{"/ztx/core/node-stat":{"get":{"tags":["Core"],"summary":"Get node statistics","operationId":"getNodeStat","description":"Returns aggregated statistics for all validator and synchronous nodes on the Zetrix network.\n\n**Returned Data:**\n- `total` — Total number of nodes\n- `validatorNodeStat` — Online/offline/warning counts for validator nodes\n- `synchronousNodeStat` — Online/offline/warning counts for sync nodes\n\n**Use Cases:**\n- Monitor network health and node availability\n- Alert on high offline or warning node counts","parameters":[{"$ref":"#/components/parameters/X-API-Key"}],"responses":{"200":{"description":"Node statistics for validator and synchronous nodes.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseWrapperDSMonitoringNodeStatWrapper"}}}}}}}}}
```

## Get paginated node list

> 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

```json
{"openapi":"3.1.0","info":{"title":"Zetrix Microservice API","version":"1.0.0"},"tags":[{"name":"Core","description":"Blockchain network monitoring endpoints. Retrieve block height, blockchain statistics, node lists, node counts by geography, total ZTX supply, and circulating supply."}],"servers":[{"url":"https://api-sandbox.zetrix.com","description":"Sandbox Environment – Use this for development and testing."}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer access token. Include in all requests as: `Authorization: Bearer <your_access_token>`"}},"parameters":{"X-API-Key":{"name":"X-API-Key","in":"header","required":true,"description":"API key for authentication. Include in all requests.","schema":{"type":"string"}}},"schemas":{"ResponseWrapperDSMonitoringPagination":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/DSMonitoringPagination"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ResponseMessage"}},"success":{"type":"boolean"},"timestamp":{"type":"string","format":"date-time"},"traceId":{"type":"string"}}},"DSMonitoringPagination":{"type":"object","properties":{"pageNum":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"$ref":"#/components/schemas/DSMonitoringNodeList"}}}},"DSMonitoringNodeList":{"type":"object","description":"Details of an individual blockchain node.","properties":{"nodeName":{"type":"string","description":"Human-readable node name."},"nodeAddress":{"type":"string","description":"Zetrix address of the node."},"consensusAddress":{"type":"string"},"nodeType":{"type":"string","description":"`VALIDATOR` or `SYNCHRONOUS`."},"nodeStatus":{"type":"string","description":"`ONLINE`, `OFFLINE`, or `WARN`."},"operatingSystem":{"type":"string"},"blockSeq":{"type":"string","description":"Latest synced block number."},"blockHash":{"type":"string"},"expirationTime":{"type":"string"},"certEndTime":{"type":"string"},"licenseEndTime":{"type":"string"}}},"ResponseMessage":{"type":"object","description":"A response message indicating informational, warning, or error details.","properties":{"type":{"type":"string","description":"Severity: `INFO`, `WARNING`, or `ERROR`.","enum":["INFO","ERROR","WARNING"]},"errorCode":{"type":"integer","format":"int32","description":"Numeric error code (0 = no error)."},"message":{"type":"string","description":"Human-readable description."}}}}},"paths":{"/ztx/core/node-list":{"get":{"tags":["Core"],"summary":"Get paginated node list","operationId":"getNodeList","description":"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.\n\n**Parameters:**\n- `nodeType` — Filter by type: `VALIDATOR` or `SYNCHRONOUS`\n- `pageNo` — Page number (1-based)\n- `pageSize` — Records per page","parameters":[{"$ref":"#/components/parameters/X-API-Key"},{"name":"nodeType","in":"query","required":true,"description":"Type of node to list. Accepted values: `VALIDATOR`, `SYNCHRONOUS`.","schema":{"type":"string"}},{"name":"pageNo","in":"query","required":true,"description":"Page number (1-based).","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","required":true,"description":"Number of records per page.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Paginated node list.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseWrapperDSMonitoringPagination"}}}}}}}}}
```

## Get node count by geography

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Zetrix Microservice API","version":"1.0.0"},"tags":[{"name":"Core","description":"Blockchain network monitoring endpoints. Retrieve block height, blockchain statistics, node lists, node counts by geography, total ZTX supply, and circulating supply."}],"servers":[{"url":"https://api-sandbox.zetrix.com","description":"Sandbox Environment – Use this for development and testing."}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer access token. Include in all requests as: `Authorization: Bearer <your_access_token>`"}},"parameters":{"X-API-Key":{"name":"X-API-Key","in":"header","required":true,"description":"API key for authentication. Include in all requests.","schema":{"type":"string"}}},"schemas":{"ResponseWrapperListDSMonitoringNode":{"type":"object","properties":{"object":{"type":"array","items":{"$ref":"#/components/schemas/DSMonitoringNode"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ResponseMessage"}},"success":{"type":"boolean"},"timestamp":{"type":"string","format":"date-time"},"traceId":{"type":"string"}}},"DSMonitoringNode":{"type":"object","description":"Node count for a geographic region.","properties":{"geographyCode":{"type":"integer","format":"int32","description":"Numeric ISO country/region code."},"total":{"type":"integer","format":"int32","description":"Number of nodes in this region."}}},"ResponseMessage":{"type":"object","description":"A response message indicating informational, warning, or error details.","properties":{"type":{"type":"string","description":"Severity: `INFO`, `WARNING`, or `ERROR`.","enum":["INFO","ERROR","WARNING"]},"errorCode":{"type":"integer","format":"int32","description":"Numeric error code (0 = no error)."},"message":{"type":"string","description":"Human-readable description."}}}}},"paths":{"/ztx/core/node-count":{"get":{"tags":["Core"],"summary":"Get node count by geography","operationId":"getNodeInfo","description":"Returns the count of blockchain nodes grouped by geography code. Useful for visualizing the geographic distribution of the Zetrix network.\n\n**Response:**\nA list of objects, each with a `geographyCode` (numeric ISO region identifier) and a `total` node count for that region.","parameters":[{"$ref":"#/components/parameters/X-API-Key"}],"responses":{"200":{"description":"Node counts grouped by geography code.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseWrapperListDSMonitoringNode"}}}}}}}}}
```

## Get total ZTX supply

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Zetrix Microservice API","version":"1.0.0"},"tags":[{"name":"Core","description":"Blockchain network monitoring endpoints. Retrieve block height, blockchain statistics, node lists, node counts by geography, total ZTX supply, and circulating supply."}],"servers":[{"url":"https://api-sandbox.zetrix.com","description":"Sandbox Environment – Use this for development and testing."}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer access token. Include in all requests as: `Authorization: Bearer <your_access_token>`"}},"parameters":{"X-API-Key":{"name":"X-API-Key","in":"header","required":true,"description":"API key for authentication. Include in all requests.","schema":{"type":"string"}}}},"paths":{"/ztx/core/total-supply":{"get":{"tags":["Core"],"summary":"Get total ZTX supply","operationId":"getTotalSupply","description":"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.\n\n**Note:** Returns a string to preserve precision for large integer values.","parameters":[{"$ref":"#/components/parameters/X-API-Key"}],"responses":{"200":{"description":"Total ZTX token supply as a string.","content":{"*/*":{"schema":{"type":"string"}}}}}}}}}
```

## Get circulating ZTX supply

> 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.

```json
{"openapi":"3.1.0","info":{"title":"Zetrix Microservice API","version":"1.0.0"},"tags":[{"name":"Core","description":"Blockchain network monitoring endpoints. Retrieve block height, blockchain statistics, node lists, node counts by geography, total ZTX supply, and circulating supply."}],"servers":[{"url":"https://api-sandbox.zetrix.com","description":"Sandbox Environment – Use this for development and testing."}],"security":[{"Authorization":[]}],"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer access token. Include in all requests as: `Authorization: Bearer <your_access_token>`"}},"parameters":{"X-API-Key":{"name":"X-API-Key","in":"header","required":true,"description":"API key for authentication. Include in all requests.","schema":{"type":"string"}}}},"paths":{"/ztx/core/circulation-supply":{"get":{"tags":["Core"],"summary":"Get circulating ZTX supply","operationId":"getCirculationSupply","description":"Returns the current circulating supply of ZTX tokens — the amount actively in circulation, excluding locked, burned, or reserved tokens.\n\n**Note:** Returns a string to preserve precision for large integer values.","parameters":[{"$ref":"#/components/parameters/X-API-Key"}],"responses":{"200":{"description":"Current circulating ZTX supply as a string.","content":{"*/*":{"schema":{"type":"string"}}}}}}}}}
```