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

The Jettons API from TOP Group (The Open Platform) — 6 operation(s) for jettons.

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

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

6 operations 6 paths 61 schemas 5 GET1 POST

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 6

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

Jettons 6
GET
/v2/jettons
Get a list of all indexed jetton masters in the blockchain.
getJettons 2 params → 200default
GET
/v2/jettons/{account_id}
Get jetton metadata by jetton master address
getJettonInfo 1 param → 200default
POST
/v2/jettons/_bulk
Get jetton metadata items by jetton master addresses
getJettonInfosByAddresses body → 200default
GET
/v2/jettons/{account_id}/holders
Get jetton's holders
getJettonHolders 3 params → 200default
GET
/v2/jettons/{jetton_id}/transfer/{account_id}/payload
Get jetton's custom payload and state init required for transfer
getJettonTransferPayload 2 params → 200default
GET
/v2/events/{event_id}/jettons
Get only jetton transfers in the event
getJettonsEvents 2 params → 200default

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are Action (36 properties), NftItem (14 properties), JettonInfo (13 properties), JettonSwapAction (11 properties). Each schema is shown below with its type and property counts.

PoolImplementationType
string
ContractDeployAction
object
2 properties 2 required
Price
object
7 properties 6 required
GasRelayAction
object
3 properties 3 required
WithdrawXTRAction
object
2 properties 2 required
WithdrawStakeRequestAction
object
validator's participation in elections
5 properties 3 required
JettonTransferAction
object
9 properties 4 required
JettonSwapAction
object
11 properties 5 required
SmartContractAction
object
7 properties 4 required
TonTransferAction
object
6 properties 3 required
VaultDepositInfo
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
SubscriptionAction
object
7 properties 6 required
NftApprovedBy
array
DomainRenewAction
object
3 properties 3 required
WithdrawStakeAction
object
validator's participation in elections
4 properties 4 required
Jettons
object
1 property 1 required
PurchaseAction
object
5 properties 5 required
Action
object
36 properties 4 required
EncryptedComment
object
2 properties 2 required
ScaledUI
object
2 properties 2 required
DepositXTRAction
object
2 properties 2 required
JettonMetadata
object
10 properties 4 required
JettonBurnAction
object
4 properties 4 required
JettonInfo
object
13 properties 6 required
Protocol
object
2 properties 1 required
Sale
object
4 properties 3 required
AddExtensionAction
object
2 properties 2 required
ExtraCurrencyTransferAction
object
6 properties 4 required
OraclePriceFeed
object
3 properties 2 required
NftItem
object
14 properties 6 required
ActionSimplePreview
object
shortly describes what this action is about.
7 properties 3 required
LiquidityDepositAction
object
3 properties 3 required
DepositStakeAction
object
validator's participation in elections
5 properties 4 required
JettonTransferPayload
object
2 properties 1 required
EcPreview
object
4 properties 4 required
JettonVerificationType
string
RemoveExtensionAction
object
2 properties 2 required
JettonHolders
object
2 properties 2 required
AuctionBidAction
object
5 properties 4 required
JettonMintAction
object
4 properties 4 required
CurrencyType
string
TrustType
string
NftItemTransferAction
object
7 properties 1 required
BuyXTRAction
object
2 properties 2 required
WithdrawTokenStakeRequestAction
object
3 properties 2 required
OracleRequestAction
object
3 properties 3 required
ElectionsRecoverStakeAction
object
2 properties 2 required
ElectionsDepositStakeAction
object
2 properties 2 required
JettonPreview
object
10 properties 7 required
SetSignatureAllowedAction
object
2 properties 2 required
ImagePreview
object
2 properties 2 required
DepositTokenStakeAction
object
3 properties 2 required
Refund
object
2 properties 2 required
Event
object
10 properties 8 required
UnSubscriptionAction
object
4 properties 4 required
NftPurchaseAction
object
5 properties 5 required
Metadata
object
2 properties 1 required
AccountAddress
object
5 properties 3 required
ValueFlow
object
5 properties 3 required
FlawedJettonTransferAction
object
10 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

top-group-jettons-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) Lite Server API
TOP Group (The Open Platform) Migration API
TOP Group (The Open Platform) Multisig API
TOP Group (The Open Platform) NFT API