For the complete documentation index, see llms.txt. This page is also available as Markdown.

Indexer API

Getting Started

The TON Indexer API provides a powerful way to access indexed blockchain data from the TON network. By storing blockchain data in PostgreSQL, this API allows for efficient queries and retrieval of historical information.

Get Masterchain Info

get

Returns first and last blocks information, can be used as a start point for blockchain search process

Authorizations
X-API-KeystringRequired
Responses
200

Successful Response

application/json
get/api/v3/masterchainInfo

Get Blocks

get

Returns blocks by specified filters.

Authorizations
X-API-KeystringRequired
Query parameters
workchaininteger ยท nullableOptional

Block workchain.

shardstring ยท nullableOptional

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

seqnointeger ยท nullableOptional

Block seqno. Must be sent with workchain and shard.

start_utimeinteger ยท nullableOptional

Query blocks with generation UTC timestamp after given timestamp.

end_utimeinteger ยท nullableOptional

Query blocks with generation UTC timestamp before given timestamp

start_ltinteger ยท nullableOptional

Query blocks with lt >= start_lt

end_ltinteger ยท nullableOptional

Query blocks with lt <= end_lt

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
200

Successful Response

application/json
get/api/v3/blocks

Get Shards By Masterchain Block

get

Returns one masterchain block (with seqno equal to argument) and some number of shard blocks (with masterchain_block_ref.seqno equal to argument)

Authorizations
X-API-KeystringRequired
Query parameters
seqnointegerRequired

Masterchain block seqno

Responses
200

Successful Response

application/json
get/api/v3/masterchainBlockShardState

Get Address Book

get

Generates and returns a user-friendly address book for a given contract address list.

Authorizations
X-API-KeystringRequired
Query parameters
addressstring[]Required

List of addresses in any form. Max list size: 1024

Responses
200

Successful Response

application/json
get/api/v3/addressBook

Get Masterchain Block Shards

get

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

Note: this method is not equivalent with /api/v2/shards.

Authorizations
X-API-KeystringRequired
Query parameters
seqnointegerRequired

Masterchain block seqno

Responses
200

Successful Response

application/json
get/api/v3/masterchainBlockShards

Get Transactions

get

Returns transactions by specified filters.

Authorizations
X-API-KeystringRequired
Query parameters
workchaininteger ยท nullableOptional

Block workchain.

shardstring ยท nullableOptional

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

seqnointeger ยท nullableOptional

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

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

hashstring ยท nullableOptional

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

ltinteger ยท nullableOptional

Transaction lt.

start_utimeinteger ยท nullableOptional

Query transactions with generation UTC timestamp after given timestamp.

end_utimeinteger ยท nullableOptional

Query transactions with generation UTC timestamp before given timestamp

start_ltinteger ยท nullableOptional

Query transactions with lt >= start_lt

end_ltinteger ยท nullableOptional

Query transactions with lt <= end_lt

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
200

Successful Response

application/json
get/api/v3/transactions

Get Transactions By Masterchain Block

get

Returns transactions from masterchain block and from all shards.

Authorizations
X-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
200

Successful Response

application/json
get/api/v3/transactionsByMasterchainBlock

Get Transactions By Message

get

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

Authorizations
X-API-KeystringRequired
Query parameters
directionstring ยท enum ยท nullableRequired

Message direction.

Possible values:
msg_hashstring ยท nullableRequired

Message hash. Acceptable 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
200

Successful Response

application/json
get/api/v3/transactionsByMessage

Get Adjacent Transactions

get

Returns parent and/or children for specified transaction.

Authorizations
X-API-KeystringRequired
Query parameters
hashstringRequired

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

directionstring ยท enum ยท nullableOptional

Direction transactions by lt.

Default: bothPossible values:
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
200

Successful Response

application/json
get/api/v3/adjacentTransactions

Get Messages

get

Returns messages by specified filters.

Authorizations
X-API-KeystringRequired
Query parameters
hashstringOptional

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

sourcestring ยท nullableOptional

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

destinationstring ยท nullableOptional

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

body_hashstring ยท nullableOptional

Message body hash. Acceptable 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
200

Successful Response

application/json
get/api/v3/messages

Get Nft Collections

get

Returns NFT collections.

Authorizations
X-API-KeystringRequired
Query parameters
collection_addressstring ยท nullableOptional

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

owner_addressstring ยท nullableOptional

Address of NFT collection owner. Must be sent in hex, base64 or 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
200

Successful Response

application/json
get/api/v3/nft/collections

Get Nft Items

get

Returns NFT items.

Authorizations
X-API-KeystringRequired
Query parameters
addressstring ยท nullableOptional

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

owner_addressstring ยท nullableOptional

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

collection_addressstring ยท nullableOptional

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

indexstring ยท nullableOptional

NFT Item index. Use it together with collection address.

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
200

Successful Response

application/json
get/api/v3/nft/items

Get Nft Transfers

get

Returns NFT transfers by specified filters.

Authorizations
X-API-KeystringRequired
Query parameters
addressstring ยท nullableOptional

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

item_addressstring ยท nullableOptional

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

collection_addressstring ยท nullableOptional

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

directionstring ยท enum ยท nullableOptional

Direction transactions by lt.

Default: bothPossible values:
start_utimeinteger ยท nullableOptional

Query transactions with generation UTC timestamp after given timestamp.

end_utimeinteger ยท nullableOptional

Query transactions with generation UTC timestamp before given timestamp

start_ltinteger ยท nullableOptional

Query transactions with lt >= start_lt

end_ltinteger ยท nullableOptional

Query transactions with lt <= end_lt

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
200

Successful Response

application/json
get/api/v3/nft/transfers

Get Jetton Masters

get

Returns Jetton masters by specified filters.

Authorizations
X-API-KeystringRequired
Query parameters
addressstringOptional

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

admin_addressstringOptional

Address of Jetton Master's admin. Must be sent in hex, base64 or 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
200

Successful Response

application/json
get/api/v3/jetton/masters

Get Jetton Wallets

get

Returns Jetton wallets by specified filters.

Authorizations
X-API-KeystringRequired
Query parameters
addressstringOptional

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

owner_addressstringOptional

Address of Jetton wallet's owner. Must be sent in hex, base64 or base64url forms.

jetton_addressstringOptional

Jetton Master. Must be sent in hex, base64 or 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
200

Successful Response

application/json
get/api/v3/jetton/wallets

Get Jetton Transfers

get

Returns Jetton transfers by specified filters.

Authorizations
X-API-KeystringRequired
Query parameters
addressstring ยท nullableOptional

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

jetton_walletstring ยท nullableOptional

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

jetton_masterstring ยท nullableOptional

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

directionstring ยท enum ยท nullableOptional

Direction transactions by lt.

Default: bothPossible values:
start_utimeinteger ยท nullableOptional

Query transactions with generation UTC timestamp after given timestamp.

end_utimeinteger ยท nullableOptional

Query transactions with generation UTC timestamp before given timestamp

start_ltinteger ยท nullableOptional

Query transactions with lt >= start_lt

end_ltinteger ยท nullableOptional

Query transactions with lt <= end_lt

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
200

Successful Response

application/json
get/api/v3/jetton/transfers

Get Jetton Burns

get

Returns Jetton burns by specified filters.

Authorizations
X-API-KeystringRequired
Query parameters
addressstring ยท nullableOptional

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

jetton_walletstring ยท nullableOptional

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

jetton_masterstring ยท nullableOptional

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

start_utimeinteger ยท nullableOptional

Query transactions with generation UTC timestamp after given timestamp.

end_utimeinteger ยท nullableOptional

Query transactions with generation UTC timestamp before given timestamp

start_ltinteger ยท nullableOptional

Query transactions with lt >= start_lt

end_ltinteger ยท nullableOptional

Query transactions with lt <= end_lt

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
200

Successful Response

application/json
get/api/v3/jetton/burns

Send Message

post

Send external message in boc base64 format to TON network. Returns message hash in hex format.

External messages are sent from the outside to the smart contracts to make them perform certain actions. For instance, a wallet smart contract expects to receive external messages signed by the wallet's owner.

Authorizations
X-API-KeystringRequired
Body

Message in base64 boc serialized format.

bocstringRequiredExample: te6ccgECBQEAARUAAkWIAWTtae+KgtbrX26Bep8JSq8lFLfGOoyGR/xwdjfvpvEaHg
Responses
200

Successful Response

application/json
message_hashstringRequired

Hash of sent message in hex format

Example: 383E348617141E35BC25ED9CD0EDEC2A4EAF6413948BF1FB7F865CEFE8C2CD44
post/api/v3/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
X-API-KeystringRequired
Body
addressstringRequired

Contract address in any format

Example: EQBSzBN6cnxDwDjn_IQXqgU8OJXUMcol9pxyL-yLkpKzYs9U
methodstringRequired

Method name to run

Example: seqno
Responses
200

Successful Response

application/json
gas_usedintegerRequired
exit_codeintegerRequired
post/api/v3/runGetMethod

Get Account Information

get

Get smart contract information.

Authorizations
X-API-KeystringRequired
Query parameters
addressstringRequired

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

Responses
200

Successful Response

application/json
balancestringRequired
codestring ยท nullableRequired
datastring ยท nullableRequired
last_transaction_ltstring ยท nullableRequired
last_transaction_hashstring ยท nullableRequired
frozen_hashstring ยท nullableRequired
statusstring ยท enumRequiredPossible values:
get/api/v3/account

Estimate Fee

post

Estimate fees required for query processing.

Body, init_code and init_data accepted in base64 encoded format.

Authorizations
X-API-KeystringRequired
Body
addressstringRequired
bodystringRequired
init_codestring ยท nullableOptional
init_datastring ยท nullableOptional
ignore_chksigbooleanOptionalDefault: true
Responses
200

Successful Response

application/json
post/api/v3/estimateFee

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
X-API-KeystringRequired
Query parameters
addressstringRequired

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

Responses
200

Successful Response

application/json
balancestringRequired
wallet_typestring ยท nullableRequired
seqnointeger ยท nullableRequired
wallet_idinteger ยท nullableRequired
last_transaction_ltstring ยท nullableRequired
last_transaction_hashstring ยท nullableRequired
statusstring ยท enumRequiredPossible values:
get/api/v3/wallet

Last updated