TON HTTP API
v2.0.0https://ton.nownodes.iohttps://ton-open-api.nownodes.iohttps://ton-index.nownodes.ioThis API enables HTTP access to TON blockchain - getting accounts and wallets information, looking up blocks and transactions, sending messages to the blockchain, calling get methods of smart contracts, and more.
In addition to REST API, all methods are available through JSON-RPC endpoint with method equal to method name and params passed as a dictionary.
The response contains a JSON object, which always has a boolean field ok and either error or result. If ok equals true, the request was successful and the result of the query can be found in the result field. In case of an unsuccessful request, ok equals false and the error is explained in the error.
API Key should be sent either as api_key query parameter or X-API-Key header.
Authentication
api-keyAuthapiKeyAPI Key: api-key in header
TON HTTP API
API V1 Reference
Get Address Information
Get basic information about the address: balance, code, data, last_transaction_id.
Parameters
addressstringrequiredqueryIdentifier of target TON account in any form.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Extended Address Information
Similar to previous one but tries to parse additional information for known contract types. This method is based on tonlib's function getAccountState. For detecting wallets we recommend to use getWalletInformation.
Parameters
addressstringrequiredqueryIdentifier of target TON account in any form.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Wallet Information
Retrieve wallet information. This method parses contract state and currently supports more wallet types than getExtendedAddressInformation: simple wallet, standart wallet, v3 wallet, v4 wallet.
Parameters
addressstringrequiredqueryIdentifier of target TON account in any form.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Transactions
Get transaction history of a given address.
Parameters
addressstringrequiredqueryIdentifier of target TON account in any form.
limitinteger<= 10010queryMaximum number of transactions in response.
ltintegerqueryLogical time of transaction to start with, must be sent with hash.
hashstringqueryHash of transaction to start with, in base64 or hex encoding , must be sent with lt.
to_ltinteger0queryLogical time of transaction to finish with (to get tx from lt to to_lt).
archivalbooleanfalsequeryBy default getTransaction request is processed by any available liteserver. If archival=true only liteservers with full history are used.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Address Balance
Get balance (in nanotons) of a given address.
Parameters
addressstringrequiredqueryIdentifier of target TON account in any form.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Address
Get state of a given address. State can be either unitialized, active or frozen.
Parameters
addressstringrequiredqueryIdentifier of target TON account in any form.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerPack Address
Convert an address from raw to human-readable format.
Parameters
addressstringrequiredqueryIdentifier of target TON account in raw form.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerUnpack Address
Convert an address from human-readable to raw format.
Parameters
addressstringrequiredqueryIdentifier of target TON account in user-friendly form
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Masterchain Info
Get up-to-date masterchain state.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Masterchain Block Signatures
Get up-to-date masterchain state.
Parameters
seqnointegerrequiredqueryResponse
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Shard Block Proof
Get merkle proof of shardchain block.
Parameters
workchainintegerrequiredqueryBlock workchain id
shardintegerrequiredqueryBlock shard id
seqnointegerrequiredqueryBlock seqno
from_seqnointegerquerySeqno of masterchain block starting from which proof is required. If not specified latest masterchain block is used.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Consensus Block
Get consensus block and its update timestamp.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerLookup Block
Look up block by either seqno, lt or unixtime.
Parameters
workchainintegerrequiredqueryWorkchain id to look up block in
shardintegerrequiredqueryShard id to look up block in
seqnointegerqueryBlock's height
ltintegerqueryBlock's logical time
unixtimeintegerqueryBlock's unixtime
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Shards
Get shards information.
Parameters
seqnointegerrequiredqueryMasterchain seqno to fetch shards of.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Block Transactions
Get transactions of the given block.
Parameters
workchainintegerrequiredqueryshardintegerrequiredqueryseqnointegerrequiredqueryroot_hashstringqueryfile_hashstringqueryafter_ltintegerqueryafter_hashstringquerycountinteger40queryResponse
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Block Transactions Ext
Get transactions of the given block.
Parameters
workchainintegerrequiredqueryshardintegerrequiredqueryseqnointegerrequiredqueryroot_hashstringqueryfile_hashstringqueryafter_ltintegerqueryafter_hashstringquerycountinteger40queryResponse
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Block Header
Get metadata of a given block.
Parameters
workchainintegerrequiredqueryshardintegerrequiredqueryseqnointegerrequiredqueryroot_hashstringqueryfile_hashstringqueryResponse
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Config Param
Get config by id.
Parameters
config_idintegerrequiredqueryConfig id
seqnointegerqueryMasterchain seqno. If not specified, latest blockchain state will be used.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Config All
Get cell with full config.
Parameters
seqnointegerqueryMasterchain seqno. If not specified, latest blockchain state will be used.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Out Msg Queue Sizes
Get info with current sizes of messages queues by shards.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Token Data
Get NFT or Jetton information.
Parameters
addressstringrequiredqueryAddress of NFT collection/item or Jetton master/wallet smart contract
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Try Locate Tx
Locate outcoming transaction of destination address by incoming message.
Parameters
sourcestringrequiredquerydestinationstringrequiredquerycreated_ltintegerrequiredqueryResponse
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Try Locate Result Tx
Same as previous. Locate outcoming transaction of destination address by incoming message
Parameters
sourcestringrequiredquerydestinationstringrequiredquerycreated_ltintegerrequiredqueryResponse
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerGet Try Locate Source Tx
Locate incoming transaction of source address by outcoming message.
Parameters
sourcestringrequiredquerydestinationstringrequiredquerycreated_ltintegerrequiredqueryResponse
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerDetect Address
Get all possible address forms.
Parameters
addressstringrequiredqueryIdentifier of target TON account in any form.
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerSend Boc
Send serialized boc file: fully packed and serialized external message to blockchain.
Body
bocstringrequiredb64 encoded bag of cells
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerSend Boc Return Hash
Send serialized boc file: fully packed and serialized external message to blockchain. The method returns message hash.
Body
bocstringrequiredb64 encoded bag of cells
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerSend Query
Send query - unpacked external message. This method takes address, body and init-params (if any), packs it to external message and sends to network. All params should be boc-serialized.
Body
addressstringrequiredAddress in any format
bodystringrequiredb64-encoded boc-serialized cell with message body
init_codestringb64-encoded boc-serialized cell with init-code
init_datastringb64-encoded boc-serialized cell with init-data
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerEstimate Fee
Estimate fees required for query processing. body, init-code and init-data accepted in serialized format (b64-encoded).
Body
addressstringrequiredAddress in any format
bodystringrequiredb64-encoded cell with message body
init_codestringb64-encoded cell with init-code
init_datastringb64-encoded cell with init-data
ignore_chksigbooleantrueIf true during test query processing assume that all chksig operations return True
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerRun Get Method
Run get method on smart contract.
Body
addressstringrequiredContract address
methodstring | integerrequiredMethod name or method id
stackArray<Array<any>>requiredArray of stack elements: [['num',3], ['cell', cell_object], ['slice', slice_object]]
seqnointegerSeqno of masterchain block at which moment the Get Method is to be executed
Response
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerJsonrpc Handler
All methods in the API are available through JSON-RPC protocol (spec).
Body
methodstringrequiredparamsobject[object Object]idstringjsonrpcstringResponse
Successful Response
Validation Error
Lite Server Timeout
Authorization
api-keyAuthapiKey in headerREST api to TON blockchain explorer
API V2 Reference
Status
Response
status
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet blockchain block data
Parameters
block_idstringrequiredpathblock ID
Response
blockchain block
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet blockchain block shards
Parameters
masterchain_seqnointeger<int32>requiredpathmasterchain block seqno
Response
blockchain block shards
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet all blocks in all shards and workchains between target and previous masterchain block according to shards last blocks snapshot in masterchain. We don't recommend to build your app around this method because it has problem with scalability and will work very slow in the future.
Parameters
masterchain_seqnointeger<int32>requiredpathmasterchain block seqno
Response
blockchain blocks
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet all transactions in all shards and workchains between target and previous masterchain block according to shards last blocks snapshot in masterchain. We don't recommend to build your app around this method because it has problem with scalability and will work very slow in the future.
Parameters
masterchain_seqnointeger<int32>requiredpathmasterchain block seqno
Response
blockchain transactions
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet blockchain config from a specific block, if present.
Parameters
masterchain_seqnointeger<int32>requiredpathmasterchain block seqno
Response
blockchain config
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw blockchain config from a specific block, if present.
Parameters
masterchain_seqnointeger<int32>requiredpathmasterchain block seqno
Response
blockchain config
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet transactions from block
Parameters
block_idstringrequiredpathblock ID
Response
blockchain block transactions
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet transaction data
Parameters
transaction_idstringrequiredpathtransaction ID
Response
blockchain transaction
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet transaction data by message hash
Parameters
msg_idstringrequiredpathmessage ID
Response
transaction by message hash
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet blockchain validators
Response
blockchain validators
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet last known masterchain block
Response
blockchain masterchain head
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet low-level information about an account taken directly from the blockchain.
Parameters
account_idstringrequiredpathaccount ID
Response
raw account
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet account transactions
Parameters
account_idstringrequiredpathaccount ID
after_ltinteger<int64>queryomit this parameter to get last transactions
before_ltinteger<int64>queryomit this parameter to get last transactions
limitinteger<int32>[1, 1000]100queryResponse
blockchain account transactions
Some error during request processing
Authorization
api-keyAuthapiKey in headerExecute get method for account
Parameters
account_idstringrequiredpathaccount ID
method_namestringrequiredpathcontract get method name
argsArray<string>queryResponse
method execution result
Some error during request processing
Authorization
api-keyAuthapiKey in headerSend message to blockchain
Body
both a single boc and a batch of boc serialized in base64 are accepted
bocstringbatchArray<string>Response
the message has been sent
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet blockchain config
Response
blockchain config
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw blockchain config
Response
blockchain config
Some error during request processing
Authorization
api-keyAuthapiKey in headerBlockchain account inspect
Parameters
account_idstringrequiredpathaccount ID
Response
blockchain account inspect
Some error during request processing
Authorization
api-keyAuthapiKey in headerDecode a given message. Only external incoming messages can be decoded currently.
Body
bag-of-cells serialized to base64
bocstringrequiredResponse
decoded message
Some error during request processing
Authorization
api-keyAuthapiKey in headerparse address and display in all formats
Parameters
account_idstringrequiredpathaccount ID
Response
all forms and info
Some error during request processing
Authorization
api-keyAuthapiKey in headerEmulate sending message to blockchain
Body
bag-of-cells serialized to base64
bocstringrequiredParameters
Accept-Languagestringenheaderignore_signature_checkbooleanqueryResponse
emulated event
Some error during request processing
Authorization
api-keyAuthapiKey in headerEmulate sending message to blockchain
Body
bag-of-cells serialized to base64
bocstringrequiredParameters
ignore_signature_checkbooleanqueryResponse
emulated trace
Some error during request processing
Authorization
api-keyAuthapiKey in headerEmulate sending message to blockchain
Body
bag-of-cells serialized to base64 and additional parameters to configure emulation
bocstringrequiredparamsArray<object>additional per account configuration
Parameters
Accept-LanguagestringenheaderResponse
emulated message
Some error during request processing
Authorization
api-keyAuthapiKey in headerEmulate sending message to blockchain
Body
bag-of-cells serialized to base64
bocstringrequiredParameters
Accept-Languagestringenheaderaccount_idstringrequiredpathaccount ID
ignore_signature_checkbooleanqueryResponse
emulated message to account
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet human-friendly information about several accounts without low-level details.
Body
a list of account ids
account_idsArray<string>requiredResponse
a list of accounts
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet human-friendly information about an account without low-level details.
Parameters
account_idstringrequiredpathaccount ID
Response
account
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet account's domains
Parameters
account_idstringrequiredpathaccount ID
Response
account's domains
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet all Jettons balances by owner address
Parameters
account_idstringrequiredpathaccount ID
currenciesArray<string>queryaccept ton and all possible fiat currencies, separated by commas
Response
account jettons balances
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet the transfer jettons history for account
Parameters
account_idstringrequiredpathaccount ID
Accept-Languagestringenheaderbefore_ltinteger<int64>queryomit this parameter to get last events
limitinteger[1, 1000]requiredquerystart_dateinteger<int64>queryend_dateinteger<int64>queryResponse
account jettons history
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet the transfer jetton history for account and jetton
Parameters
account_idstringrequiredpathaccount ID
jetton_idstringrequiredpathjetton ID
Accept-Languagestringenheaderbefore_ltinteger<int64>queryomit this parameter to get last events
limitinteger[1, 1000]requiredquerystart_dateinteger<int64>queryend_dateinteger<int64>queryResponse
account jetton history
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet all NFT items by owner address
Parameters
account_idstringrequiredpathaccount ID
collectionstringquerynft collection
limitinteger[1, 1000]1000queryoffsetinteger>= 00queryindirect_ownershipbooleanfalsequerySelling nft items in ton implemented usually via transfer items to special selling account. This option enables including items which owned not directly.
Response
account nft items
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet the transfer nft history
Parameters
account_idstringrequiredpathaccount ID
Accept-Languagestringenheaderbefore_ltinteger<int64>queryomit this parameter to get last events
limitinteger[1, 1000]requiredquerystart_dateinteger<int64>queryend_dateinteger<int64>queryResponse
nft history
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet 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 into actions, where a single action represents a meaningful high-level operation like a Jetton Transfer or an NFT Purchase. Actions are expected to be shown to users. It is advised not to build any logic on top of actions because actions can be changed at any time.
Parameters
account_idstringrequiredpathaccount ID
Accept-LanguagestringenheaderinitiatorbooleanfalsequeryShow only events that are initiated by this account
subject_onlybooleanfalsequeryfilter actions where requested account is not real subject (for example sender or receiver jettons)
before_ltinteger<int64>queryomit this parameter to get last events
limitinteger[1, 100]requiredquerystart_dateinteger<int64>queryend_dateinteger<int64>queryResponse
account's events
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet event for an account by event_id
Parameters
account_idstringrequiredpathaccount ID
event_idstringrequiredpathevent ID or transaction hash in hex (without 0x) or base64url format
Accept-Languagestringenheadersubject_onlybooleanfalsequeryfilter actions where requested account is not real subject (for example sender or receiver jettons)
Response
account's event
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet traces for account
Parameters
account_idstringrequiredpathaccount ID
limitinteger[1, 1000]100queryResponse
account's traces
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet all subscriptions by wallet address
Parameters
account_idstringrequiredpathaccount ID
Response
account's subscriptions
Some error during request processing
Authorization
api-keyAuthapiKey in headerUpdate internal cache for a particular account
Parameters
account_idstringrequiredpathaccount ID
Response
success
Some error during request processing
Authorization
api-keyAuthapiKey in headerSearch by account domain name
Parameters
namestringrequiredqueryResponse
found accounts
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet expiring account .ton dns
Parameters
account_idstringrequiredpathaccount ID
periodinteger[1, 3660]querynumber of days before expiration
Response
account's expiring .ton dns
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet public key by account id
Parameters
account_idstringrequiredpathaccount ID
Response
account's public key
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet account's balance change
Parameters
account_idstringrequiredpathaccount ID
start_dateinteger<int64>requiredqueryend_dateinteger<int64>requiredqueryResponse
account's balance change
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet full information about domain name
Parameters
domain_namestringrequiredpathdomain name with .ton or .t.me
Response
domain info
Some error during request processing
Authorization
api-keyAuthapiKey in headerDNS resolve for domain name
Parameters
domain_namestringrequiredpathdomain name with .ton or .t.me
Response
dns record
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet domain bids
Parameters
domain_namestringrequiredpathdomain name with .ton or .t.me
Response
domain bids
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet all auctions
Parameters
tldstringquerydomain filter for current auctions "ton" or "t.me"
Response
auctions
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet NFT collections
Parameters
limitinteger<int32>[1, 1000]100queryoffsetinteger<int32>>= 00queryResponse
nft collections
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet NFT collection by collection address
Parameters
account_idstringrequiredpathaccount ID
Response
nft collection
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet NFT items from collection by collection address
Parameters
account_idstringrequiredpathaccount ID
limitinteger[1, 1000]1000queryoffsetinteger>= 00queryResponse
nft items
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet NFT items by their addresses
Body
a list of account ids
account_idsArray<string>requiredResponse
nft items
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet NFT item by its address
Parameters
account_idstringrequiredpathaccount ID
Response
nft item
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet the transfer nfts history for account
Parameters
account_idstringrequiredpathaccount ID
Accept-Languagestringenheaderbefore_ltinteger<int64>queryomit this parameter to get last events
limitinteger[1, 1000]requiredquerystart_dateinteger<int64>queryend_dateinteger<int64>queryResponse
nft history
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet the trace by trace ID or hash of any transaction in trace
Parameters
trace_idstringrequiredpathtrace ID or transaction hash in hex (without 0x) or base64url format
Response
trace
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet an event either by event ID or a hash of any transaction in a trace. An 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 into actions, where a single action represents a meaningful high-level operation like a Jetton Transfer or an NFT Purchase. Actions are expected to be shown to users. It is advised not to build any logic on top of actions because actions can be changed at any time.
Parameters
event_idstringrequiredpathevent ID or transaction hash in hex (without 0x) or base64url format
Accept-LanguagestringenheaderResponse
event
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet all inscriptions by owner address. It's experimental API and can be dropped in the future.
Parameters
account_idstringrequiredpathaccount ID
limitinteger[1, 1000]1000queryoffsetinteger>= 00queryResponse
account inscriptions
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet the transfer inscriptions history for account. It's experimental API and can be dropped in the future.
Parameters
account_idstringrequiredpathaccount ID
Accept-Languagestringenheaderbefore_ltinteger<int64>queryomit this parameter to get last events
limitinteger[1, 1000]100queryResponse
account inscriptions history
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet the transfer inscriptions history for account. It's experimental API and can be dropped in the future.
Parameters
account_idstringrequiredpathaccount ID
Accept-Languagestringenheadertickerstringrequiredpathbefore_ltinteger<int64>queryomit this parameter to get last events
limitinteger[1, 1000]100queryResponse
account inscriptions history
Some error during request processing
Authorization
api-keyAuthapiKey in headerreturn comment for making operation with inscription. please don't use it if you don't know what you are doing
Parameters
typestrington20gram20requiredquerydestinationstringquerycommentstringqueryoperationstringtransferrequiredqueryamountstringrequiredquerytickerstringrequiredquerywhostringrequiredqueryResponse
inscription op template
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet a list of all indexed jetton masters in the blockchain.
Parameters
limitinteger<int32>[1, 1000]100queryoffsetinteger<int32>>= 00queryResponse
a list of jettons
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet jetton metadata by jetton master address
Parameters
account_idstringrequiredpathaccount ID
Response
jetton info
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet jetton's holders
Parameters
account_idstringrequiredpathaccount ID
limitinteger[1, 1000]1000queryoffsetinteger>= 00queryResponse
jetton's holders
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet only jetton transfers in the event
Parameters
event_idstringrequiredpathevent ID or transaction hash in hex (without 0x) or base64url format
Accept-LanguagestringenheaderResponse
events
Some error during request processing
Authorization
api-keyAuthapiKey in headerAll pools where account participates
Parameters
account_idstringrequiredpathaccount ID
Response
account's pools
Some error during request processing
Authorization
api-keyAuthapiKey in headerStacking pool info
Parameters
account_idstringrequiredpathaccount ID
Accept-LanguagestringenheaderResponse
stacking pool info
Some error during request processing
Authorization
api-keyAuthapiKey in headerPool history
Parameters
account_idstringrequiredpathaccount ID
Response
pool history
Some error during request processing
Authorization
api-keyAuthapiKey in headerAll pools available in network
Parameters
available_forstringqueryaccount ID
include_unverifiedbooleanqueryreturn also pools not from white list - just compatible by interfaces (maybe dangerous!)
Accept-LanguagestringenheaderResponse
a list of pools
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet TON storage providers deployed to the blockchain.
Response
a list of storage providers
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet the token price to the currency
Parameters
tokensArray<string>requiredqueryaccept ton and jetton master addresses, separated by commas
currenciesArray<string>requiredqueryaccept ton and all possible fiat currencies, separated by commas
Response
tokens rates
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet chart by token
Parameters
tokenstringrequiredqueryaccept jetton master address
currencystringquerystart_dateinteger<int64>queryend_dateinteger<int64>querypoints_countinteger<int>[0, 200]200queryResponse
token chart
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet the TON price from markets
Response
markets rates
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet a payload for further token receipt
Response
payload
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet account info by state init
Body
Data that is expected
state_initstringrequiredResponse
account info
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet backup info
Parameters
X-TonConnect-AuthstringrequiredheaderResponse
get wallet dump
Some error during request processing
Authorization
api-keyAuthapiKey in headerSet backup info
Body
Information for saving backup
Parameters
X-TonConnect-AuthstringrequiredheaderResponse
success
Some error during request processing
Authorization
api-keyAuthapiKey in headerAccount verification and token issuance
Body
Data that is expected from TON Connect
addressstringrequiredproofobjectrequiredResponse
auth token
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet wallets by public key
Parameters
public_keystringrequiredpathResponse
a list of wallets
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet account seqno
Parameters
account_idstringrequiredpathaccount ID
Response
account seqno
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw masterchain info
Response
raw masterchain info
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw masterchain info ext
Parameters
modeinteger<int32>requiredquerymode
Response
raw masterchain info ext
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw time
Response
raw time
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw blockchain block
Parameters
block_idstringrequiredpathblock ID: (workchain,shard,seqno,root_hash,file_hash)
Response
raw blockchain block
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw blockchain block state
Parameters
block_idstringrequiredpathblock ID: (workchain,shard,seqno,root_hash,file_hash)
Response
raw blockchain block state
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw blockchain block header
Parameters
block_idstringrequiredpathblock ID: (workchain,shard,seqno,root_hash,file_hash)
modeinteger<int32>requiredquerymode
Response
raw blockchain block header
Some error during request processing
Authorization
api-keyAuthapiKey in headerSend raw message to blockchain
Body
Data that is expected
bodystringrequiredResponse
code
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw account state
Parameters
account_idstringrequiredpathaccount ID
target_blockstringquerytarget block: (workchain,shard,seqno,root_hash,file_hash)
Response
raw account state
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw shard info
Parameters
block_idstringrequiredpathblock ID: (workchain,shard,seqno,root_hash,file_hash)
workchaininteger<int32>requiredqueryworkchain
shardinteger<int64>requiredqueryshard
exactbooleanrequiredqueryexact
Response
raw shard info
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet all raw shards info
Parameters
block_idstringrequiredpathblock ID: (workchain,shard,seqno,root_hash,file_hash)
Response
all raw shards info
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw transactions
Parameters
account_idstringrequiredpathaccount ID
countinteger<int32>requiredquerycount
ltinteger<int64>requiredquerylt
hashstringrequiredqueryhash
Response
raw transactions
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw list block transactions
Parameters
block_idstringrequiredpathblock ID: (workchain,shard,seqno,root_hash,file_hash)
modeinteger<int32>requiredquerymode
countinteger<int32>requiredquerycount
account_idstringqueryaccount ID
ltinteger<int64>querylt
Response
a list of raw block transactions
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw block proof
Parameters
known_blockstringrequiredqueryknown block: (workchain,shard,seqno,root_hash,file_hash)
target_blockstringquerytarget block: (workchain,shard,seqno,root_hash,file_hash)
modeinteger<int32>requiredquerymode
Response
raw block proof
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw config
Parameters
block_idstringrequiredpathblock ID: (workchain,shard,seqno,root_hash,file_hash)
modeinteger<int32>requiredquerymode
Response
raw config
Some error during request processing
Authorization
api-keyAuthapiKey in headerGet raw shard block proof
Parameters
block_idstringrequiredpathblock ID: (workchain,shard,seqno,root_hash,file_hash)
Response
raw shard block proof
Some error during request processing
Authorization
api-keyAuthapiKey in headerTON Index (mainnet)
API V3 Reference (Index)
Get Masterchain Info
Get up-to-date masterchain state.
Response
Successful Response
Authorization
api-keyAuthapiKey in headerGet Blocks
Returns blocks by specified filters.
Parameters
workchainintegerqueryBlock workchain.
shardstringqueryBlock shard id. Must be sent with workchain. Example: 8000000000000000
seqnointegerqueryBlock block seqno. Must be sent with workchain and shard.
start_utimeintegerqueryQuery blocks with generation UTC timestamp after given timestamp.
end_utimeintegerqueryQuery blocks with generation UTC timestamp before given timestamp
start_ltintegerqueryQuery blocks with lt >= start_lt
end_ltintegerqueryQuery blocks with lt <= end_lt
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
sortstringascdescdescquerySort results by UTC timestamp.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Shards By Masterchain Block
Parameters
seqnointegerrequiredqueryMasterchain block seqno
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Address Book
Returns an address book for given address list.
Parameters
addressArray<string>requiredqueryList of addresses in any form. Max: 1024
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Masterchain Block Shards
Returns all worchain blocks, that appeared after previous masterchain block.
Note: this method is not equivalent with /api/v2/shards.
Parameters
seqnointegerrequiredqueryMasterchain block seqno
include_mc_blockbooleanfalsequeryInclude masterchain block
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Transactions
Get transactions by specified filters.
Parameters
workchainintegerqueryBlock workchain.
shardstringqueryBlock shard id. Must be sent with workchain. Example: 8000000000000000
seqnointegerqueryBlock block seqno. Must be sent with workchain and shard. Must be sent in hex form.
accountArray<string>queryList of account addresses to get transactions. Can be sent in hex, base64 or base64url form.
exclude_accountArray<string>queryExclude transactions on specified account addresses
hashstringqueryTransaction hash. Acceptable in hex, base64 and base64url forms.
ltintegerqueryTransaction lt.
start_utimeintegerqueryQuery transactions with generation UTC timestamp after given timestamp.
end_utimeintegerqueryQuery transactions with generation UTC timestamp before given timestamp
start_ltintegerqueryQuery transactions with lt >= start_lt
end_ltintegerqueryQuery transactions with lt <= end_lt
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
sortstringascdescdescquerySort transactions by lt.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Transactions By Masterchain Block
Returns transactions from masterchain block and from all shards.
Parameters
seqnointegerrequiredqueryMasterchain block seqno
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
sortstringnoneascdescdescquerySort transactions by lt.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Transactions By Message
Get transactions whose inbound/outbound message has the specified hash. This endpoint returns list of Transaction objects since collisions of message hashes can occur.
Parameters
directionstringinoutrequiredqueryMessage direction.
msg_hashstringrequiredqueryMessage hash. Acceptable in hex, base64 and base64url forms.
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Adjacent Transactions
Get parent and/or children for specified transaction.
Parameters
hashstringrequiredqueryTransaction hash. Acceptable in hex, base64 and base64url forms.
directionstringinoutbothbothqueryDirection transactions by lt.
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
sortstringnoneascdescdescquerySort transactions by lt.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Messages
Get messages by specified filters.
Parameters
hashstringqueryMessage hash. Acceptable in hex, base64 and base64url forms.
sourcestringqueryThe source account address. Can be sent in hex, base64 or base64url form. Use value null to get external messages.
destinationstringqueryThe destination account address. Can be sent in hex, base64 or base64url form. Use value null to get log messages.
body_hashstringqueryMessage body hash. Acceptable in hex, base64 and base64url forms.
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Nft Collections
Get NFT collections.
Parameters
collection_addressstringqueryNFT collection address. Must be sent in hex, base64 and base64url forms.
owner_addressstringqueryAddress of NFT collection owner. Must be sent in hex, base64 and base64url forms.
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Nft Items
Get NFT items.
Parameters
addressstringqueryNFT address. Must be sent in hex, base64 and base64url forms.
owner_addressstringqueryAddress of NFT owner. Must be sent in hex, base64 and base64url forms.
collection_addressstringqueryNFT collection address. Must be sent in hex, base64 and base64url forms.
indexstringqueryNFT Item index. Use it together with collection address.
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Nft Transfers
Get NFT transfers by specified filters.
Parameters
addressstringqueryAddress of NFT owner. Must be sent in hex, base64 and base64url forms.
item_addressstringqueryNFT item address. Must be sent in hex, base64 and base64url forms.
collection_addressstringqueryNFT collection address. Must be sent in hex, base64 and base64url forms.
directionstringinoutbothbothqueryDirection transactions by lt.
start_utimeintegerqueryQuery transactions with generation UTC timestamp after given timestamp.
end_utimeintegerqueryQuery transactions with generation UTC timestamp before given timestamp
start_ltintegerqueryQuery transactions with lt >= start_lt
end_ltintegerqueryQuery transactions with lt <= end_lt
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
sortstringascdescdescquerySort transactions by lt.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Jetton Masters
Get Jetton masters by specified filters.
Parameters
addressstringqueryJetton Master address. Must be sent in hex, base64 and base64url forms.
admin_addressstringqueryAddress of Jetton Masters admin. Must be sent in hex, base64 and base64url forms.
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Jetton Wallets
Get Jetton wallets by specified filters.
Parameters
addressstringqueryJetton wallet address. Must be sent in hex, base64 and base64url forms.
owner_addressstringqueryAddress of Jetton wallets owner. Must be sent in hex, base64 and base64url forms.
jetton_addressstringqueryJetton Master. Must be sent in hex, base64 and base64url forms.
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Jetton Transfers
Get Jetton transfers by specified filters.
Parameters
addressstringqueryAccount address. Must be sent in hex, base64 and base64url forms.
jetton_walletstringqueryJetton wallet address. Must be sent in hex, base64 and base64url forms.
jetton_masterstringqueryJetton master address. Must be sent in hex, base64 and base64url forms.
directionstringinoutbothbothqueryDirection transactions by lt.
start_utimeintegerqueryQuery transactions with generation UTC timestamp after given timestamp.
end_utimeintegerqueryQuery transactions with generation UTC timestamp before given timestamp
start_ltintegerqueryQuery transactions with lt >= start_lt
end_ltintegerqueryQuery transactions with lt <= end_lt
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
sortstringnoneascdescdescquerySort transactions by lt.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Jetton Burns
Get Jetton burns by specified filters.
Parameters
addressstringqueryAccount address. Must be sent in hex, base64 and base64url forms.
jetton_walletstringqueryJetton wallet address. Must be sent in hex, base64 and base64url forms.
jetton_masterstringqueryJetton master address. Must be sent in hex, base64 and base64url forms.
start_utimeintegerqueryQuery transactions with generation UTC timestamp after given timestamp.
end_utimeintegerqueryQuery transactions with generation UTC timestamp before given timestamp
start_ltintegerqueryQuery transactions with lt >= start_lt
end_ltintegerqueryQuery transactions with lt <= end_lt
limitinteger[1, 256]128queryLimit number of queried rows. Use with offset to batch read.
offsetinteger>= 00querySkip first N rows. Use with limit to batch read.
sortstringascdescdescquerySort transactions by lt.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerSend Message
Send external message to TON network.
Body
Message in boc base64 format.
Message in base64 boc serialized format.
bocstringrequiredResponse
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerRun Get Method
Run get method of smart contract. Stack supports only num, cell and slice types:
[
{
"type": "num",
"value": "0x12a"
},
{
"type": "cell",
"value": "te6..." // base64 encoded boc with cell
},
{
"type": "slice",
"value": "te6..." // base64 encoded boc with slice
}
]Body
RunGetMethod request body
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerEstimate Fee
Estimate fee for external message.
Body
EstimateFee request body
addressstringrequiredbodystringrequiredinit_codestringinit_datastringignore_chksigbooleantrueResponse
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Account Information
Get smart contract information.
Parameters
addressstringrequiredqueryAccount address. Can be sent in raw or user-friendly form.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in headerGet Wallet Information
Get wallet smart contract information. The following wallets are supported: v1r1, v1r2, v1r3, v2r1, v2r2, v3r1, v3r2, v4r1, v4r2.
In case the account is not a wallet error code 409 is returned.
Parameters
addressstringrequiredquerySmart contract address. Can be sent in raw or user-friendly form.
Response
Successful Response
Validation Error
Authorization
api-keyAuthapiKey in header