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) Staking API

The Staking API from TOP Group (The Open Platform) — 4 operation(s) for staking.

TOP Group (The Open Platform) Staking 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 Staking. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 7 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.

4 operations 4 paths 7 schemas 4 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 4

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

Staking 4
GET
/v2/staking/nominator/{account_id}/pools
All pools where account participates
getAccountNominatorsPools 1 param → 200default
GET
/v2/staking/pool/{account_id}
Stacking pool info
getStakingPoolInfo 2 params → 200default
GET
/v2/staking/pool/{account_id}/history
Pool history
getStakingPoolHistory 3 params → 200default
GET
/v2/staking/pools
All pools available in network
getStakingPools 3 params → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PoolInfo (15 properties), AccountStakingInfo (5 properties), PoolImplementation (4 properties), ApyHistory (2 properties). Each schema is shown below with its type and property counts.

PoolImplementationType
string
PoolInfo
object
15 properties 13 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
AccountStaking
object
1 property 1 required
AccountStakingInfo
object
5 properties 5 required
PoolImplementation
object
4 properties 4 required
ApyHistory
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

top-group-staking-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