assets_by_metric_tool

{
  "properties": {
    "aggregation": {
      "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",
      "enum": [
        "min",
        "max",
        "sum",
        "first",
        "last",
        "avg"
      ],
      "type": "string"
    },
    "from": {
      "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",
      "type": "string"
    },
    "metric": {
      "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",
      "type": "string"
    },
    "operator": {
      "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",
      "enum": [
        "greater_than",
        "less_than",
        "percent_up",
        "percent_down"
      ],
      "type": "string"
    },
    "page": {
      "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",
      "type": "integer"
    },
    "page_size": {
      "description": "Number of projects to return per page (max 100). Controls the size of each paginated response.\n",
      "type": "integer"
    },
    "sort": {
      "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",
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string"
    },
    "threshold": {
      "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",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "number"
        }
      ]
    },
    "to": {
      "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",
      "type": "string"
    }
  },
  "required": [
    "sort",
    "from",
    "to",
    "page",
    "metric",
    "page_size"
  ],
  "type": "object"
}