{"id":331,"date":"2024-03-11T16:15:24","date_gmt":"2024-03-11T16:15:24","guid":{"rendered":"https:\/\/nownodes.io\/blog\/?p=331"},"modified":"2024-03-11T16:15:25","modified_gmt":"2024-03-11T16:15:25","slug":"ton-indexer-api-guide","status":"publish","type":"post","link":"https:\/\/nownodes.io\/blog\/ton-indexer-api-guide\/","title":{"rendered":"A Complete Tutorial: Interacting with TON Indexer API"},"content":{"rendered":"\n
\n
Connect to TON API Nodes<\/a><\/div>\n<\/div>\n\n\n\n

<\/p>\n\n\n\n

Welcome TON Builders! In this tutorial, we will guide you through the process of interacting with the Radix Advanced Node API and integrating it for the data and development needs. Additionally, we are going to cover the new methods that our TON Indexer instance supports in the API and present the easiest access to the\u00a0<\/p>\n\n\n\n

The TON Blockchain, also known as The Open Network (TON), is a decentralized Layer 1 blockchain network that revolutionizes the way we interact with digital assets and services. Developed by the team behind the popular messaging app Telegram, TON offers a wide range of features and capabilities that make it an attractive choice for developers and businesses alike. <\/p>\n\n\n\n

Let\u2019s delve into the guide! <\/strong>You can save this tutorial and share it for the development needs \ud83d\ude42<\/p>\n\n\n\n

Table of Content<\/strong><\/div>
<\/span><\/span><\/span><\/span><\/div><\/div>
<\/div>
    <\/ol><\/div><\/div><\/div>\n\n\n

    What is the TON Indexer API? What are the Main Use Cases?<\/h2>\n\n\n

    At its core, TON is designed to provide a scalable and secure platform for the creation and execution of smart contracts, decentralized applications (dApps), and digital currencies. With its unique combination of speed, security, and flexibility, the TON blockchain has the potential to disrupt traditional industries and empower users with new opportunities.<\/p>\n\n\n\n

    It\u2019s fair to mention that there are various development tools available in the TON ecosystem. The list includes blockchain explorers, SDKs and custom libraries as well as API tools. One of them is the TON Indexer API – a powerful tool that allows developers to retrieve and analyze data from the TON blockchain<\/em>. With its full set of endpoints, the TON Indexer API provides access to a wide range of data, including transaction history, block details, and account balances.<\/p>\n\n\n\n

    In our case, we use the updated<\/strong> TON Indexer instance<\/strong> from the Master branch<\/span>. This ensures the stability and the security of the software.<\/div>\n\n\n\n

    By accessing the TON Indexer, developers can obtain real-time information about the state of the blockchain, including transaction history, block details, and account balances. This data can be used to build applications, monitor network activity, and conduct research on the TON blockchain.<\/p>\n\n\n

    Differences Between TON RPC Full Node and Indexer API<\/h2>\n\n\n

    Despite assisting developers and powering similar functions, the TON RPC Full Node and the Indexer API serve different purposes and needs in the development of applications on TON.<\/p>\n\n\n\n

    For example, developers typically use TON RPC Full Nodes<\/em> for interacting directly with the blockchain to perform a wide range of functions: querying blockchain data, submitting transactions, etc. The focus here\u00a0 is on direct interaction with the blockchain and real-time data processing.<\/p>\n\n\n\n

    On the other hand, the Indexer API<\/em> is designed to provide more sophisticated, indexed data from the blockchain, making it more suitable for applications that require fast and efficient access to large amounts of data, usually – the historical kind of it. The methods available through the Indexer API are focused on retrieving indexed and processed data. This can include transaction histories, wallet balances, and other blockchain state information that has been indexed for quick access.<\/p>\n\n\n\n

    This time we focus on utilizing the TON Indexer. Let\u2019s get straight to the details!<\/strong><\/p>\n\n\n

    Step-by-step tutorial on Integrating TON Indexer API<\/h2>\n\n

    Setting Up The Environment<\/em><\/strong><\/h3>\n\n\n

    To utilize the TON Indexer API, we are going to make HTTP (RPC) requests to the API endpoints using any of the preferred programming tools. The API responses will return in a JSON format, making it easy to parse and process the data.<\/p>\n\n\n\n

    In our guide we will refer to the following TON Indexer API endpoint: ton-index.nownodes.io.\u00a0<\/strong><\/code><\/p>\n\n\n\n

    Make sure you obtain an API key<\/strong> in order to access TON Indexer. You can create it at the NOWNodes website<\/a>.<\/div>\n\n\n\n

    If the API environment is ready, the API key is generated, then we\u2019re good to proceed <\/strong>to the next step.<\/p>\n\n\n

    Testing the connection<\/em><\/strong><\/h3>\n\n\n

    Let’s check if the requests are being sent without any errors and we receive valid responses. In this case we\u2019re going to use the masterchainInfo<\/code> method. Here\u2019s the example:<\/p>\n\n\n\n

    curl --request GET \\\n\u00a0\u00a0--url 'https:\/\/ton-index.nownodes.io\/masterchainInfo?address=EQBwCK26MZ1yEUR9dnSO5reQRbnN9LJcaMtAvvqSk4mbgZBx' \\\n\u00a0\u00a0--header 'api-key: _______'<\/code><\/pre>\n\n\n\n
    This method displays the data of the chain with the information on the validators, hashes, etc. <\/p>\n\n\n\n
    If you receive a 200-type answer, then we\u2019re good to go and move to the next step<\/p>\n\n\n\n
      \n
    1. Browsing Transaction-related Indexer API Methods <\/strong><\/li>\n<\/ol>\n\n\n\n
      The following endpoints and methods would be most useful for crypto enterprises that review and sync the TON blockchain transaction data. Let\u2019s start from the general method – transactions. This type of call will display the transactions of the TON blockchain and filter it by specified categories.   <\/p>\n\n\n\n

      Here\u2019s an example of a request without any filters:<\/p>\n\n\n\n
      curl --request GET \\\n\u00a0\u00a0--url https:\/\/ton-index.nownodes.io\/transactions \\\n\u00a0\u00a0--header 'api-key: your-api-key'<\/code><\/pre>\n\n\n\n

      If you would like to structure the answer by filtering the transactions, you can use the following filters: account, hash, shard, etc. Let\u2019s adjust the example with an address:<\/p>\n\n\n\n
      curl --request GET \\\n\u00a0\u00a0--url https:\/\/ton-index.nownodes.io\/transactions?account=EQDa4VOnTYlLvDJ0gZjNYm5PXfSmmtL6Vs6A_CZEtXCNICq_&limit=128&offset=0&sort=desc \\\n\u00a0\u00a0--header 'api-key: your-api-key'<\/code><\/pre>\n\n\n\n
      Please note that these methods require obtaining quite a big part of the data. In order to optimize your requests and call to TON Indexer API, you can add more parameters to the header.\u00a0<\/p>\n\n\n\n
        \n
      1. Accessing Other Methods of the Indexer API <\/li>\n<\/ol>\n\n\n\n
        Since TON Indexer allows to retrieve and process more sophisticated data, there are more commands available for TON developers. The command list that would be most useful and is actively being utilized by the team includes: <\/p>\n\n\n\n