Santiment

{'type': 'object', 'required': ['sort', 'from', 'to', 'page', 'metric', 'page_size'], 'properties': {'to': {'type': 'string', 'description': 'End date/time for the analysis period. Defines the end of the time window for metric aggregation.\nAccepts ISO 8601 datetime strings (e.g., "2024-12-31T23:59:59Z") or relative time expressions\n(e.g., "utc_now" for current time, "utc_now-1d" for yesterday). Defaults to current time if not specified.\nMust be after the \'from\' date. Used with percentage operators to calculate change over the specified period.\n'}, 'from': {'type': 'string', 'description': 'Start date/time for the analysis period. Defines the beginning of the time window for metric aggregation.\nAccepts ISO 8601 datetime strings (e.g., "2024-01-01T00:00:00Z") or relative time expressions\n(e.g., "utc_now-30d" for 30 days ago, "utc_now-1h" for 1 hour ago)\nDefaults to 30 days ago if not specified. Used with percentage operators to calculate change over time.\n'}, 'page': {'type': 'integer', 'description': 'Page number for paginated results. Used to retrieve specific pages when the result set is large.\nStarts from 1 (first page). Combine with page_size to control how many results are returned per page.\nUseful when only the top 10, 20, 100, etc. assets are needed.\n'}, 'sort': {'enum': ['asc', 'desc'], 'type': 'string', 'description': 'Sort order for the filtered results based on the aggregated metric values.\n- "asc" - Ascending order (lowest values first, e.g., cheapest prices first)\n- "desc" - Descending order (highest values first, e.g., most expensive prices first)\n\nParticularly useful when combined with pagination to get the top/bottom performers.\nExample: sort="desc" with price_usd shows highest-priced projects first.\n'}, 'metric': {'type': 'string', 'description': "The metric to use for screening projects. This determines what aspect of each project will be analyzed.\nCommon metrics include: 'price_usd', 'marketcap_usd', 'volume_usd', 'dev_activity', 'social_volume', 'active_addresses'.\nUse the data catalog to discover all available metrics for comprehensive screening options.\nDiscover the supported metrics with the metrics_and_assets_discovery_tool.\n"}, 'operator': {'enum': ['greater_than', 'less_than', 'percent_up', 'percent_down'], 'type': 'string', 'description': "Comparison operator that determines how projects are filtered based on the metric and threshold.\n\nAbsolute value operators (compare current values):\n- `greater_than` - Include projects where the aggregated metric value is greater than the threshold\n- `less_than` - Include projects where the aggregated metric value is less than the threshold\n\nPercentage change operators (compare change from 'from' to 'to' period):\n- `percent_up` - Include projects where the metric increased by more than the threshold percentage\n- `percent_down` - Include projects where the metric decreased by more than the threshold percentage\n\n\nIf this parameter is not provided, the threshold parameter also must not be provided. If they are\nnot provided, the tool will simply sort the assets and will do no filtering.\n\nExample: operator=percent_up, threshold=25.0 finds projects that gained more than 25%.\n"}, 'page_size': {'type': 'integer', 'description': 'Number of projects to return per page (max 100). Controls the size of each paginated response.\n'}, 'threshold': {'oneOf': [{'type': 'integer'}, {'type': 'number'}], 'description': 'The numeric threshold value used for filtering projects. The meaning depends on the operator:\n\nFor absolute operators (:greater_than, :less_than):\n- The actual metric value to compare against (e.g., 10.5 for price_usd greater_than $10.50)\n- Units match the metric (USD for price/market cap, count for addresses, etc.)\n\nFor percentage operators (:percent_up, :percent_down):\n- The percentage change threshold (e.g., 25.0 for 25% change)\n- Always expressed as a positive number regardless of direction\n\nIf this parameter is not provided, the operator parameter also must not be provided. If they are\nnot provided, the tool will simply sort the assets and will do no filtering.\n\nExamples: threshold=50000000.0 with :less_than finds projects with market cap under $50M\n'}, 'aggregation': {'enum': ['min', 'max', 'sum', 'first', 'last', 'avg'], 'type': 'string', 'description': 'Method for aggregating metric data over the specified time period. Determines how multiple data points\nwithin the time window are combined into a single value for comparison.\n\nCommon aggregation methods:\n- "avg" - Average value over the period (default for most metrics)\n- "sum" - Total sum of values (useful for volume, transaction counts)\n- "max" - Maximum value in the period (highest price, peak activity)\n- "min" - Minimum value in the period (lowest price, minimum activity)\n- "last" - Most recent value in the period\n- "first" - Earliest value in the period\n\nIf not specified, uses the metric\'s default aggregation, whichi is carefully selected based on the metric type.\nSome aggregations do not make sense for certain metrics (e.g., summing prices).\nIf not specifically required, using the metric\'s default aggregation method is recommended.\n'}}}

{'type': 'object', 'properties': {'size': {'type': 'integer', 'description': 'Number of items per category to return (max 30).\n\nDefaults to 10.\n'}, 'time_period': {'type': 'string', 'description': "Time period for trending data (e.g., '1h', '6h', '1d', '7d').\nThis parameter defines how far back to look for trending data.\n\nDefaults to '1h' (last hour).\n"}, 'include_words': {'type': 'boolean', 'description': 'Include trending words in the response.\n\nDefaults to true.\n'}, 'include_stories': {'type': 'boolean', 'description': 'Include trending stories in the response.\n\nDefaults to true.\n'}}}

{'type': 'object', 'required': ['insight_ids'], 'properties': {'insight_ids': {'oneOf': [{'type': 'array', 'items': {'type': 'integer'}}, {'type': 'string'}], 'description': 'Array of santiment crypto insights IDs to fetch full content for (max 10)'}}}

{'type': 'object', 'required': ['metric', 'slugs'], 'properties': {'slugs': {'type': 'array', 'items': {'type': 'string'}, 'description': 'List of slug identifiers (e.g., ["bitcoin"], ["bitcoin", "ethereum"], etc.).\n\nAccepts at most 10 slugs at a time.\n\nOnly metrics that have `supports_many_slugs: true` can accept more than one slug.\nCheck the `supports_many_slugs` field in the metrics_and_assets_discovery_tool response\nbefore passing multiple slugs. Financial and on-chain metrics generally support multiple\nslugs; social, sentiment, and derivatives metrics generally do not.\n\nThe tool returns data for one metric and one or many slugs.\n'}, 'metric': {'type': 'string', 'description': "Metric name to fetch (e.g., 'price_usd').\n\nIMPORTANT: Before fetching data, verify metric names by calling the\nmetrics_and_assets_discovery_tool first. Only metrics listed there are supported.\nDo not guess or infer metric names — they may differ from what you expect.\n"}, 'interval': {'type': 'string', 'description': 'The interval between two data points in the timeseries data (e.g., \'5m\', \'1h\', \'1d\').\n\nThe format is: <number><suffix>, where:\n- <number> is an integer\n- <suffix> is one of:\n  - m (minutes)\n  - h (hours)\n  - d (days)\n  - w (weeks)\n  - y (years)\n\nFor example, 5m means that the data returned will have a 5 minute interval between two data points.\n\nEach metric has predefined `min_interval`. It describes the lowest possible interval for which data is available.\nIf the metric has `min_interval=1d` it means that Santiment has one data point per day for that metric. For these\nmetrics `interval="5m"` won\'t work as 5 minutes is less than 1 day.\n'}, 'time_period': {'type': 'string', 'description': "How far back in time to fetch the data for (e.g., '7d', '30d', '90d').\nThis parameter defines the range of metric data to fetch - from <time_period> time\nago up until now.\n\nDefaults to 30d.\n"}}}

{'type': 'object', 'properties': {'time_period': {'type': 'string', 'description': "Lookback window as <integer><unit>, unit one of s, m, h, d, w, y\n(e.g. '12h', '7d', '30d', '90d', '1y'). Insights published in\n`now - time_period` .. `now` are returned. Absolute dates and future\nranges are not supported. Defaults to '30d'.\n"}}}

{'type': 'object', 'properties': {'slug': {'type': 'string', 'description': "Santiment slug of one crypto asset: lowercase, hyphen-separated, e.g.\n'bitcoin', 'ethereum', 'avalanche'. Not a ticker - use 'bitcoin', not\n'BTC'. One slug per call; lists are not accepted.\n\nAlone: returns all metrics available for this asset. With `metric`:\nchecks only whether that metric exists for this asset. Omit both to list\nthe whole catalog.\n"}, 'metric': {'type': 'string', 'description': "Santiment id of one metric: lowercase snake_case, e.g. 'price_usd',\n'marketcap_usd', 'daily_active_addresses'. One metric per call; lists are\nnot accepted.\n\nAlone: returns all assets that support this metric. With `slug`: checks\nonly whether this metric exists for that asset. Omit both to list the\nwhole catalog.\n"}}}

{'type': 'object', 'properties': {'slug': {'type': 'string', 'description': "Asset slug (e.g. 'bitcoin', 'ethereum'). Defaults to 'bitcoin'."}, 'range': {'type': 'string', 'description': 'Time range. One of: 24h, 7d, 30d, 90d, 1y. Defaults to 30d.'}, 'overlay': {'type': 'string', 'description': 'Optional metric to overlay in a second pane. Must be one of the catalog names (see tool description).'}, 'primary': {'type': 'string', 'description': "Primary series — 'price' for candlestick OHLC, or a metric name from the catalog. Defaults to 'price'."}}}

{'type': 'object', 'properties': {'size': {'type': 'integer', 'description': 'Number of trending stories to return (max 10).\n\nDefaults to 10.\n'}, 'time_period': {'type': 'string', 'description': "Time period for trending stories (e.g., '1h', '6h', '1d', '7d').\nThis parameter defines how far back to look for trending stories.\n\nDefaults to '1h' (last hour).\n"}}}