API Reference

List of all metrics and terms used in our API along with their structure

CryptoRiskIQ

id

The unique identifier associated with each cryptocurrency on the platform.

name

Full name of the cryptocurrency.

ticker

Cryptocurrency's symbol.

type

This represents whether the cryptocurrency is a coin or a token.

blockchain_type

Type of blockchain on which the cryptocurrency operates.

coinmarketcap_url

URL of the cryptocurrency's page on the CoinMarketCap website, a leading market data provider in the crypto space.

website

Official website of the cryptocurrency.

github.sources

List of links to the repositories on GitHub associated with the cryptocurrency.

github.data

This list includes a date and the associated number of active contributors and commits to the GitHub repositories of the cryptocurrency.

discord.sources

List of links to the Discord servers associated with the cryptocurrency.

discord.data

This list includes a date and the number of members in the associated discord channel.

telegram.sources

List of links to the Telegram channels related to the cryptocurrency.

telegram.data

This list includes a date, the number of members in the associated Telegram channels, the number of posts made, and the average number of views per post.

reddit.sources

List of links to the subreddits associated with the cryptocurrency.

reddit.data

This list includes a date, the number of members in the associated subreddit, the number of posts made, the number of global mentions of the cryptocurrency, and the overall sentiment of those mentions.

twitter

This includes a date and the number of global mentions of the cryptocurrency on Twitter.


Social Pulse

sentiment

The overall emotional tone of all mentions (Twitter, Reddit, Telegram) of the asset within the timeframe considered. It is measured on a scale from 0 (very negative) to 1 (very positive).

sentiment_change

Percentage change in sentiment compared to the previous similar timeframe. For instance, if the current sentiment is 0.5 and the sentiment 10 minutes ago was 0.4, the sentiment change would be 25%.

mentions

The total number of times the asset was mentioned across various platforms (Twitter, Reddit, Telegram) in the timeframe considered.

mentions_change

Percentage change in the number of mentions compared to the previous similar timeframe.

mentions_hourly

The number of mentions of the asset across various platforms in the last hour.

mentions_hourly_change

This is the percentage change in the number of hourly mentions compared to the previous hour. It calculates how much the mentions over the last hour have changed in comparison with the mentions over the previous hour.

mentions_daily

The number of mentions of the asset across various platforms in the last day.

mentions_daily_change

The percentage change in the number of daily mentions compared to the previous day.

twitter_mentions

The number of times the asset was mentioned on Twitter in the timeframe considered.

twitter_mentions_by_influencers

We crunched a list of 1,500 valuable crypto influencers on Twitter, and we track their tweets and the number of coin mentions.

twitter_positive_mentions_by_influencers

The number of positive mentions (sentiment >= 0.6) made by influencers on Twitter in the timeframe considered.

twitter_sentiment_by_influencers

This is the overall emotional tone of tweets by influencers about the asset in the timeframe considered. It is measured on a scale from 0 (very negative) to 1 (very positive).

reddit_mentions

This is the number of times the asset was mentioned on the Reddit platform (global) in the timeframe considered.

reddit_title_mentions

This is the number of times the asset was mentioned in the title of a Reddit post in the timeframe considered.

reddit_mentions_positive

This is the number of positive mentions (sentiment >= 0.6) of the asset on Reddit in the timeframe considered.

reddit_sentiment

This is the overall emotional tone of Reddit posts and comments about the asset in the timeframe considered. It is measured on a scale from 0 (very negative) to 1 (very positive).

telegram_mentions

This is the number of times the asset was mentioned on Telegram in the timeframe considered.

telegram_mentions_positive

This is the number of positive mentions (sentiment >= 0.6) of the asset on Telegram in the timeframe considered.

telegram_sentiment

This is the overall emotional tone of Telegram messages about the asset in the timeframe considered. It is measured on a scale from 0 (very negative) to 1 (very positive).


News Endpoint

publication_datetime

The date and time when the news article was published on the source.

title

The title of the news article.

source

The source (domain) from where the news article originated.

ai_verdict

This is the predicted impact of the news article on the associated cryptocurrency, determined by the GPT-based model. The verdict can be Bullish (predicting the price to go up), Bearish (predicting the price to go down), or Unknown.

ai_reason

This is the reasoning provided by the AI system for its verdict.

URL

This is the URL to access the full news article on the original source.