cryptodataapi-com · Schema

HLTradeFlowResponse

CompanyCryptocurrencyFinanceDataReal-TimeMarket Data

Properties

Name Type Description
coin string
minutes integer
bucket string
large_fill_usd number
window_start integer
window_end integer Exclusive; the open minute is never included
stream object
data array
count integer
View JSON Schema on GitHub

JSON Schema

cryptodataapi-com-hltrade-flow-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cryptodataapi-com/json-schema/cryptodataapi-com-hltrade-flow-response-schema.json",
  "title": "HLTradeFlowResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cryptodataapi-com-hyperliquid-api-openapi.yml#/components/schemas/HLTradeFlowResponse",
  "properties": {
    "coin": {
      "type": "string",
      "title": "Coin"
    },
    "minutes": {
      "type": "integer",
      "title": "Minutes"
    },
    "bucket": {
      "type": "string",
      "title": "Bucket",
      "default": "1m"
    },
    "large_fill_usd": {
      "type": "number",
      "title": "Large Fill Usd"
    },
    "window_start": {
      "type": "integer",
      "title": "Window Start"
    },
    "window_end": {
      "type": "integer",
      "title": "Window End",
      "description": "Exclusive; the open minute is never included"
    },
    "stream": {
      "$ref": "#/$defs/HLTradeFlowStream"
    },
    "data": {
      "items": {
        "$ref": "#/$defs/HLTradeFlowBucket"
      },
      "type": "array",
      "title": "Data"
    },
    "count": {
      "type": "integer",
      "title": "Count"
    }
  },
  "type": "object",
  "required": [
    "coin",
    "minutes",
    "large_fill_usd",
    "window_start",
    "window_end",
    "stream",
    "data",
    "count"
  ],
  "$defs": {
    "HLTradeFlowBucket": {
      "properties": {
        "time": {
          "type": "integer",
          "title": "Time",
          "description": "Minute start, unix ms (UTC)"
        },
        "coin": {
          "type": "string",
          "title": "Coin"
        },
        "buy_notional": {
          "title": "Buy Notional",
          "description": "USD notional where the taker BOUGHT (HL side B)",
          "type": [
            "number",
            "null"
          ]
        },
        "sell_notional": {
          "title": "Sell Notional",
          "description": "USD notional where the taker SOLD (HL side A)",
          "type": [
            "number",
            "null"
          ]
        },
        "n_trades": {
          "title": "N Trades",
          "type": [
            "integer",
            "null"
          ]
        },
        "vwap": {
          "title": "Vwap",
          "description": "Notional-weighted price for the minute",
          "type": [
            "number",
            "null"
          ]
        },
        "max_fill_usd": {
          "title": "Max Fill Usd",
          "description": "Largest single fill, USD",
          "type": [
            "number",
            "null"
          ]
        },
        "large_fill_share": {
          "title": "Large Fill Share",
          "description": "Share (0..1) of notional from fills >= large_fill_usd; null when none",
          "type": [
            "number",
            "null"
          ]
        },
        "partial": {
          "type": "boolean",
          "title": "Partial",
          "description": "True when our socket did not cover the whole minute"
        },
        "cvd_usd": {
          "title": "Cvd Usd",
          "description": "Running buy-minus-sell notional from window_start (served only)",
          "type": [
            "number",
            "null"
          ]
        }
      },
      "type": "object",
      "required": [
        "time",
        "coin",
        "buy_notional",
        "sell_notional",
        "n_trades",
        "vwap",
        "max_fill_usd",
        "large_fill_share",
        "partial"
      ],
      "title": "HLTradeFlowBucket",
      "description": "One closed UTC minute of taker flow for one perp.\n\nEvery numeric field is ``null`` (and ``partial`` is true) for a minute the\nstream did not watch; a watched minute with no fills is all zeros with\n``vwap`` / ``large_fill_share`` null."
    },
    "HLTradeFlowStream": {
      "properties": {
        "connected": {
          "type": "boolean",
          "title": "Connected"
        },
        "connected_since": {
          "title": "Connected Since",
          "description": "unix ms, or null when disconnected",
          "type": [
            "integer",
            "null"
          ]
        },
        "coverage_pct": {
          "type": "number",
          "title": "Coverage Pct",
          "description": "Share (0..100) of the last 60 minutes fully watched"
        }
      },
      "type": "object",
      "required": [
        "connected",
        "connected_since",
        "coverage_pct"
      ],
      "title": "HLTradeFlowStream"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cryptodataapi-com-hltrade-flow-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.