TOP Group (The Open Platform) Emulation API
The Emulation API from TOP Group (The Open Platform) — 5 operation(s) for emulation.
TOP Group (The Open Platform) Emulation 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 Emulation. 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 76 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
76 schemas
5 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.
Emulation 5
POST
/v2/message/decode
Decode a given message. Only external incoming messages can be decoded currently.
POST
/v2/events/emulate
Emulate sending message to retrieve general blockchain events
POST
/v2/traces/emulate
Emulate sending message to retrieve with a detailed execution trace
POST
/v2/wallet/emulate
Emulates a wallet message on the current blockchain state and derives its consequences for the signing wallet
POST
/v2/accounts/{account_id}/events/emulate
Emulate sending message to retrieve account-specific events
Schemas 76
The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are Action (36 properties), Transaction (25 properties), Message (19 properties), NftItem (14 properties). Each schema is shown below with its type and property counts.
SmartContractAction
object
7 properties
4 required
WithdrawXTRAction
object
2 properties
2 required
AccStatusChange
string
NftApprovedBy
array
DomainRenewAction
object
3 properties
3 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
ComputeSkipReason
string
BuyXTRAction
object
2 properties
2 required
WithdrawTokenStakeRequestAction
object
3 properties
2 required
SetSignatureAllowedAction
object
2 properties
2 required
DepositTokenStakeAction
object
3 properties
2 required
Event
object
10 properties
8 required
UnSubscriptionAction
object
4 properties
4 required
Metadata
object
2 properties
1 required
ValueFlow
object
5 properties
3 required
ComputePhase
object
8 properties
1 required
FlawedJettonTransferAction
object
10 properties
5 required
ContractDeployAction
object
2 properties
2 required
Price
object
7 properties
6 required
JettonSwapAction
object
11 properties
5 required
PurchaseAction
object
5 properties
5 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
JettonVerificationType
string
NftItemTransferAction
object
7 properties
1 required
StoragePhase
object
3 properties
2 required
ElectionsDepositStakeAction
object
2 properties
2 required
MessageConsequences
object
Result of emulating a wallet message on the current blockchain state: describes the expected on-chain consequences (trace, high-level AccountEvent, risk) for t…
3 properties
3 required
PoolImplementationType
string
GasRelayAction
object
3 properties
3 required
JettonTransferAction
object
9 properties
4 required
Message
object
19 properties
11 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
Transaction
object
25 properties
17 required
WithdrawStakeAction
object
validator's participation in elections
4 properties
4 required
StateInit
object
2 properties
2 required
TransactionType
string
DepositXTRAction
object
2 properties
2 required
AccountStatus
string
RemoveExtensionAction
object
2 properties
2 required
DecodedRawMessage
object
2 properties
2 required
CurrencyType
string
TrustType
string
ElectionsRecoverStakeAction
object
2 properties
2 required
CreditPhase
object
2 properties
2 required
ExtraCurrency
object
2 properties
2 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
DecodedMessage
object
3 properties
2 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
BouncePhaseType
string
ActionPhase
object
7 properties
6 required
WithdrawStakeRequestAction
object
validator's participation in elections
5 properties
3 required
TonTransferAction
object
6 properties
3 required
Trace
object
4 properties
2 required
ScaledUI
object
2 properties
2 required
JettonBurnAction
object
4 properties
4 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
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
More from TOP Group (The Open Platform) 12
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) 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
#Emulation