ChainUp Cloud
中文
中文
  • 👋欢迎来到 ChainUp Cloud
  • INTRODUCTION
    • 🔎Chainup Cloud API 快速入门
    • 🕹️ChainUp Cloud 产品
      • ⛓️区块链 API
      • ⚙️全节点服务
      • ⚒️专用节点
      • 👥白标验证器
      • ⛲质押
      • 🍧HashKing 聚合器
      • 💌ChainNova
    • 👷对于开发人员
      • ⛓️使用区块链 API
      • ⚒️部署专用节点
      • ☁️通过 IPFS API 使用分布式存储
    • 👾对于投资者
      • ⛲如何质押以太坊ETH?
      • 👥运行你自己的验证器
  • ChainUpCloud 开放 API
    • 质押奖励 API
      • 验证器每日奖励
      • 验证者总奖励
      • 云验证者结算 EL 奖励
    • ETH 质押 API
      • 广播质押交易
      • 创建验证器
      • 获取验证者
      • 通过 Pubkeys 退出验证器
    • 错误代码
  • 🏷️NFT API
    • 传输 API
    • NFT 元数据访问
    • 所有权和代币门控
  • 区块链 API
    • 📚概述
      • 为您的项目创建区块链 API
      • 仪表板统计信息
    • 💎以太坊
      • JSON-RPC 方法
      • WebSocket 流
    • TON
      • HTTP API
      • 索引器 API
    • 🪙Bitcoin
      • JSON-RPC 方法
    • 📂Filecoin
      • JSON-RPC 方法
      • 公共 API
    • 🍡Polkadot
      • JSON-RPC 方法
      • WebSocket 流
    • ⚪Litecoin
      • JSON-RPC methods
    • 🚃Near
      • JSON-RPC methods
    • 💎Ethereum Beacon
      • JSON-RPC methods
    • ⛽Polygon (Matic)
      • JSON-RPC methods
      • WebSocket stream
    • 💠Binance Smart Chain - BSC
      • HTTP Rest methods
      • WebSocket stream
    • 🚔BNB
      • JSON-RPC methods
      • WebSocket stream
    • 🌞Tron
      • JSON-RPC methods
    • 🪨Ethereum Classic - ETC
      • JSON-RPC methods
    • 🥀Bitcoin Cash - BCH
      • JSON-RPC methods
    • 🦃Kusama
      • JSON-RPC methods
      • WebSocket stream
    • 🍆EOS
      • JSON-RPC methods
    • 👻Fantom
      • JSON-RPC methods
    • 〰️Aptos
      • HTTP Methods
    • 🌤️Heco
      • JSON-RPC methods
    • 🏔️Avalanche
      • JSON-RPC methods
    • 🔑Cosmos
      • HTTP Methods
    • 📚Omni
      • JSON-RPC methods
    • ☸️Arbitrum
      • JSON-RPC methods
    • 💯Dogecoin
      • JSON-RPC methods
    • 🎷Optimism
      • JSON-RPC methods
    • 🏺Dash
      • JSON-RPC methods
    • 🌄Zcash
      • JSON-RPC methods
    • 💣XRP
      • JSON-RPC methods
    • 🛞Base
      • JSON-RPC methods
    • Scroll
      • JSON-RPC methods
    • 🧫Qtum
      • JSON-RPC methods
    • ⚖️Solana
      • JSON-RPC methods
      • Solana 节点常见问题解答 FAQ
      • Websocket Stream
  • Staking
    • 📘概述
    • 💎以太坊质押
      • ⛲如何质押以太坊?
      • 📙如何生成存款数据?
    • 📏使用 SSV 在以太坊上质押
    • 🖌️注册 SSV 操作员
    • 🖌️如何委托给 SSV 集群?
    • 在 Cosmos 上质押
    • 🍆在 EOS 上质押
    • 📂在 FIL 上质押
    • 🕶️在 ZILLIQA 上质押
  • Validator Node
    • 📗概述
    • 💎以太坊
      • 运行验证者节点
      • 如何创建验证器密钥?
  • RESOURCES
    • 📕FAQ 常见问题解答介绍
      • ⛓️区块链 API
      • ⚒️专用节点
    • 🗳️支持
    • API 参考
Powered by GitBook
On this page

Was this helpful?

  1. 区块链 API
  2. TON

索引器 API

PreviousHTTP APINextBitcoin

Last updated 8 months ago

Was this helpful?

入门

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

Get Masterchain Info

get

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

Authorizations
Responses
200
Successful Response
application/json
404
Not Found
application/json
get
GET /api/v3/masterchainInfo HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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.

integerOptional
or
nullOptional
shardany ofOptional

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

stringOptional
or
nullOptional
seqnoany ofOptional

Block seqno. Must be sent with workchain and shard.

integerOptional
or
nullOptional
start_utimeany ofOptional

Query blocks with generation UTC timestamp after given timestamp.

integerOptional
or
nullOptional
end_utimeany ofOptional

Query blocks with generation UTC timestamp before given timestamp

integerOptional
or
nullOptional
start_ltany ofOptional

Query blocks with lt >= start_lt

integerOptional
or
nullOptional
end_ltany ofOptional

Query blocks with lt <= end_lt

integerOptional
or
nullOptional
limitinteger · min: 1 · max: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
sortstring · enumOptional

Sort results by UTC timestamp.

Default: descPossible values:
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/blocks HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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
200
Successful Response
application/json
404
Not Found
application/json
422
Validation Error
application/json
get
GET /api/v3/masterchainBlockShardState?seqno=1 HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/addressBook?address=text HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/masterchainBlockShards?seqno=1 HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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.

integerOptional
or
nullOptional
shardany ofOptional

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

stringOptional
or
nullOptional
seqnoany ofOptional

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

integerOptional
or
nullOptional
accountstring[]Optional

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

exclude_accountstring[]Optional

Exclude transactions on specified account addresses

hashany ofOptional

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

stringOptional
or
nullOptional
ltany ofOptional

Transaction lt.

integerOptional
or
nullOptional
start_utimeany ofOptional

Query transactions with generation UTC timestamp after given timestamp.

integerOptional
or
nullOptional
end_utimeany ofOptional

Query transactions with generation UTC timestamp before given timestamp

integerOptional
or
nullOptional
start_ltany ofOptional

Query transactions with lt >= start_lt

integerOptional
or
nullOptional
end_ltany ofOptional

Query transactions with lt <= end_lt

integerOptional
or
nullOptional
limitinteger · min: 1 · max: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/transactions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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": "text_comment",
            "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": "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"
    }
  }
}

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: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/transactionsByMasterchainBlock?seqno=1 HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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": "text_comment",
            "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": "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"
    }
  }
}

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.

Possible values:
stringOptional
or
nullOptional
msg_hashany ofRequired

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

stringOptional
or
nullOptional
limitinteger · min: 1 · max: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/transactionsByMessage?direction=in&msg_hash=text HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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": "text_comment",
            "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": "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"
    }
  }
}

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 ofOptional

Direction transactions by lt.

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

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

Default: 128
offsetintegerOptional

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

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/adjacentTransactions?hash=text HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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": "text_comment",
            "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": "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"
    }
  }
}

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.

stringOptional
or
nullOptional
destinationany ofOptional

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

stringOptional
or
nullOptional
body_hashany ofOptional

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

stringOptional
or
nullOptional
limitinteger · min: 1 · max: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/messages HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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"
      }
    }
  ]
}

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.

stringOptional
or
nullOptional
owner_addressany ofOptional

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

stringOptional
or
nullOptional
limitinteger · min: 1 · max: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/nft/collections HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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.

stringOptional
or
nullOptional
owner_addressany ofOptional

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

stringOptional
or
nullOptional
collection_addressany ofOptional

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

stringOptional
or
nullOptional
indexany ofOptional

NFT Item index. Use it together with collection address.

stringOptional
or
nullOptional
limitinteger · min: 1 · max: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/nft/items HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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.

stringOptional
or
nullOptional
item_addressany ofOptional

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

stringOptional
or
nullOptional
collection_addressany ofOptional

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

stringOptional
or
nullOptional
directionany ofOptional

Direction transactions by lt.

Default: bothPossible values:
stringOptional
or
nullOptional
start_utimeany ofOptional

Query transactions with generation UTC timestamp after given timestamp.

integerOptional
or
nullOptional
end_utimeany ofOptional

Query transactions with generation UTC timestamp before given timestamp

integerOptional
or
nullOptional
start_ltany ofOptional

Query transactions with lt >= start_lt

integerOptional
or
nullOptional
end_ltany ofOptional

Query transactions with lt <= end_lt

integerOptional
or
nullOptional
limitinteger · min: 1 · max: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/nft/transfers HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/jetton/masters HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/jetton/wallets HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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.

stringOptional
or
nullOptional
jetton_walletany ofOptional

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

stringOptional
or
nullOptional
jetton_masterany ofOptional

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

stringOptional
or
nullOptional
directionany ofOptional

Direction transactions by lt.

Default: bothPossible values:
stringOptional
or
nullOptional
start_utimeany ofOptional

Query transactions with generation UTC timestamp after given timestamp.

integerOptional
or
nullOptional
end_utimeany ofOptional

Query transactions with generation UTC timestamp before given timestamp

integerOptional
or
nullOptional
start_ltany ofOptional

Query transactions with lt >= start_lt

integerOptional
or
nullOptional
end_ltany ofOptional

Query transactions with lt <= end_lt

integerOptional
or
nullOptional
limitinteger · min: 1 · max: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/jetton/transfers HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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.

stringOptional
or
nullOptional
jetton_walletany ofOptional

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

stringOptional
or
nullOptional
jetton_masterany ofOptional

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

stringOptional
or
nullOptional
start_utimeany ofOptional

Query transactions with generation UTC timestamp after given timestamp.

integerOptional
or
nullOptional
end_utimeany ofOptional

Query transactions with generation UTC timestamp before given timestamp

integerOptional
or
nullOptional
start_ltany ofOptional

Query transactions with lt >= start_lt

integerOptional
or
nullOptional
end_ltany ofOptional

Query transactions with lt <= end_lt

integerOptional
or
nullOptional
limitinteger · min: 1 · max: 256Optional

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

Default: 128
offsetintegerOptional

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

Default: 0
sortstring · enumOptional

Sort transactions by lt.

Default: descPossible values:
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/jetton/burns HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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"
    }
  ]
}

Get Account Information

get

Get smart contract information.

Authorizations
Query parameters
addressstringRequired

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

Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/account?address=text HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "balance": "text",
  "code": "text",
  "data": "text",
  "last_transaction_lt": "text",
  "last_transaction_hash": "text",
  "frozen_hash": "text",
  "status": "uninit"
}

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
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /api/v3/wallet?address=text HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "balance": "text",
  "wallet_type": "text",
  "seqno": 1,
  "wallet_id": 1,
  "last_transaction_lt": "text",
  "last_transaction_hash": "text",
  "status": "uninit"
}
  • 入门
  • GETGet Masterchain Info
  • GETGet Blocks
  • GETGet Shards By Masterchain Block
  • GETGet Address Book
  • GETGet Masterchain Block Shards
  • GETGet Transactions
  • GETGet Transactions By Masterchain Block
  • GETGet Transactions By Message
  • GETGet Adjacent Transactions
  • GETGet Messages
  • GETGet Nft Collections
  • GETGet Nft Items
  • GETGet Nft Transfers
  • GETGet Jetton Masters
  • GETGet Jetton Wallets
  • GETGet Jetton Transfers
  • GETGet Jetton Burns
  • POSTSend Message
  • POSTRun Get Method
  • POSTEstimate Fee
  • GETGet Account Information
  • GETGet Wallet Information

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.

Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /api/v3/message HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "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
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /api/v3/runGetMethod HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "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]"
        }
      ]
    }
  ]
}

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
200
Successful Response
application/json
422
Validation Error
application/json
post
POST /api/v3/estimateFee HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "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
    }
  ]
}