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.

PreviousHTTP API NextBitcoin

Last updated 5 months ago

Was this helpful?

Get Masterchain Info

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

get

/api/v3/masterchainInfo

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/masterchainInfo' \
  --header 'X-API-Key: YOUR_API_KEY'

200

404

{
  "last": {
    "workchain": 1,
    "shard": "text",
    "seqno": 1,
    "root_hash": "text",
    "file_hash": "text",
    "global_id": 1,
    "version": 1,
    "after_merge": true,
    "before_split": true,
    "after_split": true,
    "want_merge": true,
    "want_split": true,
    "key_block": true,
    "vert_seqno_incr": true,
    "flags": 1,
    "gen_utime": "text",
    "start_lt": "text",
    "end_lt": "text",
    "validator_list_hash_short": 1,
    "gen_catchain_seqno": 1,
    "min_ref_mc_seqno": 1,
    "prev_key_block_seqno": 1,
    "vert_seqno": 1,
    "rand_seed": "text",
    "created_by": "text",
    "prev_blocks": [
      {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      }
    ],
    "master_ref_seqno": 1,
    "tx_count": 1,
    "masterchain_block_ref": {
      "workchain": 1,
      "shard": "text",
      "seqno": 1
    }
  },
  "first": {
    "workchain": 1,
    "shard": "text",
    "seqno": 1,
    "root_hash": "text",
    "file_hash": "text",
    "global_id": 1,
    "version": 1,
    "after_merge": true,
    "before_split": true,
    "after_split": true,
    "want_merge": true,
    "want_split": true,
    "key_block": true,
    "vert_seqno_incr": true,
    "flags": 1,
    "gen_utime": "text",
    "start_lt": "text",
    "end_lt": "text",
    "validator_list_hash_short": 1,
    "gen_catchain_seqno": 1,
    "min_ref_mc_seqno": 1,
    "prev_key_block_seqno": 1,
    "vert_seqno": 1,
    "rand_seed": "text",
    "created_by": "text",
    "prev_blocks": [
      {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      }
    ],
    "master_ref_seqno": 1,
    "tx_count": 1,
    "masterchain_block_ref": {
      "workchain": 1,
      "shard": "text",
      "seqno": 1
    }
  }
}

Successful Response

Get Blocks

Returns blocks by specified filters.

get

/api/v3/blocks

Authorizations

Query parameters

workchainWorkchain

Block workchain.

shardShard

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

seqnoSeqno

Block seqno. Must be sent with workchain and shard.

start_utimeStart Utime

Query blocks with generation UTC timestamp after given timestamp.

end_utimeEnd Utime

Query blocks with generation UTC timestamp before given timestamp

start_ltStart Lt

Query blocks with lt >= start_lt

end_ltEnd Lt

Query blocks with lt <= end_lt

limitLimit

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

offsetOffset

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

sortSort

Sort results by UTC timestamp.

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/blocks' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "blocks": [
    {
      "workchain": 1,
      "shard": "text",
      "seqno": 1,
      "root_hash": "text",
      "file_hash": "text",
      "global_id": 1,
      "version": 1,
      "after_merge": true,
      "before_split": true,
      "after_split": true,
      "want_merge": true,
      "want_split": true,
      "key_block": true,
      "vert_seqno_incr": true,
      "flags": 1,
      "gen_utime": "text",
      "start_lt": "text",
      "end_lt": "text",
      "validator_list_hash_short": 1,
      "gen_catchain_seqno": 1,
      "min_ref_mc_seqno": 1,
      "prev_key_block_seqno": 1,
      "vert_seqno": 1,
      "rand_seed": "text",
      "created_by": "text",
      "prev_blocks": [
        {
          "workchain": 1,
          "shard": "text",
          "seqno": 1
        }
      ],
      "master_ref_seqno": 1,
      "tx_count": 1,
      "masterchain_block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      }
    }
  ]
}

Successful Response

Get Shards By Masterchain Block

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

get

/api/v3/masterchainBlockShardState

Authorizations

Query parameters

seqnoSeqnorequired

Masterchain block seqno

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/masterchainBlockShardState?seqno=1' \
  --header 'X-API-Key: YOUR_API_KEY'

200

404

422

{
  "blocks": [
    {
      "workchain": 1,
      "shard": "text",
      "seqno": 1,
      "root_hash": "text",
      "file_hash": "text",
      "global_id": 1,
      "version": 1,
      "after_merge": true,
      "before_split": true,
      "after_split": true,
      "want_merge": true,
      "want_split": true,
      "key_block": true,
      "vert_seqno_incr": true,
      "flags": 1,
      "gen_utime": "text",
      "start_lt": "text",
      "end_lt": "text",
      "validator_list_hash_short": 1,
      "gen_catchain_seqno": 1,
      "min_ref_mc_seqno": 1,
      "prev_key_block_seqno": 1,
      "vert_seqno": 1,
      "rand_seed": "text",
      "created_by": "text",
      "prev_blocks": [
        {
          "workchain": 1,
          "shard": "text",
          "seqno": 1
        }
      ],
      "master_ref_seqno": 1,
      "tx_count": 1,
      "masterchain_block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      }
    }
  ]
}

Successful Response

Get Address Book

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

get

/api/v3/addressBook

Authorizations

Query parameters

addressAddressrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/addressBook?address=text' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "ANY_ADDITIONAL_PROPERTY": {
    "user_friendly": "text"
  }
}

Successful Response

Get Masterchain Block Shards

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

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

get

/api/v3/masterchainBlockShards

Authorizations

Query parameters

seqnoSeqnorequired

Masterchain block seqno

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/masterchainBlockShards?seqno=1' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "blocks": [
    {
      "workchain": 1,
      "shard": "text",
      "seqno": 1,
      "root_hash": "text",
      "file_hash": "text",
      "global_id": 1,
      "version": 1,
      "after_merge": true,
      "before_split": true,
      "after_split": true,
      "want_merge": true,
      "want_split": true,
      "key_block": true,
      "vert_seqno_incr": true,
      "flags": 1,
      "gen_utime": "text",
      "start_lt": "text",
      "end_lt": "text",
      "validator_list_hash_short": 1,
      "gen_catchain_seqno": 1,
      "min_ref_mc_seqno": 1,
      "prev_key_block_seqno": 1,
      "vert_seqno": 1,
      "rand_seed": "text",
      "created_by": "text",
      "prev_blocks": [
        {
          "workchain": 1,
          "shard": "text",
          "seqno": 1
        }
      ],
      "master_ref_seqno": 1,
      "tx_count": 1,
      "masterchain_block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      }
    }
  ]
}

Successful Response

Get Transactions

Returns transactions by specified filters.

get

/api/v3/transactions

Authorizations

Query parameters

workchainWorkchain

Block workchain.

shardShard

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

seqnoSeqno

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

accountAccount

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

exclude_accountExclude Account

Exclude transactions on specified account addresses

hashHash

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

ltLt

Transaction lt.

start_utimeStart Utime

Query transactions with generation UTC timestamp after given timestamp.

end_utimeEnd Utime

Query transactions with generation UTC timestamp before given timestamp

start_ltStart Lt

Query transactions with lt >= start_lt

end_ltEnd Lt

Query transactions with lt <= end_lt

limitLimit

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

offsetOffset

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

sortSort

Sort transactions by lt.

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/transactions' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "now": 1,
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "description": null,
      "out_msgs": [
        {
          "hash": "text",
          "source": "text",
          "destination": "text",
          "value": "text",
          "fwd_fee": "text",
          "ihr_fee": "text",
          "created_lt": "text",
          "created_at": "text",
          "opcode": "text",
          "ihr_disabled": true,
          "bounce": true,
          "bounced": true,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "type": "text_comment",
              "comment": "text"
            }
          },
          "init_state": {
            "hash": "text",
            "body": "text"
          }
        }
      ],
      "block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      },
      "in_msg": {
        "hash": "text",
        "source": "text",
        "destination": "text",
        "value": "text",
        "fwd_fee": "text",
        "ihr_fee": "text",
        "created_lt": "text",
        "created_at": "text",
        "opcode": "text",
        "ihr_disabled": true,
        "bounce": true,
        "bounced": true,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "type": "text_comment",
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "account_state_before": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "account_state_after": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "mc_block_seqno": 1
    }
  ],
  "address_book": {
    "ANY_ADDITIONAL_PROPERTY": {
      "user_friendly": "text"
    }
  }
}

Successful Response

Get Transactions By Masterchain Block

Returns transactions from masterchain block and from all shards.

get

/api/v3/transactionsByMasterchainBlock

Authorizations

Query parameters

seqnoSeqnorequired

Masterchain block seqno

limitLimit

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

offsetOffset

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

sortSort

Sort transactions by lt.

Options: none, asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/transactionsByMasterchainBlock?seqno=1' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "now": 1,
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "description": null,
      "out_msgs": [
        {
          "hash": "text",
          "source": "text",
          "destination": "text",
          "value": "text",
          "fwd_fee": "text",
          "ihr_fee": "text",
          "created_lt": "text",
          "created_at": "text",
          "opcode": "text",
          "ihr_disabled": true,
          "bounce": true,
          "bounced": true,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "type": "text_comment",
              "comment": "text"
            }
          },
          "init_state": {
            "hash": "text",
            "body": "text"
          }
        }
      ],
      "block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      },
      "in_msg": {
        "hash": "text",
        "source": "text",
        "destination": "text",
        "value": "text",
        "fwd_fee": "text",
        "ihr_fee": "text",
        "created_lt": "text",
        "created_at": "text",
        "opcode": "text",
        "ihr_disabled": true,
        "bounce": true,
        "bounced": true,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "type": "text_comment",
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "account_state_before": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "account_state_after": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "mc_block_seqno": 1
    }
  ],
  "address_book": {
    "ANY_ADDITIONAL_PROPERTY": {
      "user_friendly": "text"
    }
  }
}

Successful Response

Get Transactions By Message

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

get

/api/v3/transactionsByMessage

Authorizations

Query parameters

directionDirectionrequired

Message direction.

Options: in, out

msg_hashMsg Hashrequired

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

limitLimit

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

offsetOffset

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/transactionsByMessage?direction=in&msg_hash=text' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "now": 1,
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "description": null,
      "out_msgs": [
        {
          "hash": "text",
          "source": "text",
          "destination": "text",
          "value": "text",
          "fwd_fee": "text",
          "ihr_fee": "text",
          "created_lt": "text",
          "created_at": "text",
          "opcode": "text",
          "ihr_disabled": true,
          "bounce": true,
          "bounced": true,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "type": "text_comment",
              "comment": "text"
            }
          },
          "init_state": {
            "hash": "text",
            "body": "text"
          }
        }
      ],
      "block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      },
      "in_msg": {
        "hash": "text",
        "source": "text",
        "destination": "text",
        "value": "text",
        "fwd_fee": "text",
        "ihr_fee": "text",
        "created_lt": "text",
        "created_at": "text",
        "opcode": "text",
        "ihr_disabled": true,
        "bounce": true,
        "bounced": true,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "type": "text_comment",
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "account_state_before": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "account_state_after": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "mc_block_seqno": 1
    }
  ],
  "address_book": {
    "ANY_ADDITIONAL_PROPERTY": {
      "user_friendly": "text"
    }
  }
}

Successful Response

Get Adjacent Transactions

Returns parent and/or children for specified transaction.

get

/api/v3/adjacentTransactions

Authorizations

Query parameters

hashHashrequired

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

directionDirection

Direction transactions by lt.

Options: in, out, both

limitLimit

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

offsetOffset

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

sortSort

Sort transactions by lt.

Options: none, asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/adjacentTransactions?hash=text' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "now": 1,
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "description": null,
      "out_msgs": [
        {
          "hash": "text",
          "source": "text",
          "destination": "text",
          "value": "text",
          "fwd_fee": "text",
          "ihr_fee": "text",
          "created_lt": "text",
          "created_at": "text",
          "opcode": "text",
          "ihr_disabled": true,
          "bounce": true,
          "bounced": true,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "type": "text_comment",
              "comment": "text"
            }
          },
          "init_state": {
            "hash": "text",
            "body": "text"
          }
        }
      ],
      "block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      },
      "in_msg": {
        "hash": "text",
        "source": "text",
        "destination": "text",
        "value": "text",
        "fwd_fee": "text",
        "ihr_fee": "text",
        "created_lt": "text",
        "created_at": "text",
        "opcode": "text",
        "ihr_disabled": true,
        "bounce": true,
        "bounced": true,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "type": "text_comment",
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "account_state_before": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "account_state_after": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "mc_block_seqno": 1
    }
  ],
  "address_book": {
    "ANY_ADDITIONAL_PROPERTY": {
      "user_friendly": "text"
    }
  }
}

Successful Response

Get Messages

Returns messages by specified filters.

get

/api/v3/messages

Authorizations

Query parameters

hashHash

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

sourceSource

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

destinationDestination

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

body_hashBody Hash

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

limitLimit

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

offsetOffset

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/messages' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "messages": [
    {
      "hash": "text",
      "source": "text",
      "destination": "text",
      "value": "text",
      "fwd_fee": "text",
      "ihr_fee": "text",
      "created_lt": "text",
      "created_at": "text",
      "opcode": "text",
      "ihr_disabled": true,
      "bounce": true,
      "bounced": true,
      "import_fee": "text",
      "message_content": {
        "hash": "text",
        "body": "text",
        "decoded": {
          "type": "text_comment",
          "comment": "text"
        }
      },
      "init_state": {
        "hash": "text",
        "body": "text"
      }
    }
  ]
}

Successful Response

Get Nft Collections

Returns NFT collections.

get

/api/v3/nft/collections

Authorizations

Query parameters

collection_addressCollection Address

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

owner_addressOwner Address

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

limitLimit

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

offsetOffset

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/nft/collections' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "nft_collections": [
    {
      "address": "text",
      "last_transaction_lt": "text",
      "next_item_index": "text",
      "collection_content": null,
      "code_hash": "text",
      "data_hash": "text",
      "owner_address": "text"
    }
  ]
}

Successful Response

Get Nft Items

Returns NFT items.

get

/api/v3/nft/items

Authorizations

Query parameters

addressAddress

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

owner_addressOwner Address

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

collection_addressCollection Address

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

indexIndex

NFT Item index. Use it together with collection address.

limitLimit

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

offsetOffset

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/nft/items' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "nft_items": [
    {
      "address": "text",
      "init": true,
      "index": "text",
      "last_transaction_lt": "text",
      "code_hash": "text",
      "data_hash": "text",
      "content": null,
      "collection_address": "text",
      "owner_address": "text",
      "collection": {
        "address": "text",
        "last_transaction_lt": "text",
        "next_item_index": "text",
        "collection_content": null,
        "code_hash": "text",
        "data_hash": "text",
        "owner_address": "text"
      }
    }
  ]
}

Successful Response

Get Nft Transfers

Returns NFT transfers by specified filters.

get

/api/v3/nft/transfers

Authorizations

Query parameters

addressAddress

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

item_addressItem Address

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

collection_addressCollection Address

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

directionDirection

Direction transactions by lt.

Options: in, out, both

start_utimeStart Utime

Query transactions with generation UTC timestamp after given timestamp.

end_utimeEnd Utime

Query transactions with generation UTC timestamp before given timestamp

start_ltStart Lt

Query transactions with lt >= start_lt

end_ltEnd Lt

Query transactions with lt <= end_lt

limitLimit

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

offsetOffset

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

sortSort

Sort transactions by lt.

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/nft/transfers' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "nft_transfers": [
    {
      "query_id": "text",
      "nft_address": "text",
      "transaction_hash": "text",
      "transaction_lt": "text",
      "transaction_now": 1,
      "old_owner": "text",
      "new_owner": "text",
      "forward_amount": "text",
      "response_destination": "text",
      "custom_payload": "text",
      "forward_payload": "text"
    }
  ]
}

Successful Response

Get Jetton Masters

Returns Jetton masters by specified filters.

get

/api/v3/jetton/masters

Authorizations

Query parameters

addressAddress

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

admin_addressAdmin Address

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

limitLimit

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

offsetOffset

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/jetton/masters' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "jetton_masters": [
    {
      "address": "text",
      "total_supply": "text",
      "mintable": true,
      "last_transaction_lt": "text",
      "jetton_wallet_code_hash": "text",
      "jetton_content": null,
      "code_hash": "text",
      "data_hash": "text",
      "admin_address": "text"
    }
  ]
}

Successful Response

Get Jetton Wallets

Returns Jetton wallets by specified filters.

get

/api/v3/jetton/wallets

Authorizations

Query parameters

addressAddress

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

owner_addressOwner Address

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

jetton_addressJetton Address

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

limitLimit

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

offsetOffset

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/jetton/wallets' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "jetton_wallets": [
    {
      "address": "text",
      "balance": "text",
      "owner": "text",
      "jetton": "text",
      "last_transaction_lt": "text",
      "code_hash": "text",
      "data_hash": "text"
    }
  ]
}

Successful Response

Get Jetton Transfers

Returns Jetton transfers by specified filters.

get

/api/v3/jetton/transfers

Authorizations

Query parameters

addressAddress

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

jetton_walletJetton Wallet

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

jetton_masterJetton Master

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

directionDirection

Direction transactions by lt.

Options: in, out, both

start_utimeStart Utime

Query transactions with generation UTC timestamp after given timestamp.

end_utimeEnd Utime

Query transactions with generation UTC timestamp before given timestamp

start_ltStart Lt

Query transactions with lt >= start_lt

end_ltEnd Lt

Query transactions with lt <= end_lt

limitLimit

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

offsetOffset

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

sortSort

Sort transactions by lt.

Options: none, asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/jetton/transfers' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "jetton_transfers": [
    {
      "query_id": "text",
      "amount": "text",
      "source_wallet": "text",
      "jetton_master": "text",
      "transaction_hash": "text",
      "transaction_lt": "text",
      "transaction_now": 1,
      "source": "text",
      "destination": "text",
      "response_destination": "text",
      "custom_payload": "text",
      "forward_ton_amount": "text",
      "forward_payload": "text"
    }
  ]
}

Successful Response

Get Jetton Burns

Returns Jetton burns by specified filters.

get

/api/v3/jetton/burns

Authorizations

Query parameters

addressAddress

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

jetton_walletJetton Wallet

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

jetton_masterJetton Master

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

start_utimeStart Utime

Query transactions with generation UTC timestamp after given timestamp.

end_utimeEnd Utime

Query transactions with generation UTC timestamp before given timestamp

start_ltStart Lt

Query transactions with lt >= start_lt

end_ltEnd Lt

Query transactions with lt <= end_lt

limitLimit

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

offsetOffset

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

sortSort

Sort transactions by lt.

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/jetton/burns' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "jetton_burns": [
    {
      "query_id": "text",
      "owner": "text",
      "jetton_wallet": "text",
      "jetton_master": "text",
      "transaction_hash": "text",
      "transaction_lt": "text",
      "transaction_now": 1,
      "amount": "text",
      "response_destination": "text",
      "custom_payload": "text"
    }
  ]
}

Successful Response

Send Message

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.

post

/api/v3/message

Authorizations

Body

bocBocrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v3/message' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"boc":"te6ccgECBQEAARUAAkWIAWTtae+KgtbrX26Bep8JSq8lFLfGOoyGR/xwdjfvpvEaHg"}'

200

422

{
  "message_hash": "383E348617141E35BC25ED9CD0EDEC2A4EAF6413948BF1FB7F865CEFE8C2CD44"
}

Successful Response

Run 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
    }
]

post

/api/v3/runGetMethod

Authorizations

Body

addressAddressrequired

Contract address in any format

methodMethodrequired

Method name to run

stackStackrequired

stack arguments

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v3/runGetMethod' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"address":"EQBSzBN6cnxDwDjn_IQXqgU8OJXUMcol9pxyL-yLkpKzYs9U","method":"seqno","stack":[{"type":"num","value":"0x12a"}]}'

200

422

{
  "gas_used": 1,
  "exit_code": 1,
  "stack": [
    {
      "type": "cell",
      "value": [
        {
          "type": "cell",
          "value": "[Circular Reference]"
        }
      ]
    }
  ]
}

Successful Response

Get Account Information

Get smart contract information.

get

/api/v3/account

Authorizations

Query parameters

addressAddressrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/account?address=text' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "balance": "text",
  "status": "uninit",
  "code": "text",
  "data": "text",
  "last_transaction_lt": "text",
  "last_transaction_hash": "text",
  "frozen_hash": "text"
}

Successful Response

Estimate Fee

Estimate fees required for query processing.

Body, init_code and init_data accepted in base64 encoded format.

post

/api/v3/estimateFee

Authorizations

Body

addressAddressrequired

bodyBodyrequired

ignore_chksigIgnore Chksig

init_codeInit Code

init_dataInit Data

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v3/estimateFee' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"address":"text","body":"text","ignore_chksig":true}'

200

422

{
  "source_fees": {
    "in_fwd_fee": 1,
    "storage_fee": 1,
    "gas_fee": 1,
    "fwd_fee": 1
  },
  "destination_fees": [
    {
      "in_fwd_fee": 1,
      "storage_fee": 1,
      "gas_fee": 1,
      "fwd_fee": 1
    }
  ]
}

Successful Response

Get 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.

get

/api/v3/wallet

Authorizations

Query parameters

addressAddressrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v3/wallet?address=text' \
  --header 'X-API-Key: YOUR_API_KEY'

200

422

{
  "balance": "text",
  "status": "uninit",
  "wallet_type": "text",
  "seqno": 1,
  "wallet_id": 1,
  "last_transaction_lt": "text",
  "last_transaction_hash": "text"
}

Successful Response