Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TOP Group (The Open Platform) Rewards API

The Rewards API from TOP Group (The Open Platform) — 5 operation(s) for rewards.

TOP Group (The Open Platform) Rewards API is one of 23 APIs that TOP Group (The Open Platform) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rewards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against 3 base URLs: https://tonapi.io, https://testnet.tonapi.io, http://localhost:8081.

5 operations 5 paths 10 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://tonapi.io
Contact
Resource Areas
1

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Rewards 5
GET
/v2/rewards/validators
Get all current validators
getValidators 3 params → 200default
GET
/v2/rewards/validation-rounds
Get validation round metadata
getValidationRounds 3 params → 200default
GET
/v2/rewards/round-rewards
Get per-validator reward distribution for a finished round
getRoundRewards 4 params → 200default
GET
/v2/rewards/stats
Get historical APY and stake statistics
getRewardsStats → 200default
GET
/v2/rewards/apy
Get current TON blockchain APY
getRewardsApy → 200default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ValidatorRewardEntry (15 properties), RoundRewardsResponse (12 properties), ValidationRound (10 properties), ValidatorsResponse (10 properties). Each schema is shown below with its type and property counts.

ValidatorsResponse
object
10 properties 8 required
RoundInfo
object
4 properties 4 required
NominatorRewardEntry
object
5 properties 5 required
ValidationRoundsResponse
object
2 properties 2 required
BlockInfo
object
2 properties 2 required
InsufficientFunds
object
Present on an error when a request failed because the source wallet does not hold enough TON to cover the required gas (errorcode 50000).
2 properties 2 required
ValidationRound
object
10 properties 5 required
RewardsStats
object
2 properties 2 required
ValidatorRewardEntry
object
15 properties 5 required
RoundRewardsResponse
object
12 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

top-group-rewards-api-openapi.yml Raw ↑

Other APIs TOP Group (The Open Platform) publishes across the network.

TOP Group (The Open Platform) Accounts API
TOP Group (The Open Platform) Blockchain API
TOP Group (The Open Platform) Connect API
TOP Group (The Open Platform) DNS API
TOP Group (The Open Platform) Emulation API
TOP Group (The Open Platform) Events API
TOP Group (The Open Platform) ExtraCurrency API
TOP Group (The Open Platform) Gasless API
TOP Group (The Open Platform) Jettons API
TOP Group (The Open Platform) Lite Server API
TOP Group (The Open Platform) Migration API
TOP Group (The Open Platform) Multisig API