How to use the TokenInsight API to obtain cryptocurrency rating data?
TokenInsight Rating uses a standardized rating methodology to evaluate tokenized projects in the blockchain industry. The rating methodology we provide only assesses the qualification and risk of a given project. It can not be used to assess the investment value of the token. The rating results can not be utilized as the sole point of reference for investment purposes.
If you would like to understand the rating methodology in more detail, you can refer to the documentation available here.
The latter part of this article provides explanations of the six dimensions of the rating and the corresponding rating levels. Feel free to scroll down for further details if you are interested.
What are the API endpoints to retrieve the ratings?
In our API documentation, we have listed the API endpoints for retrieving ratings. There are two endpoints within the rating API: one for retrieving the rating result of any specific coin and another for retrieving the rating results of all rated coins.
Endpoint for retrieving the rating of any specific coin:
Our API base URL is https://api.tokeninsight.com, and the endpoint for any specific coin is /api/v1/rating/coin/{id}.
The {id} needs to be replaced with the id of the coin you want to retrieve. For example, if you want to retrieve the rating data of Bitcoin, the URL should be https://api.tokeninsight.com/api/v1/rating/coin/bitcoin. However, please note that this URL can not be accessed directly. You need to add your API key to the header.
This endpoint only has one parameter, which is the id. In TokenInsight's API system, the id is also referred to as tid (token id). Tid is the unique identifier for any coin because there is a possibility of having projects with the same name or abbreviation in the cryptocurrency market. If you want to find the tid/id of the coin you are looking for, you can use the endpoint to retrieve the list of all coins. The returned data will indicate the id of each project.
Another way to obtain the coin's id is by examining the contents of the URL. For example, in the case of XRP, the value following "coins/" in the URL is the id of that coin. This method applies to any coin.
In the returned data, when retrieving the rating of any specific coin, it includes:
- Rating level (from highest AAA to lowest D)
- Rating score (a percentage score with two decimal places, dynamically updated on a daily basis)
- Rating report link URL
- Scores of the six dimensions of the rating (represented in percentage form)
- News related to the coin
- Update time of the rating data (automated system, daily updates)
- Time of manual review for the rating
- Tags associated with the coin
Endpoint for retrieving the ratings of all coins:
This endpoint allows you to retrieve ratings for all coins. Regarding the parameters, you can specify the number of rating projects you want to retrieve. If no value is provided, the default is 300 projects.
Endpoint: https://api.tokeninsight.com/api/v1/rating/coins
Similar to the previous endpoint, this URL can not be accessed directly. You need to add the TI_API_KEY to the Header in order to use it.
The information returned by this endpoint is similar to the previous endpoint, but it retrieves multiple projects at once.
By using these two endpoints, you can easily retrieve TokenInsight's rating dynamic data about projects!
Rating Widget
In addition to the API, we also provide the option to retrieve coin rating data through widget components. The widget components are designed to provide the following
<script src="https://s2.tokeninsight.com/widgets/tokeninsight-rating-widget/index.js?343243434"></script><tokeninsight-rating-widget subject="white" language="en" token="bitcoin"></tokeninsight-rating-widget>
You can customize the widget based on your needs.
- subject = "white" ---> light mode
- subject = "black" ---> dark mode
- language = "en" ---> English
- language = "zh" ---> Chinese
token = "bitcoin" ---> You can modify "bitcoin" to change the coin displayed. The value within the quotation marks represents the coin's id or tid.
In addition to the rating API, we also provide numerous other cryptocurrency data API endpoints. Please refer to our API documentation for more information.
If you want to import the data to Google Sheets, feel free to check this tutorial::How to Import TokenInsight Cryptocurrency Data into Google Sheets?
If you encounter any issues or need any help while using our API, shot an email api@tokeninsight.com for assistance.
Six dimensions of TokenInsight token rating
Underlying Technology & Security
The security of the underlying technology is always fundamental to the success of a blockchain-based project. We mainly look at the security and stability of the project's underlying technology in this dimension. Projects that have improved their security and stability in various ways, or that have been tested over time without any vulnerabilities, are more likely to score higher in this dimension.
The indicators we reference include but are not limited to Operation Duration, GitHub Activity, Smart Contract Audits, Bug Bounty Programs, and Crisis Events. For public chain projects, we also consider their Network Components with respect to the Nakamoto Coefficients, etc.
Roadmap & Progress
Publicly disclosed long-term goals and specific development plans represent the project team's commitment to development. They also show the direction of the project and the development strengths of the core team and demonstrate accountability to its community supporters. Ongoing milestones and a continuously updated roadmap provide a reference for whether the team is delivering on its commitments.
The ideal project will have specific and achievable long-term goals, a roadmap that is as detailed as possible, and the ability to deliver key milestones on schedule as outlined in the roadmap.
The indicators we reference include but are not limited to Roadmap Evaluation, Progress Disclosure, Milestones Achieved, and Actual Progress vs. Expectations.
Token Economics
Our assessment of Token Economics is divided into two parts: advance planning and actual user usage. Advance planning for Token Economics includes application scenarios, distribution plans, and vesting plans for native tokens. These reflect the project's potential ability to attract target users and its goal for long-term development.
The specific holdings and usage of the token can be used to test the success of Token Economics planning. We generally consider Token Economics ideal for projects with more detailed design, clearer disclosure, relatively more on-chain holders, and more on-chain activities.
The indicators we reference include but are not limited to Native Token Usage Scenarios, Token Distribution Plans, Token Vesting Plans, On-Chain Holders, and On-Chain Activity. For Stablecoins, we also consider their Price Peg Methods, Reserve Assets and etc.
Token Performance
The assessment of the secondary market performance of the token is divided into two main parts: liquidity and historical price performance. We refer to the performance of BTC and ETH as the overall macro market comparison variables and study the performance of the project's native tokens in different market environments.
Ideally, the native token of a project should be liquid on mainstream exchanges and have a relatively high and stable trading volume. At the same time, their historical price volatility should be relatively lower.
The indicators we reference include but are not limited to: Supported Exchanges, Spot & Derivative Trading Pairs, Trading Volume, Turnover Rate, Price Volatility, Moving Average Return, and Retracement from ATH.
For Stablecoins, we also consider their Price Depeg Rate.
Ecosystem Development
Participants are the most important for any ecosystem, so we will focus on a comparative study of the number of community supporters and engagement, supplemented by a study of related project support, to determine the ecosystem's vitality and potential for growth. Typically, projects that have more engaged users and are more active in official communities and social media, or are supported by more eco-related projects, are more likely to score higher.
The indicators we reference include but are not limited to Eco-related Projects, Size & Activity of the Official Community, Size & Activity of Social Media, and Decentralized Governance.
Team, Partners & Investors
The qualifications of the core team can greatly influence the project's prospects. Publicly disclosed partners and investors can help us understand how much help the project will receive in certain areas. The ideal project should be led by an experienced core team with a strong educational background, a solid team size, and a balanced distribution of team members. It also has the support of partners with experience and strength in the relevant industry, as well as reputable investors.
The indicators we reference include but are not limited to Core Team Strength, Team Size and Stability, Partner Evaluation, and Investor Evaluation.
TokenInsight Rating Symbols and Definitions
- AAA: Demonstrates exceptional underlying technology and robust security measures. The project has boasted a substantial and thriving ecosystem and garnered significant industry attention. Multiple automated metrics affirm the project's outstanding quality and minimal risk.
- AA: Showcases strong foundational technology and a high level of security. The project has enjoyed a large and thriving ecosystem and attracted considerable industry attention. Multiple automated metrics confirm the project's healthy development trajectory with high quality and low risk.
- A: Exhibits a secure and reliable technological infrastructure. The project has garnered notable industry attention and boasts a substantial, steady, and diverse ecosystem. Multiple automated metrics signify the project's healthy development with relatively low risk.
- BBB: Demonstrates high technological feasibility and relatively rich application scenarios, with major products already launched and continuously iterated, contributing to a stable ecosystem. Multiple automated metrics reflect significant industry attention and support, steady development, and highly manageable risks.
- BB: Features good technological feasibility and diverse application scenarios, with major products already launched and an early-stage ecosystem in place. Multiple automated metrics indicate a notable level of industry attention and support, stable development, and relatively high manageable risks.
- B: Boasts a sound technological framework and hybrid application scenarios, and partial major products already launched. Multiple automated metrics indicate a certain level of industry attention and support, with manageable risks.
- CCC: Possesses a reasonable technological framework, but is still under development or has early-stage products in use, albeit with limited application scenarios. Multiple automated metrics suggest moderate market attention, while long-term sustainable development carries uncertainties, resulting in a moderately elevated level of risk.
- CC: Exhibits limited development progress, technological framework issues, restricted application scenarios, and inadequate or unclear disclosure. Multiple automated metrics indicate a lack of market attention/community support, with a relatively high level of risk.
- C: Faces significant technological framework challenges, limited application scenarios, or long-term stagnation in development. Insufficient disclosure to demonstrate the proper and sustainable development of the project. Multiple automated metrics point to a lack of market attention, resulting in a high level of risk.
- D: Multiple automated metrics indicate that the project's services are terminated, or the services cannot be properly provided, signifying an extremely high level of risk.
Data
Tools