As a developer in the masternode ecosystem, you may need access to external data, such as a specific coin or blockchain information from the DECENOMY explorer. To address this need, the DECENOMY team has made the DECENOMY Explorer API publicly available, allowing unrestricted access to critical data. In this article, we’ll explore what APIs are and the capabilities of DECENOMY’s API, and demonstrate how it can enhance your development process.
Thank you for reading this post, don't forget to subscribe!What is an API
API stands for Application Programming Interface. In computing, an API acts as a bridge, enabling two distinct systems to communicate. It defines the rules for exchanging information and services between different computer programs. API documentation serves as a guide for developers, helping them structure requests and interpret responses.
For example, when you use an app (often referred to as the ‘client’ in API architecture) to request cryptocurrency prices, the app connects to an API to retrieve data from a cryptocurrency aggregator (the ‘server’) and then displays the information on your screen.
The DECENOMY EXPLORER API
APIs can be classified based on their scope of use. Some, like private and partner APIs, have restrictions to ensure that only authorized individuals have access. The DECENOMY Explorer API, on the other hand, is public, meaning it is freely available for public use without the need for authentication or usage costs.
This API allows developers to access data from the DECENOMY explorer for all coins within the ecosystem. There are two versions of the API: Version one provides basic data in plain text, while version two offers a more comprehensive set of information.
API Endpoint
This is the specific server URL or touchpoint where requests are sent, and information is received between programs. You can think of it as the gateway through which communication between systems takes place.
DECENOMY API V1 Endpoint URL
https://explorer.decenomy.net/api/v1/coins/coin
In the URL mentioned above, ‘coin’ can be replaced with the ticker symbol of any DECENOMY coin. For example, if you want to retrieve specific data on Sapphire through the API, you will replace ‘coin’ with ‘SAPP’ (in capital letters), along with a specific method, which we will look at next.
Examples of query parameters for API V1
- getblockcount: this returns the block number value as a string. For example, https://explorer.decenomy.net/api/v1/coins/SAPP/getblockcount will report the current block height of the Sapphire (SAPP) chain.
- getmoneysupply: This parameter returns the total number of coins circulating in the market. i.e. subtracting any coins that are locked, burned, reserved, or unavailable from the total supply of a coin. For example, https://explorer.decenomy.net/api/v1/coins/SAPP/getmoneysupply will retrieve the circulatory supply value of the SAPP coin.
- getlockedsupply: As the name suggests, it returns the number value of the locked/burned supply. For example, https://explorer.decenomy.net/api/v1/coins/SAPP/getlockedsupply will report the amount of SAPP coins that are burned or locked.
- gettotalsupply: This will output just the number value of the total coin supply. i.e., circulation supply plus the locked supply. For example, a query may look like https://explorer.decenomy.net/api/v1/coins/SAPP/gettotalsupply and the total Sapphire coin supply.
DECENOMY API V2 Endpoint URL
https://explorer.decenomy.net/api/v2/coin
This URL is similar to that of API V1 but points to version two, which includes methods that provide more detailed information. To specify a DECENOMY coin of interest, replace ‘coin’ in the URL with the coin’s ticker, followed by a method. This process is similar to what we demonstrated earlier with API V1.
Examples of query parameters for API V2
- masternodes: this retrieves information on all masternodes on a network. For example, https://explorer.decenomy.net/api/v2/SAPP/masternodes will report information on each SAPP masternode on the Saphire network.
- info: provides comprehensive information on the blockchain and wallet. For example, https://explorer.decenomy.net/api/v2/SAPP/info reports information on the SAPP blockchain network and wallet.
- masternode/count: get information on the total number of masternodes connected in the network. For example, https://explorer.decenomy.net/api/v2/SAPP/masternode/count will report the number of active SAPP masternodes on the network.
The list of the available query parameters for DECENOMY API V2 can be accessed on the Explorer API documentation page.
Conclusion
The DECENOMY Explorer API serves as a valuable tool for developers in the masternode ecosystem, enabling easy access to comprehensive blockchain and coin data. Whether you’re looking for basic information or more in-depth details, this API offers the flexibility to enhance your applications. By understanding how APIs work and utilizing DECENOMY’s API, you can streamline your development process and have access to real-time data. You may also explore DECENOMY’s efforts to achieve equitable money distribution.
