Skip to main content

Documentation Index

Fetch the complete documentation index at: https://companyname-a7d5b98e-validator-rewards-api.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Validator rewards API is a self-hosted HTTP API that reads validator reward and staking data directly from TON liteservers through the tongo library.

What the API returns

  • Current validator data for a target masterchain block, including effective stake, per-block reward estimates, pool addresses, and optional nominator breakdowns.
  • Validation round metadata for the round selected by election_id, block, or the latest masterchain block.
  • Reward distribution for a finished validation round.
  • Local service routes for Swagger UI and the embedded OpenAPI document.

How the service resolves data

  • It reads the active validator set from config param 34.
  • It reads the elector contract to resolve past_elections, total stake, bonuses, and returned stake.
  • It inspects pool contract code hashes to classify pools as nominator-pool-v1.0, single-nominator-pool-v1.0, single-nominator-pool-v1.1, or other.
  • It creates one lite client connection per available liteserver and distributes requests across those connections in round-robin order.
  • When no custom config is provided, it downloads the TON Mainnet global config, caches it in memory for seven days, and refreshes the lite client after the cache time to live (TTL) expires.

When to use it

  • Build validator dashboards that need current effective stake and pool composition.
  • Compute reward splits for a finished validation round.
  • Inspect nominator pool balances and validator reward shares.
  • Compare the elector’s locked stake with pool balances and returned stake.

Endpoints

EndpointPurpose
GET /healthReturn service status.
GET /api/validatorsReturn current validators for a target masterchain block.
GET /api/validation-roundsReturn metadata for the selected validation round.
GET /api/round-rewardsReturn reward distribution for a finished validation round.
GET /api/openapi.yamlReturn the embedded OpenAPI document.
GET /swaggerOpen the local Swagger UI.

Next steps

See also