索引器 API

入门

TON 索引器API 提供了一种从 TON 网络访问索引区块链数据的强大方法。通过将区块链数据存储在 PostgreSQL 中，此 API 可以高效查询和检索历史信息。

Get Masterchain Info

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

GET/api/v3/masterchainInfo

Authorization

Response

Successful Response

Body

last*Block

first*Block

Request

const response = await fetch('/api/v3/masterchainInfo', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "last": {
    "shard": "text",
    "root_hash": "text",
    "file_hash": "text",
    "after_merge": false,
    "before_split": false,
    "after_split": false,
    "want_merge": false,
    "want_split": false,
    "key_block": false,
    "vert_seqno_incr": false,
    "gen_utime": "text",
    "start_lt": "text",
    "end_lt": "text",
    "rand_seed": "text",
    "created_by": "text",
    "masterchain_block_ref": {
      "shard": "text"
    },
    "prev_blocks": [
      {
        "shard": "text"
      }
    ]
  },
  "first": {
    "shard": "text",
    "root_hash": "text",
    "file_hash": "text",
    "after_merge": false,
    "before_split": false,
    "after_split": false,
    "want_merge": false,
    "want_split": false,
    "key_block": false,
    "vert_seqno_incr": false,
    "gen_utime": "text",
    "start_lt": "text",
    "end_lt": "text",
    "rand_seed": "text",
    "created_by": "text",
    "masterchain_block_ref": {
      "shard": "text"
    },
    "prev_blocks": [
      {
        "shard": "text"
      }
    ]
  }
}

Get Blocks

Returns blocks by specified filters.

GET/api/v3/blocks

Authorization

Query parameters

Response

Successful Response

Body

blocks*Blocks

Request

const response = await fetch('/api/v3/blocks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "blocks": [
    {
      "shard": "text",
      "root_hash": "text",
      "file_hash": "text",
      "after_merge": false,
      "before_split": false,
      "after_split": false,
      "want_merge": false,
      "want_split": false,
      "key_block": false,
      "vert_seqno_incr": false,
      "gen_utime": "text",
      "start_lt": "text",
      "end_lt": "text",
      "rand_seed": "text",
      "created_by": "text",
      "masterchain_block_ref": {
        "shard": "text"
      },
      "prev_blocks": [
        {
          "shard": "text"
        }
      ]
    }
  ]
}

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

Authorization

Query parameters

Response

Successful Response

Body

blocks*Blocks

Request

const response = await fetch('/api/v3/masterchainBlockShardState', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "blocks": [
    {
      "shard": "text",
      "root_hash": "text",
      "file_hash": "text",
      "after_merge": false,
      "before_split": false,
      "after_split": false,
      "want_merge": false,
      "want_split": false,
      "key_block": false,
      "vert_seqno_incr": false,
      "gen_utime": "text",
      "start_lt": "text",
      "end_lt": "text",
      "rand_seed": "text",
      "created_by": "text",
      "masterchain_block_ref": {
        "shard": "text"
      },
      "prev_blocks": [
        {
          "shard": "text"
        }
      ]
    }
  ]
}

Get Address Book

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

GET/api/v3/addressBook

Authorization

Query parameters

Response

Successful Response

Body

Other propertiesAddressBookEntry

Request

const response = await fetch('/api/v3/addressBook', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

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

Authorization

Query parameters

Response

Successful Response

Body

blocks*Blocks

Request

const response = await fetch('/api/v3/masterchainBlockShards', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "blocks": [
    {
      "shard": "text",
      "root_hash": "text",
      "file_hash": "text",
      "after_merge": false,
      "before_split": false,
      "after_split": false,
      "want_merge": false,
      "want_split": false,
      "key_block": false,
      "vert_seqno_incr": false,
      "gen_utime": "text",
      "start_lt": "text",
      "end_lt": "text",
      "rand_seed": "text",
      "created_by": "text",
      "masterchain_block_ref": {
        "shard": "text"
      },
      "prev_blocks": [
        {
          "shard": "text"
        }
      ]
    }
  ]
}

Get Transactions

Returns transactions by specified filters.

GET/api/v3/transactions

Authorization

Query parameters

Response

Successful Response

Body

transactions*Transactions

address_book*Address Book

Request

const response = await fetch('/api/v3/transactions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "block_ref": {
        "shard": "text"
      },
      "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": false,
        "bounce": false,
        "bounced": false,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "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": false,
          "bounce": false,
          "bounced": false,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "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"
      }
    }
  ]
}

Get Transactions By Masterchain Block

Returns transactions from masterchain block and from all shards.

GET/api/v3/transactionsByMasterchainBlock

Authorization

Query parameters

Response

Successful Response

Body

transactions*Transactions

address_book*Address Book

Request

const response = await fetch('/api/v3/transactionsByMasterchainBlock', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "block_ref": {
        "shard": "text"
      },
      "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": false,
        "bounce": false,
        "bounced": false,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "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": false,
          "bounce": false,
          "bounced": false,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "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"
      }
    }
  ]
}

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

Authorization

Query parameters

Response

Successful Response

Body

transactions*Transactions

address_book*Address Book

Request

const response = await fetch('/api/v3/transactionsByMessage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "block_ref": {
        "shard": "text"
      },
      "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": false,
        "bounce": false,
        "bounced": false,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "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": false,
          "bounce": false,
          "bounced": false,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "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"
      }
    }
  ]
}

Get Adjacent Transactions

Returns parent and/or children for specified transaction.

GET/api/v3/adjacentTransactions

Authorization

Query parameters

Response

Successful Response

Body

transactions*Transactions

address_book*Address Book

Request

const response = await fetch('/api/v3/adjacentTransactions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "block_ref": {
        "shard": "text"
      },
      "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": false,
        "bounce": false,
        "bounced": false,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "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": false,
          "bounce": false,
          "bounced": false,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "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"
      }
    }
  ]
}

Get Messages

Returns messages by specified filters.

GET/api/v3/messages

Authorization

Query parameters

Response

Successful Response

Body

messages*Messages

Request

const response = await fetch('/api/v3/messages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": false,
      "bounce": false,
      "bounced": false,
      "import_fee": "text",
      "message_content": {
        "hash": "text",
        "body": "text",
        "decoded": {
          "comment": "text"
        }
      },
      "init_state": {
        "hash": "text",
        "body": "text"
      }
    }
  ]
}

Get Nft Collections

Returns NFT collections.

GET/api/v3/nft/collections

Authorization

Query parameters

Response

Successful Response

Body

nft_collections*Nft Collections

Request

const response = await fetch('/api/v3/nft/collections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get Nft Items

Returns NFT items.

GET/api/v3/nft/items

Authorization

Query parameters

Response

Successful Response

Body

nft_items*Nft Items

Request

const response = await fetch('/api/v3/nft/items', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "nft_items": [
    {
      "address": "text",
      "collection_address": "text",
      "owner_address": "text",
      "init": false,
      "index": "text",
      "last_transaction_lt": "text",
      "code_hash": "text",
      "data_hash": "text",
      "collection": {
        "address": "text",
        "owner_address": "text",
        "last_transaction_lt": "text",
        "next_item_index": "text",
        "code_hash": "text",
        "data_hash": "text"
      }
    }
  ]
}

Get Nft Transfers

Returns NFT transfers by specified filters.

GET/api/v3/nft/transfers

Authorization

Query parameters

Response

Successful Response

Body

nft_transfers*Nft Transfers

Request

const response = await fetch('/api/v3/nft/transfers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get Jetton Masters

Returns Jetton masters by specified filters.

GET/api/v3/jetton/masters

Authorization

Query parameters

Response

Successful Response

Body

jetton_masters*Jetton Masters

Request

const response = await fetch('/api/v3/jetton/masters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get Jetton Wallets

Returns Jetton wallets by specified filters.

GET/api/v3/jetton/wallets

Authorization

Query parameters

Response

Successful Response

Body

jetton_wallets*Jetton Wallets

Request

const response = await fetch('/api/v3/jetton/wallets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get Jetton Transfers

Returns Jetton transfers by specified filters.

GET/api/v3/jetton/transfers

Authorization

Query parameters

Response

Successful Response

Body

jetton_transfers*Jetton Transfers

Request

const response = await fetch('/api/v3/jetton/transfers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get Jetton Burns

Returns Jetton burns by specified filters.

GET/api/v3/jetton/burns

Authorization

Query parameters

Response

Successful Response

Body

jetton_burns*Jetton Burns

Request

const response = await fetch('/api/v3/jetton/burns', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

Authorization

Body

boc*Boc

Response

Successful Response

Body

message_hash*Message Hash

Hash of sent message in hex format

Request

const response = await fetch('/api/v3/message', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "boc": "text"
    }),
});
const data = await response.json();

Response

{
  "message_hash": "text"
}

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

Authorization

Body

address*Address

Contract address in any format

method*Method

Method name to run

stack*Stack

stack arguments

Response

Successful Response

Body

gas_used*Gas Used

exit_code*Exit Code

stack*Stack

Request

const response = await fetch('/api/v3/runGetMethod', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "text",
      "method": "text",
      "stack": [
        {
          "type": "cell",
          "value": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "stack": [
    {
      "type": "cell",
      "value": []
    }
  ]
}

Estimate Fee

Estimate fees required for query processing.

Body, init_code and init_data accepted in base64 encoded format.

POST/api/v3/estimateFee

Authorization

Body

address*Address

body*Body

init_codeInit Code

init_dataInit Data

ignore_chksigIgnore Chksig

Response

Successful Response

Body

source_fees*Fee

destination_fees*Destination Fees

Request

const response = await fetch('/api/v3/estimateFee', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "text",
      "body": "text"
    }),
});
const data = await response.json();

Response

{
  "source_fees": {},
  "destination_fees": [
    {}
  ]
}

Get Account Information

Get smart contract information.

GET/api/v3/account

Authorization

Query parameters

Response

Successful Response

Body

balance*Balance

code*Code

data*Data

last_transaction_lt*Last Transaction Lt

last_transaction_hash*Last Transaction Hash

frozen_hash*Frozen Hash

status*AccountStatus

uninitfrozenactivenonexist

Request

const response = await fetch('/api/v3/account', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

Authorization

Query parameters

Response

Successful Response

Body

balance*Balance

wallet_type*Wallet Type

seqno*Seqno

wallet_id*Wallet Id

last_transaction_lt*Last Transaction Lt

last_transaction_hash*Last Transaction Hash

status*AccountStatus

uninitfrozenactivenonexist

Request

const response = await fetch('/api/v3/wallet', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

PreviousHTTP API NextBitcoin

Last updated 2 days ago