Classify HIP-3 wallets

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "classifyHip3Wallets query parameters",
  "type": "object",
  "properties": {
    "min_orders": {
      "description": "Minimum order count. Default 100.",
      "type": "integer",
      "format": "int64",
      "default": 100,
      "x-parameter-location": "query"
    },
    "min_volume_usd": {
      "description": "Minimum fill volume in USD.",
      "type": "number",
      "default": 0,
      "x-parameter-location": "query"
    },
    "sort": {
      "description": "Metric to sort by.",
      "type": "string",
      "enum": [
        "total_orders",
        "total_fills",
        "total_volume",
        "total_volume_usd",
        "cancel_rate",
        "fill_rate",
        "maker_ratio",
        "avg_order_size_usd",
        "avg_order_notional",
        "max_order_size_usd",
        "max_order_notional",
        "active_hours",
        "unique_coins",
        "total_fees",
        "total_fees_usd",
        "realized_pnl",
        "realized_pnl_usd",
        "median_cancel_speed_ms",
        "twap_fills",
        "total_priority_gas",
        "total_priority_gas_paid",
        "total_builder_fees",
        "total_builder_fees_paid"
      ],
      "default": "total_orders",
      "x-parameter-location": "query"
    },
    "order": {
      "description": "Sort order.",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "default": "desc",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum wallets to return (default: 100, max: 1000).",
      "type": "integer",
      "default": 100,
      "minimum": 1,
      "maximum": 1000,
      "x-parameter-location": "query"
    },
    "offset": {
      "description": "Pagination offset. Capped at 100000.",
      "type": "integer",
      "default": 0,
      "maximum": 100000,
      "x-parameter-location": "query"
    },
    "uses_twap": {
      "description": "Filter wallets by TWAP usage.",
      "type": "boolean",
      "x-parameter-location": "query"
    },
    "uses_priority_gas": {
      "description": "Filter wallets by priority-gas usage.",
      "type": "boolean",
      "x-parameter-location": "query"
    },
    "min_cancel_rate": {
      "description": "Minimum cancel rate, from 0.0 to 1.0.",
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "x-parameter-location": "query"
    },
    "max_cancel_rate": {
      "description": "Maximum cancel rate, from 0.0 to 1.0.",
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "x-parameter-location": "query"
    },
    "date": {
      "description": "Daily snapshot date (YYYY-MM-DD). Defaults to yesterday.",
      "type": "string",
      "format": "date",
      "example": "2026-06-16",
      "x-parameter-location": "query"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "classifyHip3Wallets response 200",
  "description": "API response containing bulk wallet classification results.",
  "type": "object",
  "properties": {
    "data": {
      "description": "Bulk wallet classification response body.",
      "type": "object",
      "required": [
        "date",
        "total",
        "wallets"
      ],
      "properties": {
        "date": {
          "description": "Daily snapshot date.",
          "type": "string",
          "example": "2026-06-16"
        },
        "total": {
          "description": "Total wallets matching the filters.",
          "type": "integer",
          "format": "int64",
          "example": 4444
        },
        "wallets": {
          "type": "array",
          "items": {
            "description": "Wallet plus its precomputed behavior metrics.",
            "type": "object",
            "required": [
              "address",
              "metrics",
              "period"
            ],
            "properties": {
              "address": {
                "description": "Wallet address.",
                "type": "string",
                "example": "0x010461c14e146ac35fe42271bdc1134ee31c703a"
              },
              "metrics": {
                "description": "Precomputed wallet behavior metrics.",
                "type": "object",
                "properties": {
                  "active_hours": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "avg_order_size_usd": {
                    "type": "number"
                  },
                  "buy_volume_usd": {
                    "type": "number"
                  },
                  "cancel_rate": {
                    "type": "number"
                  },
                  "cloid_ratio": {
                    "type": "number"
                  },
                  "fill_rate": {
                    "type": "number"
                  },
                  "ioc_ratio": {
                    "type": "number"
                  },
                  "liquidation_count": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "long_short_ratio": {
                    "type": "number"
                  },
                  "maker_ratio": {
                    "type": "number"
                  },
                  "max_order_size_usd": {
                    "type": "number"
                  },
                  "max_single_fill_usd": {
                    "type": "number"
                  },
                  "median_cancel_speed_ms": {
                    "type": "number"
                  },
                  "order_to_trade_ratio": {
                    "type": "number"
                  },
                  "post_only_ratio": {
                    "type": "number"
                  },
                  "realized_pnl_usd": {
                    "type": "number"
                  },
                  "sell_volume_usd": {
                    "type": "number"
                  },
                  "top_builder": {
                    "type": "string",
                    "nullable": true
                  },
                  "total_builder_fees_paid": {
                    "type": "number"
                  },
                  "total_fees_usd": {
                    "type": "number"
                  },
                  "total_fills": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "total_orders": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "total_priority_gas_paid": {
                    "type": "number"
                  },
                  "total_volume_usd": {
                    "type": "number"
                  },
                  "tpsl_ratio": {
                    "type": "number"
                  },
                  "trigger_order_ratio": {
                    "type": "number"
                  },
                  "twap_fill_ratio": {
                    "type": "number"
                  },
                  "unique_coins_traded": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "unique_fill_coins": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "uses_builder": {
                    "type": "boolean"
                  },
                  "uses_cloid": {
                    "type": "boolean"
                  },
                  "uses_priority_gas": {
                    "type": "boolean"
                  },
                  "uses_tpsl": {
                    "type": "boolean"
                  },
                  "uses_twap": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              "period": {
                "description": "Metric lookback period.",
                "type": "string",
                "example": "24h"
              }
            }
          }
        }
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "next_cursor": {
          "description": "Cursor for pagination (timestamp). Use this value as the `cursor` parameter to fetch the next page of results.",
          "type": "string",
          "nullable": true
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "classifyHip3Wallets response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}

{
  "code": 400,
  "error": "Invalid request parameters"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "classifyHip3Wallets response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "classifyHip3Wallets response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}