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
Responses
curl -L \
  --url '/api/v3/masterchainInfo' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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,
    "master_ref_seqno": 1,
    "rand_seed": "text",
    "created_by": "text",
    "tx_count": 1,
    "masterchain_block_ref": {
      "workchain": 1,
      "shard": "text",
      "seqno": 1
    },
    "prev_blocks": [
      {
        "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,
    "master_ref_seqno": 1,
    "rand_seed": "text",
    "created_by": "text",
    "tx_count": 1,
    "masterchain_block_ref": {
      "workchain": 1,
      "shard": "text",
      "seqno": 1
    },
    "prev_blocks": [
      {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      }
    ]
  }
}

Get Blocks

get

Returns blocks by specified filters.

Authorizations
Query parameters
workchainany ofoptional

Block workchain.

shardany ofoptional

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

seqnoany ofoptional

Block seqno. Must be sent with workchain and shard.

start_utimeany ofoptional

Query blocks with generation UTC timestamp after given timestamp.

end_utimeany ofoptional

Query blocks with generation UTC timestamp before given timestamp

start_ltany ofoptional

Query blocks with lt >= start_lt

end_ltany ofoptional

Query blocks with lt <= end_lt

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

sortstring Β· enum Β· default: "desc"optional

Sort results by UTC timestamp.

Available options:
Responses
curl -L \
  --url '/api/v3/blocks' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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,
      "master_ref_seqno": 1,
      "rand_seed": "text",
      "created_by": "text",
      "tx_count": 1,
      "masterchain_block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      },
      "prev_blocks": [
        {
          "workchain": 1,
          "shard": "text",
          "seqno": 1
        }
      ]
    }
  ]
}

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
Query parameters
seqnointegerrequired

Masterchain block seqno

Responses
curl -L \
  --url '/api/v3/masterchainBlockShardState?seqno=1' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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,
      "master_ref_seqno": 1,
      "rand_seed": "text",
      "created_by": "text",
      "tx_count": 1,
      "masterchain_block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      },
      "prev_blocks": [
        {
          "workchain": 1,
          "shard": "text",
          "seqno": 1
        }
      ]
    }
  ]
}

Get Address Book

get

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

Authorizations
Query parameters
addressstring[]required

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

Responses
curl -L \
  --url '/api/v3/addressBook?address=text' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "ANY_ADDITIONAL_PROPERTY": {
    "user_friendly": "text"
  }
}

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
Query parameters
seqnointegerrequired

Masterchain block seqno

Responses
curl -L \
  --url '/api/v3/masterchainBlockShards?seqno=1' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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,
      "master_ref_seqno": 1,
      "rand_seed": "text",
      "created_by": "text",
      "tx_count": 1,
      "masterchain_block_ref": {
        "workchain": 1,
        "shard": "text",
        "seqno": 1
      },
      "prev_blocks": [
        {
          "workchain": 1,
          "shard": "text",
          "seqno": 1
        }
      ]
    }
  ]
}

Get Transactions

get

Returns transactions by specified filters.

Authorizations
Query parameters
workchainany ofoptional

Block workchain.

shardany ofoptional

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

seqnoany ofoptional

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

hashany ofoptional

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

ltany ofoptional

Transaction lt.

start_utimeany ofoptional

Query transactions with generation UTC timestamp after given timestamp.

end_utimeany ofoptional

Query transactions with generation UTC timestamp before given timestamp

start_ltany ofoptional

Query transactions with lt >= start_lt

end_ltany ofoptional

Query transactions with lt <= end_lt

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

sortstring Β· enum Β· default: "desc"optional

Sort transactions by lt.

Available options:
Responses
curl -L \
  --url '/api/v3/transactions' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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,
      "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": null,
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "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": null,
              "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"
    }
  }
}

Get Transactions By Masterchain Block

get

Returns transactions from masterchain block and from all shards.

Authorizations
Query parameters
seqnointegerrequired

Masterchain block seqno

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

sortstring Β· enum Β· default: "desc"optional

Sort transactions by lt.

Available options:
Responses
curl -L \
  --url '/api/v3/transactionsByMasterchainBlock?seqno=1' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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,
      "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": null,
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "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": null,
              "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"
    }
  }
}

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
Query parameters
directionany ofrequired

Message direction.

Available options:

msg_hashany ofrequired

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

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

Responses
curl -L \
  --url '/api/v3/transactionsByMessage?direction=in&msg_hash=text' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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,
      "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": null,
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "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": null,
              "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"
    }
  }
}

Get Adjacent Transactions

get

Returns parent and/or children for specified transaction.

Authorizations
Query parameters
hashstringrequired

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

directionany of Β· default: "both"optional

Direction transactions by lt.

Available options:

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

sortstring Β· enum Β· default: "desc"optional

Sort transactions by lt.

Available options:
Responses
curl -L \
  --url '/api/v3/adjacentTransactions?hash=text' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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,
      "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": null,
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "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": null,
              "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"
    }
  }
}

Get Messages

get

Returns messages by specified filters.

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

destinationany ofoptional

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

body_hashany ofoptional

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

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

Responses
curl -L \
  --url '/api/v3/messages' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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": null,
          "comment": "text"
        }
      },
      "init_state": {
        "hash": "text",
        "body": "text"
      }
    }
  ]
}

Get Nft Collections

get

Returns NFT collections.

Authorizations
Query parameters
collection_addressany ofoptional

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

owner_addressany ofoptional

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

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

Responses
curl -L \
  --url '/api/v3/nft/collections' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "nft_collections": [
    {
      "address": "text",
      "owner_address": "text",
      "last_transaction_lt": "text",
      "next_item_index": "text",
      "collection_content": null,
      "code_hash": "text",
      "data_hash": "text"
    }
  ]
}

Get Nft Items

get

Returns NFT items.

Authorizations
Query parameters
addressany ofoptional

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

owner_addressany ofoptional

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

collection_addressany ofoptional

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

indexany ofoptional

NFT Item index. Use it together with collection address.

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

Responses
curl -L \
  --url '/api/v3/nft/items' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "nft_items": [
    {
      "address": "text",
      "collection_address": "text",
      "owner_address": "text",
      "init": true,
      "index": "text",
      "last_transaction_lt": "text",
      "code_hash": "text",
      "data_hash": "text",
      "content": null,
      "collection": {
        "address": "text",
        "owner_address": "text",
        "last_transaction_lt": "text",
        "next_item_index": "text",
        "collection_content": null,
        "code_hash": "text",
        "data_hash": "text"
      }
    }
  ]
}

Get Nft Transfers

get

Returns NFT transfers by specified filters.

Authorizations
Query parameters
addressany ofoptional

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

item_addressany ofoptional

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

collection_addressany ofoptional

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

directionany of Β· default: "both"optional

Direction transactions by lt.

Available options:

start_utimeany ofoptional

Query transactions with generation UTC timestamp after given timestamp.

end_utimeany ofoptional

Query transactions with generation UTC timestamp before given timestamp

start_ltany ofoptional

Query transactions with lt >= start_lt

end_ltany ofoptional

Query transactions with lt <= end_lt

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

sortstring Β· enum Β· default: "desc"optional

Sort transactions by lt.

Available options:
Responses
curl -L \
  --url '/api/v3/nft/transfers' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "nft_transfers": [
    {
      "query_id": "text",
      "nft_address": "text",
      "transaction_hash": "text",
      "transaction_lt": "text",
      "transaction_now": 1,
      "old_owner": "text",
      "new_owner": "text",
      "response_destination": "text",
      "custom_payload": "text",
      "forward_amount": "text",
      "forward_payload": "text"
    }
  ]
}

Get Jetton Masters

get

Returns Jetton masters by specified filters.

Authorizations
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: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

Responses
curl -L \
  --url '/api/v3/jetton/masters' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "jetton_masters": [
    {
      "address": "text",
      "total_supply": "text",
      "mintable": true,
      "admin_address": "text",
      "last_transaction_lt": "text",
      "jetton_wallet_code_hash": "text",
      "jetton_content": null,
      "code_hash": "text",
      "data_hash": "text"
    }
  ]
}

Get Jetton Wallets

get

Returns Jetton wallets by specified filters.

Authorizations
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: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

Responses
curl -L \
  --url '/api/v3/jetton/wallets' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "jetton_wallets": [
    {
      "address": "text",
      "balance": "text",
      "owner": "text",
      "jetton": "text",
      "last_transaction_lt": "text",
      "code_hash": "text",
      "data_hash": "text"
    }
  ]
}

Get Jetton Transfers

get

Returns Jetton transfers by specified filters.

Authorizations
Query parameters
addressany ofoptional

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

jetton_walletany ofoptional

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

jetton_masterany ofoptional

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

directionany of Β· default: "both"optional

Direction transactions by lt.

Available options:

start_utimeany ofoptional

Query transactions with generation UTC timestamp after given timestamp.

end_utimeany ofoptional

Query transactions with generation UTC timestamp before given timestamp

start_ltany ofoptional

Query transactions with lt >= start_lt

end_ltany ofoptional

Query transactions with lt <= end_lt

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

sortstring Β· enum Β· default: "desc"optional

Sort transactions by lt.

Available options:
Responses
curl -L \
  --url '/api/v3/jetton/transfers' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "jetton_transfers": [
    {
      "query_id": "text",
      "source": "text",
      "destination": "text",
      "amount": "text",
      "source_wallet": "text",
      "jetton_master": "text",
      "transaction_hash": "text",
      "transaction_lt": "text",
      "transaction_now": 1,
      "response_destination": "text",
      "custom_payload": "text",
      "forward_ton_amount": "text",
      "forward_payload": "text"
    }
  ]
}

Get Jetton Burns

get

Returns Jetton burns by specified filters.

Authorizations
Query parameters
addressany ofoptional

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

jetton_walletany ofoptional

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

jetton_masterany ofoptional

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

start_utimeany ofoptional

Query transactions with generation UTC timestamp after given timestamp.

end_utimeany ofoptional

Query transactions with generation UTC timestamp before given timestamp

start_ltany ofoptional

Query transactions with lt >= start_lt

end_ltany ofoptional

Query transactions with lt <= end_lt

limitinteger Β· min: 1 Β· max: 256 Β· default: 128optional

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

offsetinteger Β· default: 0optional

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

sortstring Β· enum Β· default: "desc"optional

Sort transactions by lt.

Available options:
Responses
curl -L \
  --url '/api/v3/jetton/burns' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "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"
    }
  ]
}

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
Body
all ofoptional

Message in boc base64 format.

Message in base64 boc serialized format.

Responses
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"
  }'
{
  "message_hash": "383E348617141E35BC25ED9CD0EDEC2A4EAF6413948BF1FB7F865CEFE8C2CD44"
}

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
Body
all ofoptional

RunGetMethod request body

Responses
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"
      }
    ]
  }'
{
  "gas_used": 1,
  "exit_code": 1,
  "stack": [
    {
      "type": "cell",
      "value": [
        {
          "type": "cell",
          "value": "[Circular Reference]"
        }
      ]
    }
  ]
}

Get Account Information

get

Get smart contract information.

Authorizations
Query parameters
addressstringrequired

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

Responses
curl -L \
  --url '/api/v3/account?address=text' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "balance": "text",
  "code": "text",
  "data": "text",
  "last_transaction_lt": "text",
  "last_transaction_hash": "text",
  "frozen_hash": "text",
  "status": "uninit"
}

Estimate Fee

post

Estimate fees required for query processing.

Body, init_code and init_data accepted in base64 encoded format.

Authorizations
Body
all ofoptional

EstimateFee request body

Responses
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",
    "init_code": "text",
    "init_data": "text",
    "ignore_chksig": true
  }'
{
  "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
    }
  ]
}

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
Query parameters
addressstringrequired

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

Responses
curl -L \
  --url '/api/v3/wallet?address=text' \
  --header 'X-API-Key: YOUR_API_KEY'
{
  "balance": "text",
  "wallet_type": "text",
  "seqno": 1,
  "wallet_id": 1,
  "last_transaction_lt": "text",
  "last_transaction_hash": "text",
  "status": "uninit"
}

Last updated

Was this helpful?