API V3 Reference (Index)

Get Masterchain Info

get

Get up-to-date masterchain state.

Authorizations
api-keystringRequired
Responses
chevron-right
200

Successful Response

application/json
get
/masterchainInfo

Get Blocks

get

Returns blocks by specified filters.

Authorizations
api-keystringRequired
Query parameters
workchainany ofOptional

Block workchain.

integerOptional
shardany ofOptional

Block shard id. Must be sent with workchain. Example: 8000000000000000

stringOptional
seqnoany ofOptional

Block block seqno. Must be sent with workchain and shard.

integerOptional
start_utimeany ofOptional

Query blocks with generation UTC timestamp after given timestamp.

integerOptional
end_utimeany ofOptional

Query blocks with generation UTC timestamp before given timestamp

integerOptional
start_ltany ofOptional

Query blocks with lt >= start_lt

integerOptional
end_ltany ofOptional

Query blocks with lt <= end_lt

integerOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
sortstring · enumOptional

Sort results by UTC timestamp.

Default: descPossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/blocks

Get Shards By Masterchain Block

get
Authorizations
api-keystringRequired
Query parameters
seqnointegerRequired

Masterchain block seqno

Responses
chevron-right
200

Successful Response

application/json
get
/masterchainBlockShardState

Get Address Book

get

Returns an address book for given address list.

Authorizations
api-keystringRequired
Query parameters
addressstring[]Required

List of addresses in any form. Max: 1024

Responses
chevron-right
200

Successful Response

application/json
get
/addressBook

Get Masterchain Block Shards

get

Returns all worchain blocks, that appeared after previous masterchain block.

Note: this method is not equivalent with /api/v2/shardsarrow-up-right.

Authorizations
api-keystringRequired
Query parameters
seqnointegerRequired

Masterchain block seqno

include_mc_blockbooleanOptional

Include masterchain block

Default: false
Responses
chevron-right
200

Successful Response

application/json
get
/masterchainBlockShards

Get Transactions

get

Get transactions by specified filters.

Authorizations
api-keystringRequired
Query parameters
workchainany ofOptional

Block workchain.

integerOptional
shardany ofOptional

Block shard id. Must be sent with workchain. Example: 8000000000000000

stringOptional
seqnoany ofOptional

Block block seqno. Must be sent with workchain and shard. Must be sent in hex form.

integerOptional
accountstring[]Optional

List of account addresses to get transactions. Can be sent in hex, base64 or base64url form.

exclude_accountstring[]Optional

Exclude transactions on specified account addresses

hashany ofOptional

Transaction hash. Acceptable in hex, base64 and base64url forms.

stringOptional
ltany ofOptional

Transaction lt.

integerOptional
start_utimeany ofOptional

Query transactions with generation UTC timestamp after given timestamp.

integerOptional
end_utimeany ofOptional

Query transactions with generation UTC timestamp before given timestamp

integerOptional
start_ltany ofOptional

Query transactions with lt >= start_lt

integerOptional
end_ltany ofOptional

Query transactions with lt <= end_lt

integerOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/transactions

Get Transactions By Masterchain Block

get

Returns transactions from masterchain block and from all shards.

Authorizations
api-keystringRequired
Query parameters
seqnointegerRequired

Masterchain block seqno

limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/transactionsByMasterchainBlock

Get Transactions By Message

get

Get transactions whose inbound/outbound message has the specified hash. This endpoint returns list of Transaction objects since collisions of message hashes can occur.

Authorizations
api-keystringRequired
Query parameters
directionany ofRequired

Message direction.

Possible values:
stringOptional
msg_hashany ofRequired

Message hash. Acceptable in hex, base64 and base64url forms.

stringOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
Responses
chevron-right
200

Successful Response

application/json
get
/transactionsByMessage

Get Adjacent Transactions

get

Get parent and/or children for specified transaction.

Authorizations
api-keystringRequired
Query parameters
hashstringRequired

Transaction hash. Acceptable in hex, base64 and base64url forms.

directionany ofOptional

Direction transactions by lt.

Default: bothPossible values:
stringOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/adjacentTransactions

Get Messages

get

Get messages by specified filters.

Authorizations
api-keystringRequired
Query parameters
hashstringOptional

Message hash. Acceptable in hex, base64 and base64url forms.

sourceany ofOptional

The source account address. Can be sent in hex, base64 or base64url form. Use value null to get external messages.

stringOptional
destinationany ofOptional

The destination account address. Can be sent in hex, base64 or base64url form. Use value null to get log messages.

stringOptional
body_hashany ofOptional

Message body hash. Acceptable in hex, base64 and base64url forms.

stringOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
Responses
chevron-right
200

Successful Response

application/json
get
/messages

Get Nft Collections

get

Get NFT collections.

Authorizations
api-keystringRequired
Query parameters
collection_addressany ofOptional

NFT collection address. Must be sent in hex, base64 and base64url forms.

stringOptional
owner_addressany ofOptional

Address of NFT collection owner. Must be sent in hex, base64 and base64url forms.

stringOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
Responses
chevron-right
200

Successful Response

application/json
get
/nft/collections

Get Nft Items

get

Get NFT items.

Authorizations
api-keystringRequired
Query parameters
addressany ofOptional

NFT address. Must be sent in hex, base64 and base64url forms.

stringOptional
owner_addressany ofOptional

Address of NFT owner. Must be sent in hex, base64 and base64url forms.

stringOptional
collection_addressany ofOptional

NFT collection address. Must be sent in hex, base64 and base64url forms.

stringOptional
indexany ofOptional

NFT Item index. Use it together with collection address.

stringOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
Responses
chevron-right
200

Successful Response

application/json
get
/nft/items

Get Nft Transfers

get

Get NFT transfers by specified filters.

Authorizations
api-keystringRequired
Query parameters
addressany ofOptional

Address of NFT owner. Must be sent in hex, base64 and base64url forms.

stringOptional
item_addressany ofOptional

NFT item address. Must be sent in hex, base64 and base64url forms.

stringOptional
collection_addressany ofOptional

NFT collection address. Must be sent in hex, base64 and base64url forms.

stringOptional
directionany ofOptional

Direction transactions by lt.

Default: bothPossible values:
stringOptional
start_utimeany ofOptional

Query transactions with generation UTC timestamp after given timestamp.

integerOptional
end_utimeany ofOptional

Query transactions with generation UTC timestamp before given timestamp

integerOptional
start_ltany ofOptional

Query transactions with lt >= start_lt

integerOptional
end_ltany ofOptional

Query transactions with lt <= end_lt

integerOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/nft/transfers

Get Jetton Masters

get

Get Jetton masters by specified filters.

Authorizations
api-keystringRequired
Query parameters
addressstringOptional

Jetton Master address. Must be sent in hex, base64 and base64url forms.

admin_addressstringOptional

Address of Jetton Masters admin. Must be sent in hex, base64 and base64url forms.

limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
Responses
chevron-right
200

Successful Response

application/json
get
/jetton/masters

Get Jetton Wallets

get

Get Jetton wallets by specified filters.

Authorizations
api-keystringRequired
Query parameters
addressstringOptional

Jetton wallet address. Must be sent in hex, base64 and base64url forms.

owner_addressstringOptional

Address of Jetton wallets owner. Must be sent in hex, base64 and base64url forms.

jetton_addressstringOptional

Jetton Master. Must be sent in hex, base64 and base64url forms.

limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
Responses
chevron-right
200

Successful Response

application/json
get
/jetton/wallets

Get Jetton Transfers

get

Get Jetton transfers by specified filters.

Authorizations
api-keystringRequired
Query parameters
addressany ofOptional

Account address. Must be sent in hex, base64 and base64url forms.

stringOptional
jetton_walletany ofOptional

Jetton wallet address. Must be sent in hex, base64 and base64url forms.

stringOptional
jetton_masterany ofOptional

Jetton master address. Must be sent in hex, base64 and base64url forms.

stringOptional
directionany ofOptional

Direction transactions by lt.

Default: bothPossible values:
stringOptional
start_utimeany ofOptional

Query transactions with generation UTC timestamp after given timestamp.

integerOptional
end_utimeany ofOptional

Query transactions with generation UTC timestamp before given timestamp

integerOptional
start_ltany ofOptional

Query transactions with lt >= start_lt

integerOptional
end_ltany ofOptional

Query transactions with lt <= end_lt

integerOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/jetton/transfers

Get Jetton Burns

get

Get Jetton burns by specified filters.

Authorizations
api-keystringRequired
Query parameters
addressany ofOptional

Account address. Must be sent in hex, base64 and base64url forms.

stringOptional
jetton_walletany ofOptional

Jetton wallet address. Must be sent in hex, base64 and base64url forms.

stringOptional
jetton_masterany ofOptional

Jetton master address. Must be sent in hex, base64 and base64url forms.

stringOptional
start_utimeany ofOptional

Query transactions with generation UTC timestamp after given timestamp.

integerOptional
end_utimeany ofOptional

Query transactions with generation UTC timestamp before given timestamp

integerOptional
start_ltany ofOptional

Query transactions with lt >= start_lt

integerOptional
end_ltany ofOptional

Query transactions with lt <= end_lt

integerOptional
limitinteger · min: 1 · max: 256Optional

Limit number of queried rows. Use with offset to batch read.

Default: 128
offsetintegerOptional

Skip first N rows. Use with limit to batch read.

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
chevron-right
200

Successful Response

application/json
get
/jetton/burns

Send Message

post

Send external message to TON network.

Authorizations
api-keystringRequired
Body

Message in boc base64 format.

Responses
chevron-right
200

Successful Response

application/json
message_hashstringRequired

Hash of sent message in hex format

Example: ["383E348617141E35BC25ED9CD0EDEC2A4EAF6413948BF1FB7F865CEFE8C2CD44"]
post
/message

Run Get Method

post

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
    }
]
Authorizations
api-keystringRequired
Body

RunGetMethod request body

Responses
chevron-right
200

Successful Response

application/json
gas_usedintegerRequired
exit_codeintegerRequired
post
/runGetMethod

Estimate Fee

post

Estimate fee for external message.

Authorizations
api-keystringRequired
Body

EstimateFee request body

Responses
chevron-right
200

Successful Response

application/json
post
/estimateFee

Get Account Information

get

Get smart contract information.

Authorizations
api-keystringRequired
Query parameters
addressstringRequired

Account address. Can be sent in raw or user-friendly form.

Responses
chevron-right
200

Successful Response

application/json
balancestringRequired
codeany ofRequired
stringOptional
dataany ofRequired
stringOptional
last_transaction_ltany ofRequired
stringOptional
last_transaction_hashany ofRequired
stringOptional
frozen_hashany ofRequired
stringOptional
statusstring · enumRequiredPossible values:
get
/account

Get Wallet Information

get

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.

Authorizations
api-keystringRequired
Query parameters
addressstringRequired

Smart contract address. Can be sent in raw or user-friendly form.

Responses
chevron-right
200

Successful Response

application/json
balancestringRequired
wallet_typeany ofRequired
stringOptional
seqnoany ofRequired
integerOptional
wallet_idany ofRequired
integerOptional
last_transaction_ltany ofRequired
stringOptional
last_transaction_hashany ofRequired
stringOptional
statusstring · enumRequiredPossible values:
get
/wallet

Last updated