| get_sentiment_balance | Retrieve the sentiment balance (sentiment_balance_total) for a given asset. Parameters: - asset (str): The cryptocurrency slug (e.g., "bitcoin", "ethereum"). Required.
- days (int): Number of days to calculate the average sentiment balance, defaults to 7.
Usage: - Use this tool to get the average sentiment balance (positive minus negative sentiment) over a period.
Returns: - A string with the average sentiment balance (e.g., "Bitcoin's sentiment balance over the past 7 days is 12.5").
|
| get_social_volume | Retrieve the total social volume (social_volume_total) for a given asset. It calculates the total number of social data text documents that contain the given search term at least once. Examples of documents are telegram messages and reddit posts. Parameters: - asset (str): The cryptocurrency slug (e.g., "bitcoin", "ethereum"). Required.
- days (int): Number of days to sum the social volume, defaults to 7.
Usage: - Call this tool to get the total number of social media mentions for an asset over a period.
Returns: - A string with the total social volume (e.g., "Bitcoin's social volume over the past 7 days is 15,000 mentions").
|
| alert_social_shift | Detect significant shifts (spikes or drops) in social volume (social_volume_total) for a given asset. Parameters: - asset (str): The cryptocurrency slug (e.g., "bitcoin", "ethereum"). Required.
- threshold (float): Minimum percentage change (absolute value) to trigger an alert, defaults to 50.0 (i.e., 50%).
- days (int): Number of days to analyze for baseline volume, defaults to 7.
Usage: - Call this tool to check if the latest social volume has significantly spiked or dropped compared to the previous average.
Returns: - A string indicating if a shift occurred (e.g., "Bitcoin's social volume spiked by 75.0% in the last 24 hours" or "Bitcoin's social volume dropped by 60.0% in the last 24 hours").
|
| get_trending_words | Retrieve the top trending words in the crypto space over a specified period, aggregated and ranked by score. Parameters: - days (int): Number of days to analyze trending words, defaults to 7.
- top_n (int): Number of top trending words to return, defaults to 5.
Usage: - Call this tool to get a list of the most popular words trending in cryptocurrency discussions, ranked across the entire period.
Returns: - A string listing the top trending words (e.g., "Top 5 trending words over the past 7 days: 'halving', 'bullrun', 'defi', 'nft', 'pump'").
|
| get_social_dominance | Retrieve the social dominance (social_dominance_total) for a given asset. Social Dominance shows the share of the discussions in crypto media that is referring to a particular asset or phrase. Parameters: - asset (str): The cryptocurrency slug (e.g., "bitcoin", "ethereum"). Required.
- days (int): Number of days to calculate average social dominance, defaults to 7.
Usage: - Call this tool to get the percentage of social media discussion dominated by the asset.
Returns: - A string with the average social dominance (e.g., "Bitcoin's social dominance over the past 7 days is 25.3%").
|