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

The Accounts API from TOP Group (The Open Platform) — 22 operation(s) for accounts.

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

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

22 operations 22 paths 85 schemas 19 GET3 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 22

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

Accounts 22
POST
/v2/accounts/_bulk
Get human-friendly information about several accounts without low-level details.
getAccounts 1 param body → 200default
GET
/v2/accounts/{account_id}
Get human-friendly information about an account without low-level details.
getAccount 1 param → 200default
GET
/v2/accounts/{account_id}/dns/backresolve
Get account's domains
accountDnsBackResolve 1 param → 200default
GET
/v2/accounts/{account_id}/jettons
Get all Jettons balances by owner address
getAccountJettonsBalances 5 params → 200default
GET
/v2/accounts/{account_id}/jettons/{jetton_id}
Get Jetton balance by owner address
getAccountJettonBalance 4 params → 200default
GET
/v2/accounts/{account_id}/jettons/history
Get the transfer jettons history for account
getAccountJettonsHistory 3 params → 200default
GET
/v2/accounts/{account_id}/jettons/{jetton_id}/historydeprecated
Please use getJettonAccountHistoryByID instead
getAccountJettonHistoryByID 7 params → 200default
GET
/v2/accounts/{account_id}/nfts
Get all NFT items by owner address
getAccountNftItems 5 params → 200default
GET
/v2/accounts/{account_id}/events
Get events for an account. Each event is built on top of a trace which is a series of transactions caused by one inbound message. TonAPI looks for known patterns inside the trace and splits the trace…
getAccountEvents 10 params → 200default
GET
/v2/accounts/{account_id}/events/{event_id}
Get event for an account by eventid
getAccountEvent 4 params → 200default
GET
/v2/accounts/{account_id}/traces
Get traces for account
getAccountTraces 3 params → 200default
GET
/v2/accounts/{account_id}/subscriptions
Get all subscriptions by wallet address
getAccountSubscriptions 1 param → 200default
POST
/v2/accounts/{account_id}/reindex
Update internal cache for a particular account
reindexAccount 1 param → 200default
GET
/v2/accounts/search
Search by account domain name
searchAccounts 1 param → 200default
GET
/v2/accounts/{account_id}/dns/expiring
Get expiring account .ton dns
getAccountDnsExpiring 2 params → 200default
GET
/v2/accounts/{account_id}/publickey
Get public key by account id
getAccountPublicKey 1 param → 200default
GET
/v2/accounts/{account_id}/multisigs
Get account's multisigs
getAccountMultisigs 1 param → 200default
GET
/v2/accounts/{account_id}/diff
Get account's balance change
getAccountDiff 3 params → 200default
GET
/v2/accounts/{account_id}/defi/assets
Return DeFi assets locked in custom smart contracts: currently returns TON Whales staking and EVAA lending positions.
getAccountDefiAssets 1 param → 200default
GET
/v2/accounts/{account_id}/extra-currency/{id}/history
Get the transfer history of extra currencies for an account.
getAccountExtraCurrencyHistoryByID 7 params → 200default
GET
/v2/jettons/{jetton_id}/accounts/{account_id}/history
Get the transfer jetton history for account and jetton
getJettonAccountHistoryByID 6 params → 200default
POST
/v2/accounts/{account_id}/events/emulate
Emulate sending message to retrieve account-specific events
emulateMessageToAccountEvent 3 params body → 200default

Schemas 85

The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are Action (36 properties), Account (14 properties), NftItem (14 properties), MultisigOrder (12 properties). Each schema is shown below with its type and property counts.

SmartContractAction
object
7 properties 4 required
WithdrawXTRAction
object
2 properties 2 required
NftApprovedBy
array
DomainRenewAction
object
3 properties 3 required
DefiAssetType
string
DefiLiquidPoolAssets
object
2 properties 2 required
Multisig
object
6 properties 6 required
EncryptedComment
object
2 properties 2 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
EcPreview
object
4 properties 4 required
AuctionBidAction
object
5 properties 4 required
JettonMintAction
object
4 properties 4 required
BuyXTRAction
object
2 properties 2 required
WithdrawTokenStakeRequestAction
object
3 properties 2 required
SetSignatureAllowedAction
object
2 properties 2 required
DepositTokenStakeAction
object
3 properties 2 required
UnSubscriptionAction
object
4 properties 4 required
Metadata
object
2 properties 1 required
TokenRates
object
4 properties
FlawedJettonTransferAction
object
10 properties 5 required
TraceID
object
2 properties 2 required
ContractDeployAction
object
2 properties 2 required
Price
object
7 properties 6 required
JettonSwapAction
object
11 properties 5 required
JettonOperations
object
2 properties 1 required
PurchaseAction
object
5 properties 5 required
JettonsBalances
object
1 property 1 required
Action
object
36 properties 4 required
Protocol
object
2 properties 1 required
Sale
object
4 properties 3 required
LiquidityDepositAction
object
3 properties 3 required
Account
object
14 properties 6 required
Subscription
object
11 properties 8 required
JettonVerificationType
string
NftItems
object
1 property 1 required
DomainNames
object
1 property 1 required
NftItemTransferAction
object
7 properties 1 required
ElectionsDepositStakeAction
object
2 properties 2 required
JettonBalance
object
7 properties 3 required
JettonAssetInfo
object
4 properties 2 required
PoolImplementationType
string
GasRelayAction
object
3 properties 3 required
JettonTransferAction
object
9 properties 4 required
VaultDepositInfo
object
2 properties 2 required
SubscriptionAction
object
7 properties 6 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
WithdrawStakeAction
object
validator's participation in elections
4 properties 4 required
DefiLockedAsset
object
2 properties 1 required
DepositXTRAction
object
2 properties 2 required
AccountStatus
string
TraceIDs
object
1 property 1 required
RemoveExtensionAction
object
2 properties 2 required
MultisigOrder
object
12 properties 11 required
CurrencyType
string
TrustType
string
ElectionsRecoverStakeAction
object
2 properties 2 required
ExtraCurrency
object
2 properties 2 required
DefiAsset
object
6 properties 4 required
JettonPreview
object
10 properties 7 required
Risk
object
Conservative upper bound on assets this wallet may lose if the emulated message is sent and the counterparty behaves maliciously. Values may exceed current bal…
6 properties 4 required
NftPurchaseAction
object
5 properties 5 required
AccountEvent
object
High-level view over a transaction trace caused by a single inbound message. TonAPI analyses the trace, detects known patterns and groups low-level transaction…
10 properties 9 required
WithdrawStakeRequestAction
object
validator's participation in elections
5 properties 3 required
Multisigs
object
1 property 1 required
TonTransferAction
object
6 properties 3 required
DefiAssets
object
1 property 1 required
Accounts
object
1 property 1 required
FoundAccounts
object
1 property 1 required
ScaledUI
object
2 properties 2 required
JettonBurnAction
object
4 properties 4 required
DnsExpiring
object
1 property 1 required
DefiProvider
object
8 properties 7 required
JettonOperation
object
11 properties 8 required
Subscriptions
object
1 property 1 required
ActionSimplePreview
object
shortly describes what this action is about.
7 properties 3 required
DepositStakeAction
object
validator's participation in elections
5 properties 4 required
OracleRequestAction
object
3 properties 3 required
AccountEvents
object
Paginated list of events for a single account.
2 properties 2 required
JettonQuantity
object
3 properties 3 required
ImagePreview
object
2 properties 2 required
Refund
object
2 properties 2 required
AccountAddress
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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

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
TOP Group (The Open Platform) NFT API