system_syncState - Bittensor RPC Method
Get sync progress for a Bittensor node including starting block, current block, and highest known block.
Bittensor RPC endpoint: endpoint URLs, plans and pricing.
Returns the node's current synchronization progress, including the starting block, the current block, and the highest known block. This information is essential for determining whether a Bittensor node is fully synced and ready to serve accurate data.
Parameters
None.
Response
| Field | Type | Description |
|---|---|---|
startingBlock | number | The block number at which the node started syncing (or the warp sync target). |
currentBlock | number | The current block the node has processed. |
highestBlock | number | The highest block number known to the node (from peer announcements). |
The node is fully synced when currentBlock equals or is close to highestBlock.
Code Examples
curl -X POST https://api-bittensor-mainnet.n.dwellir.com/YOUR_API_KEY \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"method": "system_syncState",
"params": [],
"id": 1
}'Use Cases
- Health checks -- Verify that a Bittensor node is fully synced before routing traffic to it. A node with
currentBlockfar belowhighestBlockis still catching up. - Sync progress display -- Show sync progress bars in admin dashboards or monitoring UIs.
- Load balancer gating -- Only add a node to the load balancer pool once
currentBlock >= highestBlock - threshold. - Alert triggers -- Fire alerts when a node falls behind by more than a configurable number of blocks.
Notes
- A fully synced node will have
currentBlockequal to or very close tohighestBlock(within 1-2 blocks). - During warp sync,
startingBlockmay be a recent block rather than 0. - This method is safe (read-only) and available on all node configurations.
Related Methods
system_health-- Quick boolean check for sync and peer statussystem_peers-- List connected peers and their best block numberssystem_nodeRoles-- Get the node's configured roleschain_getHeader-- Get the latest block header