Categorygithub.com/tonkeeper/tonapi-go
modulepackage
0.0.7
Repository: https://github.com/tonkeeper/tonapi-go.git
Documentation: pkg.go.dev

# README

Description

This repository contains TonAPI SDK and examples.

The native TON's RPC is very low-level. And it is not suitable for building applications on top of it.

TonAPI aims at speeding up development of TON-based applications and provides an API centered around high-level concepts like Jettons, NFTs and so on, keeping a way to access low-level details.

Check out more details at TonAPI Documentation.

TonAPI SDK Example

Development of TON-based applications is much easier with TonAPI SDK:

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/tonkeeper/tonapi-go"
)

func main() {
	client, err := tonapi.New()
	if err != nil {
		log.Fatal(err)
	}
	account, err := client.GetAccount(context.Background(), tonapi.GetAccountParams{AccountID: "EQBszTJahYw3lpP64ryqscKQaDGk4QpsO7RO6LYVvKHSINS0"})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Account: %v\n", account.Balance)
}

Take a look at TonAPI SDK examples.

Rest API

You can always find the latest version of TonAPI Rest API documentation at TonAPI Documentation.

TonAPI SDK example shows how to work with Rest API in golang.

Streaming API

Usually, an application needs to monitor the blockchain for specific events and act accordingly.
TonAPI offers two ways to do it: SSE and Websocket.

The advantage of Websocket is that Websocket can be reconfigured dynamically to subscribe/unsubscribe to/from specific events. Where SSE has to reconnect to TonAPI to change the list of events it is subscribed to.

Take a look at SSE example and Websocket example to see how to work with TonAPI Streaming API in golang.

More details can be found at TonAPI Streaming API Documentation.

# Functions

New returns a new Client.
NewClient initializes new Client defined by OAS.
NewOptAccountAddress returns new OptAccountAddress with value set to v.
NewOptAccountCurrenciesBalance returns new OptAccountCurrenciesBalance with value set to v.
NewOptActionPhase returns new OptActionPhase with value set to v.
NewOptAuctionBidAction returns new OptAuctionBidAction with value set to v.
NewOptBlockchainAccountInspectCompiler returns new OptBlockchainAccountInspectCompiler with value set to v.
NewOptBlockchainConfig10 returns new OptBlockchainConfig10 with value set to v.
NewOptBlockchainConfig11 returns new OptBlockchainConfig11 with value set to v.
NewOptBlockchainConfig12 returns new OptBlockchainConfig12 with value set to v.
NewOptBlockchainConfig13 returns new OptBlockchainConfig13 with value set to v.
NewOptBlockchainConfig14 returns new OptBlockchainConfig14 with value set to v.
NewOptBlockchainConfig15 returns new OptBlockchainConfig15 with value set to v.
NewOptBlockchainConfig16 returns new OptBlockchainConfig16 with value set to v.
NewOptBlockchainConfig17 returns new OptBlockchainConfig17 with value set to v.
NewOptBlockchainConfig18 returns new OptBlockchainConfig18 with value set to v.
NewOptBlockchainConfig20 returns new OptBlockchainConfig20 with value set to v.
NewOptBlockchainConfig21 returns new OptBlockchainConfig21 with value set to v.
NewOptBlockchainConfig22 returns new OptBlockchainConfig22 with value set to v.
NewOptBlockchainConfig23 returns new OptBlockchainConfig23 with value set to v.
NewOptBlockchainConfig24 returns new OptBlockchainConfig24 with value set to v.
NewOptBlockchainConfig25 returns new OptBlockchainConfig25 with value set to v.
NewOptBlockchainConfig28 returns new OptBlockchainConfig28 with value set to v.
NewOptBlockchainConfig29 returns new OptBlockchainConfig29 with value set to v.
NewOptBlockchainConfig31 returns new OptBlockchainConfig31 with value set to v.
NewOptBlockchainConfig40 returns new OptBlockchainConfig40 with value set to v.
NewOptBlockchainConfig43 returns new OptBlockchainConfig43 with value set to v.
NewOptBlockchainConfig5 returns new OptBlockchainConfig5 with value set to v.
NewOptBlockchainConfig6 returns new OptBlockchainConfig6 with value set to v.
NewOptBlockchainConfig7 returns new OptBlockchainConfig7 with value set to v.
NewOptBlockchainConfig71 returns new OptBlockchainConfig71 with value set to v.
NewOptBlockchainConfig72 returns new OptBlockchainConfig72 with value set to v.
NewOptBlockchainConfig73 returns new OptBlockchainConfig73 with value set to v.
NewOptBlockchainConfig79 returns new OptBlockchainConfig79 with value set to v.
NewOptBlockchainConfig8 returns new OptBlockchainConfig8 with value set to v.
NewOptBlockchainConfig81 returns new OptBlockchainConfig81 with value set to v.
NewOptBlockchainConfig82 returns new OptBlockchainConfig82 with value set to v.
NewOptBlockchainConfig9 returns new OptBlockchainConfig9 with value set to v.
NewOptBlockchainRawAccountExtraBalance returns new OptBlockchainRawAccountExtraBalance with value set to v.
NewOptBlockCurrencyCollection returns new OptBlockCurrencyCollection with value set to v.
NewOptBool returns new OptBool with value set to v.
NewOptBouncePhaseType returns new OptBouncePhaseType with value set to v.
NewOptComputePhase returns new OptComputePhase with value set to v.
NewOptComputeSkipReason returns new OptComputeSkipReason with value set to v.
NewOptContractDeployAction returns new OptContractDeployAction with value set to v.
NewOptCreditPhase returns new OptCreditPhase with value set to v.
NewOptDecodedMessageExtInMsgDecoded returns new OptDecodedMessageExtInMsgDecoded with value set to v.
NewOptDecodedMessageExtInMsgDecodedWalletHighloadV2 returns new OptDecodedMessageExtInMsgDecodedWalletHighloadV2 with value set to v.
NewOptDecodedMessageExtInMsgDecodedWalletV3 returns new OptDecodedMessageExtInMsgDecodedWalletV3 with value set to v.
NewOptDecodedMessageExtInMsgDecodedWalletV4 returns new OptDecodedMessageExtInMsgDecodedWalletV4 with value set to v.
NewOptDepositStakeAction returns new OptDepositStakeAction with value set to v.
NewOptDomainRenewAction returns new OptDomainRenewAction with value set to v.
NewOptElectionsDepositStakeAction returns new OptElectionsDepositStakeAction with value set to v.
NewOptElectionsRecoverStakeAction returns new OptElectionsRecoverStakeAction with value set to v.
NewOptEncryptedComment returns new OptEncryptedComment with value set to v.
NewOptGetAccountsReq returns new OptGetAccountsReq with value set to v.
NewOptGetBlockchainAccountTransactionsSortOrder returns new OptGetBlockchainAccountTransactionsSortOrder with value set to v.
NewOptGetNftItemsByAddressesReq returns new OptGetNftItemsByAddressesReq with value set to v.
NewOptInscriptionMintAction returns new OptInscriptionMintAction with value set to v.
NewOptInscriptionTransferAction returns new OptInscriptionTransferAction with value set to v.
NewOptInt returns new OptInt with value set to v.
NewOptInt32 returns new OptInt32 with value set to v.
NewOptInt64 returns new OptInt64 with value set to v.
NewOptJettonBalanceLock returns new OptJettonBalanceLock with value set to v.
NewOptJettonBridgePrices returns new OptJettonBridgePrices with value set to v.
NewOptJettonBurnAction returns new OptJettonBurnAction with value set to v.
NewOptJettonMintAction returns new OptJettonMintAction with value set to v.
NewOptJettonPreview returns new OptJettonPreview with value set to v.
NewOptJettonSwapAction returns new OptJettonSwapAction with value set to v.
NewOptJettonTransferAction returns new OptJettonTransferAction with value set to v.
NewOptMessage returns new OptMessage with value set to v.
NewOptNftCollectionMetadata returns new OptNftCollectionMetadata with value set to v.
NewOptNftItem returns new OptNftItem with value set to v.
NewOptNftItemCollection returns new OptNftItemCollection with value set to v.
NewOptNftItemTransferAction returns new OptNftItemTransferAction with value set to v.
NewOptNftPurchaseAction returns new OptNftPurchaseAction with value set to v.
NewOptRefund returns new OptRefund with value set to v.
NewOptSale returns new OptSale with value set to v.
NewOptSmartContractAction returns new OptSmartContractAction with value set to v.
NewOptStateInit returns new OptStateInit with value set to v.
NewOptStoragePhase returns new OptStoragePhase with value set to v.
NewOptString returns new OptString with value set to v.
NewOptSubscriptionAction returns new OptSubscriptionAction with value set to v.
NewOptTokenRates returns new OptTokenRates with value set to v.
NewOptTokenRatesDiff24h returns new OptTokenRatesDiff24h with value set to v.
NewOptTokenRatesDiff30d returns new OptTokenRatesDiff30d with value set to v.
NewOptTokenRatesDiff7d returns new OptTokenRatesDiff7d with value set to v.
NewOptTokenRatesPrices returns new OptTokenRatesPrices with value set to v.
NewOptTonTransferAction returns new OptTonTransferAction with value set to v.
NewOptUnSubscriptionAction returns new OptUnSubscriptionAction with value set to v.
NewOptValidatorsSet returns new OptValidatorsSet with value set to v.
NewOptWalletDNS returns new OptWalletDNS with value set to v.
NewOptWithdrawStakeAction returns new OptWithdrawStakeAction with value set to v.
NewOptWithdrawStakeRequestAction returns new OptWithdrawStakeRequestAction with value set to v.
No description provided by the author
WithClient specifies http client to use.
WithMeterProvider specifies a meter provider to use for creating a meter.
WithServerURL sets context key to override server URL.
WithStreamingEndpoint configures a StreamingAPI instance to use the specified endpoint instead of https://tonapi.io.
No description provided by the author
WithStreamingTestnet configures a StreamingAPI instance to use an endpoint to work with testnet.
WithStreamingToken configures a StreamingAPI instance to use the specified API key for authorization.
WithToken configures client to use tonApiKey for authorization.
WithTracerProvider specifies a tracer provider to use for creating a tracer.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TestnetTonApiURL is an endpoint to work with testnet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Ref: #/components/schemas/Account.
Ref: #/components/schemas/AccountAddress.
AccountDnsBackResolveParams is parameters of accountDnsBackResolve operation.
An event is built on top of a trace which is a series of transactions caused by one inbound message.
Ref: #/components/schemas/AccountEvents.
Ref: #/components/schemas/AccountInfoByStateInit.
Ref: #/components/schemas/Accounts.
Ref: #/components/schemas/AccountStaking.
Ref: #/components/schemas/AccountStakingInfo.
Ref: #/components/schemas/AccountStorageInfo.
Ref: #/components/schemas/Action.
Ref: #/components/schemas/ActionPhase.
Shortly describes what this action is about.
No description provided by the author
No description provided by the author
No description provided by the author
AddressParseParams is parameters of addressParse operation.
Ref: #/components/schemas/ApyHistory.
Ref: #/components/schemas/Auction.
Ref: #/components/schemas/AuctionBidAction.
Ref: #/components/schemas/Auctions.
Ref: #/components/schemas/BlockchainAccountInspect.
No description provided by the author
BlockchainAccountInspectParams is parameters of blockchainAccountInspect operation.
Ref: #/components/schemas/BlockchainBlock.
Ref: #/components/schemas/BlockchainBlocks.
Ref: #/components/schemas/BlockchainBlockShards.
No description provided by the author
Ref: #/components/schemas/BlockchainConfig.
List of critical TON parameters, the change of which significantly affects the network, so more voting rounds are held.
This parameter indicates under what conditions proposals to change the TON configuration are accepted.
Workchains in the TON Blockchain.
The cost of filing complaints about incorrect operation of validators.
The reward in nanoTons for block creation in the TON blockchain.
The reward in nanoTons for block creation in the TON blockchain.
The limits on the number of validators in the TON blockchain.
The stake parameters configuration in the TON blockchain.
The prices for data storage.
No description provided by the author
The cost of computations in the masterchain.
The cost of computations in the basechains.
The limits on the block in the masterchain, upon reaching which the block is finalized and the callback of the remaining messages (if any) is carried over to the next block.
The limits on the block in the basechains, upon reaching which the block is finalized and the callback of the remaining messages (if any) is carried over to the next block.
The cost of sending messages in the masterchain of the TON blockchain.
The cost of sending messages in the basechains of the TON blockchain.
The configuration for the Catchain protocol.
The configuration for the consensus protocol above catchain.
The configuration for the consensus protocol above catchain.
The configuration for punishment for improper behavior (non-validation).
The size limits and some other characteristics of accounts and messages.
Suspended accounts.
No description provided by the author
Minting fees of new currencies.
The volume of each of the additional currencies in circulation.
Bridge parameters for wrapping TON in other networks.
Bridge parameters for wrapping TON in other networks.
Bridge parameters for wrapping TON in other networks.
Bridge parameters for wrapping tokens from other networks into tokens on the TON network.
No description provided by the author
The network version and additional capabilities supported by the validators.
Bridge parameters for wrapping tokens from other networks into tokens on the TON network.
Bridge parameters for wrapping tokens from other networks into tokens on the TON network.
List of mandatory parameters of the blockchain config.
Ref: #/components/schemas/BlockchainRawAccount.
No description provided by the author
Ref: #/components/schemas/BlockCurrencyCollection.
No description provided by the author
BlockEventData represents a notification about a new block.
Ref: #/components/schemas/BlockLimits.
Ref: #/components/schemas/BlockParamLimits.
Ref: #/components/schemas/BlockRaw.
Ref: #/components/schemas/BlockValueFlow.
Client implements OAS client.
Ref: #/components/schemas/ComputePhase.
Ref: #/components/schemas/ConfigProposalSetup.
Ref: #/components/schemas/ContractDeployAction.
Ref: #/components/schemas/CreditPhase.
Ref: #/components/schemas/DecodedMessage.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Ref: #/components/schemas/DecodedRawMessage.
No description provided by the author
No description provided by the author
Validator's participation in elections.
Ref: #/components/schemas/DnsExpiring.
No description provided by the author
Ref: #/components/schemas/DnsRecord.
DnsResolveParams is parameters of dnsResolve operation.
Ref: #/components/schemas/DomainBid.
Ref: #/components/schemas/DomainBids.
Ref: #/components/schemas/DomainInfo.
Ref: #/components/schemas/DomainNames.
Ref: #/components/schemas/DomainRenewAction.
Ref: #/components/schemas/ElectionsDepositStakeAction.
Ref: #/components/schemas/ElectionsRecoverStakeAction.
EmulateMessageToAccountEventParams is parameters of emulateMessageToAccountEvent operation.
No description provided by the author
EmulateMessageToEventParams is parameters of emulateMessageToEvent operation.
No description provided by the author
EmulateMessageToTraceParams is parameters of emulateMessageToTrace operation.
No description provided by the author
EmulateMessageToWalletParams is parameters of emulateMessageToWallet operation.
No description provided by the author
No description provided by the author
Ref: #/components/schemas/EncryptedComment.
No description provided by the author
ErrorStatusCode wraps Error with StatusCode.
Ref: #/components/schemas/Event.
ExecGetMethodForBlockchainAccountParams is parameters of execGetMethodForBlockchainAccount operation.
Ref: #/components/schemas/FoundAccounts.
No description provided by the author
Ref: #/components/schemas/GaslessConfig.
No description provided by the author
GaslessEstimateParams is parameters of gaslessEstimate operation.
No description provided by the author
No description provided by the author
GaslessSendOK is response for GaslessSend operation.
No description provided by the author
Ref: #/components/schemas/GasLimitPrices.
No description provided by the author
GetAccountDiffParams is parameters of getAccountDiff operation.
GetAccountDnsExpiringParams is parameters of getAccountDnsExpiring operation.
GetAccountEventParams is parameters of getAccountEvent operation.
GetAccountEventsParams is parameters of getAccountEvents operation.
No description provided by the author
GetAccountInscriptionsHistoryByTickerParams is parameters of getAccountInscriptionsHistoryByTicker operation.
GetAccountInscriptionsHistoryParams is parameters of getAccountInscriptionsHistory operation.
GetAccountInscriptionsParams is parameters of getAccountInscriptions operation.
GetAccountJettonBalanceParams is parameters of getAccountJettonBalance operation.
GetAccountJettonHistoryByIDParams is parameters of getAccountJettonHistoryByID operation.
GetAccountJettonsBalancesParams is parameters of getAccountJettonsBalances operation.
GetAccountJettonsHistoryParams is parameters of getAccountJettonsHistory operation.
GetAccountMultisigsParams is parameters of getAccountMultisigs operation.
GetAccountNftHistoryParams is parameters of getAccountNftHistory operation.
GetAccountNftItemsParams is parameters of getAccountNftItems operation.
GetAccountNominatorsPoolsParams is parameters of getAccountNominatorsPools operation.
GetAccountParams is parameters of getAccount operation.
No description provided by the author
GetAccountPublicKeyParams is parameters of getAccountPublicKey operation.
GetAccountSeqnoParams is parameters of getAccountSeqno operation.
GetAccountsParams is parameters of getAccounts operation.
No description provided by the author
GetAccountSubscriptionsParams is parameters of getAccountSubscriptions operation.
GetAccountTracesParams is parameters of getAccountTraces operation.
GetAllAuctionsParams is parameters of getAllAuctions operation.
No description provided by the author
GetAllRawShardsInfoParams is parameters of getAllRawShardsInfo operation.
GetBlockchainAccountTransactionsParams is parameters of getBlockchainAccountTransactions operation.
GetBlockchainBlockParams is parameters of getBlockchainBlock operation.
GetBlockchainBlockTransactionsParams is parameters of getBlockchainBlockTransactions operation.
GetBlockchainConfigFromBlockParams is parameters of getBlockchainConfigFromBlock operation.
GetBlockchainMasterchainBlocksParams is parameters of getBlockchainMasterchainBlocks operation.
GetBlockchainMasterchainShardsParams is parameters of getBlockchainMasterchainShards operation.
GetBlockchainMasterchainTransactionsParams is parameters of getBlockchainMasterchainTransactions operation.
GetBlockchainRawAccountParams is parameters of getBlockchainRawAccount operation.
GetBlockchainTransactionByMessageHashParams is parameters of getBlockchainTransactionByMessageHash operation.
GetBlockchainTransactionParams is parameters of getBlockchainTransaction operation.
No description provided by the author
GetChartRatesParams is parameters of getChartRates operation.
GetDnsInfoParams is parameters of getDnsInfo operation.
GetDomainBidsParams is parameters of getDomainBids operation.
GetEventParams is parameters of getEvent operation.
No description provided by the author
GetInscriptionOpTemplateParams is parameters of getInscriptionOpTemplate operation.
GetItemsFromCollectionParams is parameters of getItemsFromCollection operation.
GetJettonHoldersParams is parameters of getJettonHolders operation.
GetJettonInfoParams is parameters of getJettonInfo operation.
GetJettonsEventsParams is parameters of getJettonsEvents operation.
GetJettonsParams is parameters of getJettons operation.
GetJettonTransferPayloadParams is parameters of getJettonTransferPayload operation.
No description provided by the author
GetMultisigAccountParams is parameters of getMultisigAccount operation.
GetNftCollectionParams is parameters of getNftCollection operation.
GetNftCollectionsParams is parameters of getNftCollections operation.
GetNftHistoryByIDParams is parameters of getNftHistoryByID operation.
GetNftItemByAddressParams is parameters of getNftItemByAddress operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetRatesParams is parameters of getRates operation.
No description provided by the author
GetRawAccountStateParams is parameters of getRawAccountState operation.
No description provided by the author
GetRawBlockchainBlockHeaderParams is parameters of getRawBlockchainBlockHeader operation.
No description provided by the author
GetRawBlockchainBlockParams is parameters of getRawBlockchainBlock operation.
No description provided by the author
GetRawBlockchainBlockStateParams is parameters of getRawBlockchainBlockState operation.
GetRawBlockchainConfigFromBlockParams is parameters of getRawBlockchainConfigFromBlock operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetRawBlockProofParams is parameters of getRawBlockProof operation.
No description provided by the author
GetRawConfigParams is parameters of getRawConfig operation.
No description provided by the author
No description provided by the author
GetRawListBlockTransactionsParams is parameters of getRawListBlockTransactions operation.
No description provided by the author
GetRawMasterchainInfoExtParams is parameters of getRawMasterchainInfoExt operation.
No description provided by the author
No description provided by the author
No description provided by the author
GetRawShardBlockProofParams is parameters of getRawShardBlockProof operation.
No description provided by the author
GetRawShardInfoParams is parameters of getRawShardInfo operation.
No description provided by the author
No description provided by the author
GetRawTransactionsParams is parameters of getRawTransactions operation.
GetReducedBlockchainBlocksParams is parameters of getReducedBlockchainBlocks operation.
No description provided by the author
GetStakingPoolHistoryParams is parameters of getStakingPoolHistory operation.
No description provided by the author
GetStakingPoolInfoParams is parameters of getStakingPoolInfo operation.
No description provided by the author
GetStakingPoolsParams is parameters of getStakingPools operation.
No description provided by the author
No description provided by the author
GetTraceParams is parameters of getTrace operation.
No description provided by the author
GetWalletBackupParams is parameters of getWalletBackup operation.
GetWalletsByPublicKeyParams is parameters of getWalletsByPublicKey operation.
Ref: #/components/schemas/ImagePreview.
Ref: #/components/schemas/InitStateRaw.
Ref: #/components/schemas/InscriptionBalance.
Ref: #/components/schemas/InscriptionBalances.
Ref: #/components/schemas/InscriptionMintAction.
Ref: #/components/schemas/InscriptionTransferAction.
Ref: #/components/schemas/JettonBalance.
No description provided by the author
Ref: #/components/schemas/JettonBridgeParams.
Ref: #/components/schemas/JettonBridgePrices.
Ref: #/components/schemas/JettonBurnAction.
Ref: #/components/schemas/JettonHolders.
No description provided by the author
Ref: #/components/schemas/JettonInfo.
Ref: #/components/schemas/JettonMetadata.
Ref: #/components/schemas/JettonMintAction.
Ref: #/components/schemas/JettonPreview.
Ref: #/components/schemas/JettonQuantity.
Ref: #/components/schemas/Jettons.
Ref: #/components/schemas/JettonsBalances.
Ref: #/components/schemas/JettonSwapAction.
Ref: #/components/schemas/JettonTransferAction.
Ref: #/components/schemas/JettonTransferPayload.
JsonRPCRequest represents a request in the JSON-RPC protocol supported by "/v2/websocket" endpoint.
JsonRPCResponse represents a response in the JSON-RPC protocol supported by "/v2/websocket" endpoint.
Ref: #/components/schemas/MarketTonRates.
MempoolEventData represents the data part of a new-pending-message event.
Ref: #/components/schemas/Message.
Ref: #/components/schemas/MessageConsequences.
Ref: #/components/schemas/MethodExecutionResult.
Ref: #/components/schemas/MisbehaviourPunishmentConfig.
Ref: #/components/schemas/MsgForwardPrices.
Ref: #/components/schemas/Multisig.
Ref: #/components/schemas/MultisigOrder.
Ref: #/components/schemas/Multisigs.
Ref: #/components/schemas/NftCollection.
Ref: #/components/schemas/NftCollections.
Ref: #/components/schemas/NftItem.
No description provided by the author
Ref: #/components/schemas/NftItems.
Ref: #/components/schemas/NftItemTransferAction.
Ref: #/components/schemas/NftPurchaseAction.
OptAccountAddress is optional AccountAddress.
OptAccountCurrenciesBalance is optional AccountCurrenciesBalance.
OptActionPhase is optional ActionPhase.
OptAuctionBidAction is optional AuctionBidAction.
OptBlockchainAccountInspectCompiler is optional BlockchainAccountInspectCompiler.
OptBlockchainConfig10 is optional BlockchainConfig10.
OptBlockchainConfig11 is optional BlockchainConfig11.
OptBlockchainConfig12 is optional BlockchainConfig12.
OptBlockchainConfig13 is optional BlockchainConfig13.
OptBlockchainConfig14 is optional BlockchainConfig14.
OptBlockchainConfig15 is optional BlockchainConfig15.
OptBlockchainConfig16 is optional BlockchainConfig16.
OptBlockchainConfig17 is optional BlockchainConfig17.
OptBlockchainConfig18 is optional BlockchainConfig18.
OptBlockchainConfig20 is optional BlockchainConfig20.
OptBlockchainConfig21 is optional BlockchainConfig21.
OptBlockchainConfig22 is optional BlockchainConfig22.
OptBlockchainConfig23 is optional BlockchainConfig23.
OptBlockchainConfig24 is optional BlockchainConfig24.
OptBlockchainConfig25 is optional BlockchainConfig25.
OptBlockchainConfig28 is optional BlockchainConfig28.
OptBlockchainConfig29 is optional BlockchainConfig29.
OptBlockchainConfig31 is optional BlockchainConfig31.
OptBlockchainConfig40 is optional BlockchainConfig40.
OptBlockchainConfig43 is optional BlockchainConfig43.
OptBlockchainConfig5 is optional BlockchainConfig5.
OptBlockchainConfig6 is optional BlockchainConfig6.
OptBlockchainConfig7 is optional BlockchainConfig7.
OptBlockchainConfig71 is optional BlockchainConfig71.
OptBlockchainConfig72 is optional BlockchainConfig72.
OptBlockchainConfig73 is optional BlockchainConfig73.
OptBlockchainConfig79 is optional BlockchainConfig79.
OptBlockchainConfig8 is optional BlockchainConfig8.
OptBlockchainConfig81 is optional BlockchainConfig81.
OptBlockchainConfig82 is optional BlockchainConfig82.
OptBlockchainConfig9 is optional BlockchainConfig9.
OptBlockchainRawAccountExtraBalance is optional BlockchainRawAccountExtraBalance.
OptBlockCurrencyCollection is optional BlockCurrencyCollection.
OptBool is optional bool.
OptBouncePhaseType is optional BouncePhaseType.
OptComputePhase is optional ComputePhase.
OptComputeSkipReason is optional ComputeSkipReason.
OptContractDeployAction is optional ContractDeployAction.
OptCreditPhase is optional CreditPhase.
OptDecodedMessageExtInMsgDecoded is optional DecodedMessageExtInMsgDecoded.
OptDecodedMessageExtInMsgDecodedWalletHighloadV2 is optional DecodedMessageExtInMsgDecodedWalletHighloadV2.
OptDecodedMessageExtInMsgDecodedWalletV3 is optional DecodedMessageExtInMsgDecodedWalletV3.
OptDecodedMessageExtInMsgDecodedWalletV4 is optional DecodedMessageExtInMsgDecodedWalletV4.
OptDepositStakeAction is optional DepositStakeAction.
OptDomainRenewAction is optional DomainRenewAction.
OptElectionsDepositStakeAction is optional ElectionsDepositStakeAction.
OptElectionsRecoverStakeAction is optional ElectionsRecoverStakeAction.
OptEncryptedComment is optional EncryptedComment.
OptGetAccountsReq is optional GetAccountsReq.
OptGetBlockchainAccountTransactionsSortOrder is optional GetBlockchainAccountTransactionsSortOrder.
OptGetNftItemsByAddressesReq is optional GetNftItemsByAddressesReq.
OptInscriptionMintAction is optional InscriptionMintAction.
OptInscriptionTransferAction is optional InscriptionTransferAction.
OptInt is optional int.
OptInt32 is optional int32.
OptInt64 is optional int64.
OptJettonBalanceLock is optional JettonBalanceLock.
OptJettonBridgePrices is optional JettonBridgePrices.
OptJettonBurnAction is optional JettonBurnAction.
OptJettonMintAction is optional JettonMintAction.
OptJettonPreview is optional JettonPreview.
OptJettonSwapAction is optional JettonSwapAction.
OptJettonTransferAction is optional JettonTransferAction.
OptMessage is optional Message.
OptNftCollectionMetadata is optional NftCollectionMetadata.
OptNftItem is optional NftItem.
OptNftItemCollection is optional NftItemCollection.
OptNftItemTransferAction is optional NftItemTransferAction.
OptNftPurchaseAction is optional NftPurchaseAction.
OptRefund is optional Refund.
OptSale is optional Sale.
OptSmartContractAction is optional SmartContractAction.
OptStateInit is optional StateInit.
OptStoragePhase is optional StoragePhase.
OptString is optional string.
OptSubscriptionAction is optional SubscriptionAction.
OptTokenRates is optional TokenRates.
OptTokenRatesDiff24h is optional TokenRatesDiff24h.
OptTokenRatesDiff30d is optional TokenRatesDiff30d.
OptTokenRatesDiff7d is optional TokenRatesDiff7d.
OptTokenRatesPrices is optional TokenRatesPrices.
OptTonTransferAction is optional TonTransferAction.
OptUnSubscriptionAction is optional UnSubscriptionAction.
OptValidatorsSet is optional ValidatorsSet.
OptWalletDNS is optional WalletDNS.
OptWithdrawStakeAction is optional WithdrawStakeAction.
OptWithdrawStakeRequestAction is optional WithdrawStakeRequestAction.
Ref: #/components/schemas/Oracle.
Ref: #/components/schemas/OracleBridgeParams.
Ref: #/components/schemas/PoolImplementation.
Ref: #/components/schemas/PoolInfo.
Ref: #/components/schemas/Price.
Ref: #/components/schemas/RawBlockchainConfig.
Ref: #/components/schemas/ReducedBlock.
Ref: #/components/schemas/ReducedBlocks.
Ref: #/components/schemas/Refund.
ReindexAccountOK is response for ReindexAccount operation.
ReindexAccountParams is parameters of reindexAccount operation.
Risk specifies assets that could be lost if a message would be sent to a malicious smart contract.
Ref: #/components/schemas/Sale.
SearchAccountsParams is parameters of searchAccounts operation.
SendBlockchainMessageOK is response for SendBlockchainMessage operation.
No description provided by the author
No description provided by the author
No description provided by the author
Ref: #/components/schemas/Seqno.
Ref: #/components/schemas/ServiceStatus.
SetWalletBackupOK is response for SetWalletBackup operation.
SetWalletBackupParams is parameters of setWalletBackup operation.
No description provided by the author
Ref: #/components/schemas/SignRawMessage.
Ref: #/components/schemas/SignRawParams.
Ref: #/components/schemas/SizeLimitsConfig.
Ref: #/components/schemas/SmartContractAction.
Ref: #/components/schemas/StateInit.
Ref: #/components/schemas/StoragePhase.
Ref: #/components/schemas/StorageProvider.
StreamingAPI provides a convenient way to receive events happening on the TON blockchain.
No description provided by the author
Ref: #/components/schemas/Subscription.
Ref: #/components/schemas/SubscriptionAction.
Ref: #/components/schemas/Subscriptions.
Ref: #/components/schemas/TokenRates.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Ref: #/components/schemas/TonTransferAction.
Ref: #/components/schemas/Trace.
TraceEventData represents a notification about a completed trace.
Ref: #/components/schemas/TraceID.
Ref: #/components/schemas/TraceIDs.
Ref: #/components/schemas/Transaction.
TransactionEventData represents the data part of a new-transaction event.
Ref: #/components/schemas/Transactions.
Ref: #/components/schemas/TvmStackRecord.
Ref: #/components/schemas/UnSubscriptionAction.
Ref: #/components/schemas/Validator.
Ref: #/components/schemas/Validators.
Ref: #/components/schemas/ValidatorsSet.
No description provided by the author
Ref: #/components/schemas/ValueFlow.
No description provided by the author
Ref: #/components/schemas/WalletDNS.
Validator's participation in elections.
Validator's participation in elections.
Ref: #/components/schemas/WorkchainDescr.

# Interfaces

ClientOption is client config option.
No description provided by the author
Invoker invokes operations described by OpenAPI v3 specification.
No description provided by the author
Option is config option.
Websocket contains methods to configure a websocket connection to receive particular events from tonapi.io happening in the TON blockchain.

# Type aliases

{'USD': 1, 'IDR': 1000}.
Ref: #/components/schemas/AccountStatus.
Ref: #/components/schemas/AccStatusChange.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BlockHandler is a callback that handles a new block event.
Ref: #/components/schemas/BouncePhaseType.
Ref: #/components/schemas/ComputeSkipReason.
Used to sort the result-set in ascending or descending order by lt.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Ref: #/components/schemas/JettonVerificationType.
MempoolHandler is a callback that handles a new mempool event.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Ref: #/components/schemas/PoolImplementationType.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TraceHandler is a callback that handles a new trace event.
TransactionHandler is a callback that handles a new transaction event.
Ref: #/components/schemas/TransactionType.
Ref: #/components/schemas/TrustType.
No description provided by the author
WebsocketConfigurator configures an open websocket connection.