REST API endpoints supported on The Open Network Mainnet and The Open Network Testnet through Tatum RPC Gateway, with base URLs and an example request.
Call The Open Network REST endpoints through Tatum RPC Gateway. Append the endpoint path to the network's base URL and send your API key in the x-api-key header. See Authentication.
The Open Network has 2 REST API interfaces, each with its own base URLs and endpoints: V3 - Indexer and V2 - TON HTTP API.
V3 - Indexer
Base URLs
| Network | Base URL |
|---|---|
| The Open Network Mainnet | https://ton-mainnet.gateway.tatum.io/api/v3 |
| The Open Network Testnet | https://ton-testnet.gateway.tatum.io/api/v3 |
Example request
curl 'https://ton-mainnet.gateway.tatum.io/api/v3/masterchainInfo' \
--header 'x-api-key: {YOUR_API_KEY}'Endpoints
27 endpoints. Parameters and responses are described in the TON Center API v3 reference.
| Endpoint | Description |
|---|---|
GET /accountStates | Returns the states of the given accounts. |
GET /actions | Returns actions matching the specified filters. |
GET /addressBook | Returns the user-friendly forms of the given addresses. |
GET /addressInformation | Returns the smart contract information of an address. |
GET /adjacentTransactions | Returns the parent and child transactions of a transaction. |
GET /blocks | Returns blocks matching the specified filters. |
GET /events | Returns events matching the specified filters. |
GET /jetton/burns | Returns Jetton burns matching the specified filters. |
GET /jetton/masters | Returns Jetton masters matching the specified filters. |
GET /jetton/transfers | Returns Jetton transfers matching the specified filters. |
GET /jetton/wallets | Returns Jetton wallets matching the specified filters. |
GET /masterchainBlockShards | Returns the workchain blocks that appeared after the previous masterchain block. |
GET /masterchainBlockShardState | Returns the shard state of a masterchain block. |
GET /masterchainInfo | Returns the first and last indexed masterchain blocks. |
GET /messages | Returns messages matching the specified filters. |
GET /nft/collections | Returns NFT collections matching the specified filters. |
GET /nft/items | Returns NFT items matching the specified filters. |
GET /nft/transfers | Returns NFT transfers matching the specified filters. |
GET /topAccountsByBalance | Lists accounts sorted by balance in descending order. |
GET /transactions | Returns transactions matching the specified filters. |
GET /transactionsByMasterchainBlock | Returns the transactions of a masterchain block and its shard blocks. |
GET /transactionsByMessage | Returns the transactions whose inbound or outbound message has a given hash. |
GET /walletInformation | Returns the wallet contract information of an address. |
GET /walletStates | Returns the wallet states of the given addresses. |
POST /estimateFee | Estimates the fees required to process a message. |
POST /message | Sends an external message to the network. |
POST /runGetMethod | Runs a get method of a smart contract. |
The gateway lists its supported endpoints at runtime:
V2 - TON HTTP API
Base URLs
| Network | Base URL |
|---|---|
| The Open Network Mainnet | https://ton-mainnet.gateway.tatum.io |
| The Open Network Testnet | https://ton-testnet.gateway.tatum.io |
Example request
curl 'https://ton-mainnet.gateway.tatum.io/getMasterchainInfo' \
--header 'x-api-key: {YOUR_API_KEY}'Endpoints
28 endpoints. Parameters and responses are described in the TON Center API v2 reference.
| Endpoint | Description |
|---|---|
GET /detectAddress | Validates an address and returns it in all standard formats. |
GET /getAddressBalance | Returns the balance of an account in nanotons. |
GET /getAddressInformation | Returns the balance, code, data and last transaction ID of an account. |
GET /getAddressState | Returns the state of an account: uninitialized, active or frozen. |
GET /getBlockHeader | Returns the metadata of a block. |
GET /getBlockTransactions | Returns a summary of the transactions in a block. |
GET /getBlockTransactionsExt | Returns the full transactions in a block. |
GET /getConfigParam | Returns a blockchain configuration parameter by ID. |
GET /getConsensusBlock | Returns the latest block confirmed by consensus and its timestamp. |
GET /getExtendedAddressInformation | Returns account information with the contract state parsed for known contract types. |
GET /getMasterchainBlockSignatures | Returns the validator signatures of a masterchain block. |
GET /getMasterchainInfo | Returns the current state of the masterchain, including the latest block. |
GET /getShardBlockProof | Returns a Merkle proof linking a shardchain block to a masterchain block. |
GET /getTokenData | Returns the metadata of a Jetton or NFT contract. |
GET /getTransactions | Returns the transaction history of an account. |
GET /getWalletInformation | Returns the wallet details of an address, such as wallet type and seqno. |
GET /lookupBlock | Finds a block by seqno, logical time or Unix time. |
GET /packAddress | Converts a raw address to the user-friendly format. |
GET /tryLocateResultTx | Finds the transaction that received a given message. |
GET /tryLocateSourceTx | Finds the transaction that sent a given message. |
GET /tryLocateTx | Finds a transaction by the source, destination and creation time of its message. |
GET /unpackAddress | Converts a user-friendly address to the raw format. |
POST /estimateFee | Estimates the fees required to process a message. |
POST /jsonRPC | Calls any HTTP API method through a single JSON-RPC endpoint. |
POST /runGetMethod | Runs a get method of a smart contract. |
POST /sendBoc | Broadcasts a signed external message serialized as a BoC. |
POST /sendBocReturnHash | Broadcasts a signed external message serialized as a BoC and returns its hash. |
POST /sendQuery | Sends an unpacked external message. |
The gateway lists its supported endpoints at runtime:
Endpoint unavailable?If you need an endpoint we don't support yet, contact support.