MCP Server

Hyperliquid Market Data — OHLCV, Funding Rates & Positioning (Tessera)

dev.tesseralytics/hyperliquid-data

What this MCP does

Provides Hyperliquid perpetual-market data including OHLCV, funding, open interest, positioning, live metrics, cross-sectional rankings, screening, and time series.

describe_dataset
The full dictionary for ONE downloadable dataset: description plus every column's type, nullability and plain-English meaning. Pass a name from list_datasets. Open — no key needed. For the fields the query tools accept, use list_fields.
Input schema
{'type': 'object', 'title': 'DatasetArg', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['asset'], 'properties': {'asset': {'type': 'string', 'description': 'Dataset name, as returned by `list_datasets`.'}}, 'description': "Which dataset's dictionary to return."}
Output schema
{'type': 'object', '$defs': {'Temporal': {'type': 'object', 'required': ['grain', 'timestamp_field', 'label', 'convention'], 'properties': {'grain': {'type': 'string', 'description': 'Observation width, e.g. `1m`, `1h`, `1d`, `1mo`.'}, 'label': {'type': 'string', 'description': 'What the label marks: one of `interval_start`, `interval_end`,\n`snapshot`, `forecast_target`.'}, 'convention': {'type': 'string', 'description': 'One-paragraph plain-English join / look-ahead contract.'}, 'timestamp_field': {'type': 'string', 'description': 'Which column carries the label, e.g. `time`, `day`, `month_start`.'}}, 'description': "The dataset's temporal contract â\x80\x94 what the timestamp column marks and the\nlook-ahead-safety rules for joining. Mirror of the resolver's `temporal`\nblock (`semantic/__init__.py`)."}, 'ColumnDoc': {'type': 'object', 'required': ['name', 'type', 'nullable', 'meaning'], 'properties': {'name': {'type': 'string', 'description': 'Column name.'}, 'type': {'type': 'string', 'description': 'Arrow type string, e.g. `float64`, `timestamp[us]`.'}, 'meaning': {'type': 'string', 'description': "Plain-English meaning â\x80\x94 *what* the column is and why it's useful."}, 'nullable': {'type': 'boolean', 'description': 'Whether the column may be null.'}, 'description': {'type': 'string', 'nullable': True, 'description': 'Technical description â\x80\x94 *how* the column is computed. May be absent.'}}, 'description': "One column's dictionary entry: the engineering facts (type/nullability/how\nit's computed) plus the plain-English `meaning` (what it is and why you'd care)."}, 'ColumnGroup': {'type': 'object', 'required': ['columns'], 'properties': {'label': {'type': 'string', 'nullable': True, 'description': 'Section heading, or `null` for a single unlabelled group.'}, 'window': {'type': 'string', 'default': None, 'nullable': True, 'description': "Temporal window of this group's fields relative to the timestamp label:\none of `point_in_time`, `backward`, `forward`, `contemporaneous`,\n`static`. Null when the dataset-level `temporal.convention` covers them."}, 'columns': {'type': 'array', 'items': {'$ref': '#/$defs/ColumnDoc'}}, 'meaning': {'type': 'string', 'nullable': True, 'description': 'Group-level plain-English meaning, used for large column families (e.g.\nthe residualized factor backbone) where a per-column line adds no value.'}}, 'description': 'A labelled section of columns within a dataset.'}}, 'title': 'DatasetDoc', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['name', 'title', 'category', 'cadence', 'summary', 'description', 'tier', 'column_count', 'column_groups'], 'properties': {'name': {'type': 'string', 'description': 'Dataset name, exactly as `list_datasets` reports it.'}, 'note': {'type': 'string', 'nullable': True, 'description': 'Optional "how to use this" callout.'}, 'tier': {'type': 'string', 'description': 'Display tier: `free` or `pro`. Re-derived from `policy.rs` on read, so it\nalways matches actual entitlement regardless of the on-disk value.'}, 'title': {'type': 'string', 'description': 'Human-friendly title, e.g. "Order-flow OHLCV (1-minute)".'}, 'cadence': {'type': 'string', 'description': 'How frequently the data is sampled, e.g. "1-minute bars".'}, 'summary': {'type': 'string', 'description': 'One-line intuitive summary â\x80\x94 the catalog card.'}, 'category': {'type': 'string', 'description': 'Presentation category, e.g. `raw-tiles` or `forecast-layer`.'}, 'keywords': {'type': 'array', 'items': {'type': 'string'}, 'default': [], 'description': 'Per-dataset discovery keywords (schema.org keywords on the web).'}, 'temporal': {'$ref': '#/$defs/Temporal', 'default': {'grain': '', 'label': '', 'convention': '', 'timestamp_field': ''}, 'description': 'Machine-readable timestamp/interval contract: what the label marks and\nhow to join without leaking the future. Defaulted so snapshots predating\nthe field still deserialize.'}, 'use_case': {'type': 'string', 'default': '', 'description': 'One-line "what you\'d use it for" (buyer-intent) copy.'}, 'seo_title': {'type': 'string', 'default': '', 'description': 'Keyword-first SEO title tag (web `<title>`). Defaulted so older snapshots\nwithout the field still deserialize.'}, 'description': {'type': 'string', 'description': 'Longer prose â\x80\x94 the dictionary page header.'}, 'column_count': {'type': 'integer', 'format': 'uint', 'minimum': 0, 'description': 'Number of documented columns.'}, 'column_groups': {'type': 'array', 'items': {'$ref': '#/$defs/ColumnGroup'}, 'description': 'Columns, grouped for presentation, in schema order.'}, 'direct_answer': {'type': 'string', 'default': '', 'description': '40-60 word keyword-first lead answer â\x80\x94 the definitional "what is this"\nblurb, and the strongest AI-citation extraction target. Defaulted for\nforward/backward compatibility with snapshots predating the field.'}}, 'description': "One dataset's catalog entry + full data dictionary."}
funding_divergence
Rank markets by how far their funding has diverged from a benchmark (default ETH) over a trailing window. Pick bar (1d, the default, or 1h on a Pro key) to read completed days or completed hours. metric=rate compares mean funding over the window; metric=cum_funding_spread compares funding accumulated over the window. Returns the most diverged in each direction. Markets with no funding reading are excluded from both lists. Descriptive only.
Input schema
{'type': 'object', 'title': 'DivergenceArgs', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'bar': {'type': 'string', 'default': None, 'nullable': True, 'description': '`1d` (the default) for completed UTC days, `1h` for the most recent\ncompleted UTC hour.'}, 'coins': {'type': 'array', 'items': {'type': 'string'}, 'default': None, 'nullable': True, 'description': 'Restrict to these markets.'}, 'scope': {'type': 'string', 'default': None, 'nullable': True, 'description': '`crypto` (the default), `hip3`, or `all`.'}, 'top_n': {'type': 'integer', 'format': 'uint', 'default': None, 'minimum': 0, 'nullable': True, 'description': 'Markets per ranked list, 1..50. Defaults to 10.'}, 'metric': {'type': 'string', 'default': None, 'nullable': True, 'description': "`rate` (the default) ranks each market's mean funding over the window\nminus the benchmark's; `cum_funding_spread` ranks funding accumulated\nover the window, high minus low, minus the benchmark's."}, 'benchmark': {'type': 'string', 'default': None, 'nullable': True, 'description': 'The market whose funding is the yardstick. Defaults to ETH.'}, 'window_days': {'type': 'integer', 'format': 'uint', 'default': None, 'minimum': 0, 'nullable': True, 'description': 'Length of the trailing window in days, 1..365. Defaults to 7.'}}}
Output schema
{'type': 'object', '$defs': {'DivergenceRow': {'type': 'object', 'required': ['coin', 'value', 'divergence'], 'properties': {'coin': {'type': 'string'}, 'value': {'type': 'number', 'format': 'double', 'description': "This market's value for the requested metric over the window."}, 'divergence': {'type': 'number', 'format': 'double', 'description': "`value` minus the benchmark's."}}, 'description': "One market's funding divergence from the benchmark."}}, 'title': 'DivergenceResult', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['bar', 'source', 'as_of', 'scope', 'visible_count', 'eligible_count', 'matched_count', 'metric', 'benchmark', 'window_days', 'benchmark_value', 'top_positive', 'top_negative', 'truncated', 'notes'], 'properties': {'bar': {'type': 'string', 'description': 'The grain this answer was computed at: `1d` or `1h`.'}, 'as_of': {'type': 'string'}, 'notes': {'type': 'array', 'items': {'type': 'string'}}, 'scope': {'type': 'string'}, 'metric': {'type': 'string'}, 'source': {'type': 'string'}, 'benchmark': {'type': 'string'}, 'truncated': {'type': 'boolean'}, 'window_days': {'type': 'integer', 'format': 'uint', 'minimum': 0}, 'top_negative': {'type': 'array', 'items': {'$ref': '#/$defs/DivergenceRow'}, 'description': "The largest divergences toward the benchmark's opposite, most extreme\nfirst."}, 'top_positive': {'type': 'array', 'items': {'$ref': '#/$defs/DivergenceRow'}, 'description': 'The largest divergences away from the benchmark, most extreme first.'}, 'matched_count': {'type': 'integer', 'format': 'int64', 'description': 'Markets that had a funding reading in the window. Markets without one are\nexcluded from both lists and from this count â\x80\x94 a missing reading must\nnever appear as an extreme.'}, 'visible_count': {'type': 'integer', 'format': 'int64', 'description': "Markets in your plan's slice on this interval, before any filter you\npassed."}, 'eligible_count': {'type': 'integer', 'format': 'int64', 'description': 'Markets left after your explicit market filter.'}, 'benchmark_value': {'type': 'number', 'format': 'double', 'description': "The benchmark's own value for the metric."}}}
get_universe
The coverage picture: the last complete interval, how many markets are in the universe for a scope, how much history sits behind them, and how densely it is populated. Pick bar (1d, the default, or 1h on a Pro key) to describe completed days or completed hours. A compact SUMMARY by default — pass top_n (1..50) only if you need the per-market counts.
Input schema
{'type': 'object', 'title': 'UniverseArgs', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'bar': {'type': 'string', 'default': None, 'nullable': True, 'description': '`1d` (the default) for completed UTC days, `1h` for the most recent\ncompleted UTC hour.'}, 'day': {'type': 'string', 'default': None, 'nullable': True, 'description': 'The day or hour to describe: `YYYY-MM-DD` or `latest` at `bar: 1d`, a\ncompleted `YYYY-MM-DDTHH:00:00Z` or `latest` at `bar: 1h`.'}, 'scope': {'type': 'string', 'default': None, 'nullable': True, 'description': '`crypto` (the default), `hip3`, or `all`.'}, 'top_n': {'type': 'integer', 'format': 'uint', 'default': None, 'minimum': 0, 'nullable': True, 'description': 'Per-market detail is off by default; passing a value (1..50) returns\nthat many markets, listed by name, alongside the summary.'}}}
Output schema
{'type': 'object', '$defs': {'UniverseCoin': {'type': 'object', 'required': ['coin', 'observations'], 'properties': {'coin': {'type': 'string'}, 'observations': {'type': 'integer', 'format': 'int64', 'description': 'How many intervals of the range this market appears on â\x80\x94 days at\n`bar: 1d`, completed hours at `bar: 1h`.'}}, 'description': "One market's coverage within the described range."}}, 'title': 'UniverseResult', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['bar', 'source', 'as_of', 'scope', 'interval_start', 'interval_end', 'interval_count', 'months_covered', 'visible_count', 'eligible_count', 'matched_count', 'market_count_total', 'market_count_crypto', 'market_count_hip3', 'row_count', 'rows_per_market_interval', 'coverage_from_manifest', 'truncated', 'notes'], 'properties': {'bar': {'type': 'string', 'description': 'The grain this answer was computed at: `1d` or `1h`.'}, 'as_of': {'type': 'string', 'description': 'The interval the per-population counts describe.'}, 'coins': {'type': 'array', 'items': {'$ref': '#/$defs/UniverseCoin'}, 'nullable': True, 'description': 'Per-market detail, only when requested. Markets are listed by name.'}, 'notes': {'type': 'array', 'items': {'type': 'string'}}, 'scope': {'type': 'string'}, 'source': {'type': 'string'}, 'row_count': {'type': 'integer', 'format': 'int64', 'description': 'Rows in scope over the whole range.'}, 'truncated': {'type': 'boolean', 'description': 'True when more markets exist than the detail list returned.'}, 'interval_end': {'type': 'string', 'description': 'The newest complete interval â\x80\x94 the one `latest` resolves to.'}, 'matched_count': {'type': 'integer', 'format': 'int64', 'description': 'Markets the range actually represents â\x80\x94 the ones with at least one row in\nit, which is every market in `eligible_count` at the described interval.'}, 'visible_count': {'type': 'integer', 'format': 'int64', 'description': "Markets in your plan's slice on the described interval, before any scope\nclass is applied."}, 'eligible_count': {'type': 'integer', 'format': 'int64', 'description': 'Distinct markets in scope over the whole range.'}, 'interval_count': {'type': 'integer', 'format': 'int64', 'description': 'Distinct intervals in the range.'}, 'interval_start': {'type': 'string', 'description': "The oldest interval the counts below cover: the published range start, or\nthe caller's history floor when the plan clips it (the response says so\nin `notes`)."}, 'months_covered': {'type': 'integer', 'format': 'int64'}, 'market_count_hip3': {'type': 'integer', 'format': 'int64', 'description': 'Markets with a deployer prefix on the described interval.'}, 'market_count_total': {'type': 'integer', 'format': 'int64', 'description': 'Distinct markets in scope over the whole range.'}, 'market_count_crypto': {'type': 'integer', 'format': 'int64', 'description': 'Markets without a deployer prefix on the described interval, whatever\nscope was asked for.'}, 'coverage_from_manifest': {'type': 'boolean', 'description': 'True when the interval range came from the published coverage manifest,\nfalse when it had to be read from the data or the object listing itself.'}, 'rows_per_market_interval': {'type': 'number', 'format': 'double', 'description': '`row_count` divided by (intervals Ã\x97 markets) â\x80\x94 how densely the range is\npopulated. Below 1.0 means some markets are missing some intervals.'}}}
list_datasets
List the downloadable datasets: one-line summary, the plan required, and the month range available. Open — no key needed. Then use describe_dataset for one dataset's columns, or list_fields for the fields the query tools accept.
Input schema
{'type': 'object', 'properties': {}}
Output schema
{'type': 'object', '$defs': {'CatalogEntry': {'type': 'object', 'required': ['name', 'title', 'category', 'cadence', 'summary', 'tier', 'column_count'], 'properties': {'name': {'type': 'string'}, 'tier': {'type': 'string', 'description': "`free` or `pro` â\x80\x94 the plan required to read this dataset's data."}, 'title': {'type': 'string'}, 'months': {'type': 'array', 'items': {'type': 'string'}, 'nullable': True, 'description': 'The published month range, `[earliest, latest]`. Absent when the catalog\nlists no months for it.'}, 'cadence': {'type': 'string'}, 'summary': {'type': 'string'}, 'category': {'type': 'string'}, 'column_count': {'type': 'integer', 'format': 'uint', 'minimum': 0}}, 'description': 'One dataset in the public catalog.'}}, 'title': 'DatasetsResult', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['your_tier', 'generated_at', 'datasets'], 'properties': {'datasets': {'type': 'array', 'items': {'$ref': '#/$defs/CatalogEntry'}}, 'your_tier': {'type': 'string', 'description': "The caller's own plan (`free`, `pro` or `anonymous`)."}, 'generated_at': {'type': 'string', 'description': 'When this catalog was produced.'}}}
list_fields
Every field the query tools accept, each with its meaning, unit, whether it can be missing, and which bars (1d, 1h) it exists on. Open — no key needed. Call this before query_cross_section, screen_universe or query_series. Percentile, z-score and the top_pct/bottom_pct conditions rank within the markets your plan can see, so they need a wide slice.
Input schema
{'type': 'object', 'properties': {}}
Output schema
{'type': 'object', '$defs': {'FieldDoc': {'type': 'object', 'required': ['name', 'meaning', 'unit', 'nullable', 'kind', 'grains'], 'properties': {'kind': {'type': 'string', 'description': "`stored` (a column in the plane's own source) or `factor` (computed at\nquery time over a trailing window, or from the selected end row)."}, 'name': {'type': 'string'}, 'type': {'type': 'string', 'nullable': True, 'description': "The stored column's type (`float64`, `uint32`, `date32`, â\x80¦); absent for\nquery-time factors, which are always floats."}, 'unit': {'type': 'string', 'description': 'The unit the values actually carry (`usd_notional`, `base_units`,\n`ratio`, `fraction`, `count`, `date`, â\x80¦). A stored column name is never a\nsynonym for its unit â\x80\x94 the OI a caller sees is USD notional where the\ncolumn is named for the notion.'}, 'grains': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Plane grains on which this field is available, in canonical order.'}, 'meaning': {'type': 'string', 'description': 'Plain-English meaning, authored in the semantic layer.'}, 'nullable': {'type': 'boolean', 'description': 'Whether the value can be absent for a market on a selected interval.'}}, 'description': "One addressable field's documentation.\n\nServed verbatim by the MCP plane's `list_fields`; the schema derive is what\nkeeps the tool's advertised output shape and the served JSON the same thing."}}, 'title': 'FieldsResult', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['generated_at', 'fields', 'notes'], 'properties': {'notes': {'type': 'array', 'items': {'type': 'string'}}, 'fields': {'type': 'array', 'items': {'$ref': '#/$defs/FieldDoc'}, 'description': 'Every field the query tools accept.'}, 'generated_at': {'type': 'string', 'description': 'When this vocabulary was produced.'}}}
live_market
What is happening right now: mark price, current hourly funding, open interest, 24-hour traded notional and premium for up to 25 markets, taken straight from the venue's public API and stamped with the moment it was read. Use this for 'now' questions; the bar=1d and bar=1h tools answer completed intervals only.
Input schema
{'type': 'object', 'title': 'LiveMarketArgs', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['coins'], 'properties': {'coins': {'type': 'array', 'items': {'type': 'string'}, 'description': 'The markets to snapshot, 1..25.'}}}
Output schema
{'type': 'object', '$defs': {'LiveMarketRow': {'type': 'object', 'required': ['coin'], 'properties': {'coin': {'type': 'string'}, 'mid_px': {'type': 'number', 'format': 'double', 'nullable': True}, 'oi_usd': {'type': 'number', 'format': 'double', 'nullable': True, 'description': '`open_interest * mark_px` when both are present.'}, 'mark_px': {'type': 'number', 'format': 'double', 'nullable': True}, 'premium': {'type': 'number', 'format': 'double', 'nullable': True}, 'oracle_px': {'type': 'number', 'format': 'double', 'nullable': True}, 'funding_rate': {'type': 'number', 'format': 'double', 'nullable': True, 'description': 'Current hourly funding rate.'}, 'open_interest': {'type': 'number', 'format': 'double', 'nullable': True, 'description': 'Open interest in base units, as reported upstream.'}, 'day_volume_usd': {'type': 'number', 'format': 'double', 'nullable': True}}, 'description': 'Snapshot of one market, as of the upstream fetch.'}}, 'title': 'LiveMarketResult', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['source', 'as_of', 'coin_count', 'rows', 'notes'], 'properties': {'rows': {'type': 'array', 'items': {'$ref': '#/$defs/LiveMarketRow'}}, 'as_of': {'type': 'string', 'description': 'When the snapshot was taken, UTC.'}, 'notes': {'type': 'array', 'items': {'type': 'string'}}, 'source': {'type': 'string', 'description': '`hyperliquid_rest` â\x80\x94 this is the live market, not the completed-day data.'}, 'coin_count': {'type': 'integer', 'format': 'uint', 'minimum': 0}}}
query_cross_section
Rank the whole market on ONE completed interval: pick bar (1d, the default, or 1h on a Pro key), columns, an order_by field and top_n. Answers 'top markets by funding / open interest / returns on the latest day or hour' and 'what percentile is BTC on open interest'. day defaults to the last complete interval; scope defaults to crypto (HIP-3 markets track an underlying that closes, so their flow is not comparable); stat=percentile|zscore ranks within your eligible markets; window_days recomputes the trailing-window fields; min_usd_volume_7d_avg keeps dust out of the ranking and the ranking is computed after it. Field names come from list_fields — never guess them, they are snake_case compound names and each one lists the bars it exists on; for a cut ('top decile by X') use screen_universe.
Input schema
{'type': 'object', 'title': 'CrossSectionArgs', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'bar': {'type': 'string', 'default': None, 'nullable': True, 'description': '`1d` (the default) for completed UTC days, `1h` for the most recent\ncompleted UTC hour.'}, 'day': {'type': 'string', 'default': None, 'nullable': True, 'description': 'The day or hour to rank. For `bar: 1d`, `YYYY-MM-DD` or `latest` (the\ndefault: the most recent complete day). For `bar: 1h`, a completed hour\nas `YYYY-MM-DDTHH:00:00Z`, or `latest`.'}, 'stat': {'type': 'string', 'default': None, 'nullable': True, 'description': '`raw` (the default), `percentile`, or `zscore`. Percentile and z-score\nare ranked **within the markets your plan can see**, so they need a\nslice of at least four markets.'}, 'coins': {'type': 'array', 'items': {'type': 'string'}, 'default': None, 'nullable': True, 'description': "Restrict to these markets. A market outside your plan's coverage is\nignored rather than widening the answer."}, 'scope': {'type': 'string', 'default': None, 'nullable': True, 'description': '`crypto` (the default), `hip3`, or `all`. Restricted markets track an\nunderlying that closes, so their flow is not comparable on a weekend.'}, 'top_n': {'type': 'integer', 'format': 'uint', 'default': None, 'minimum': 0, 'nullable': True, 'description': 'How many markets to return, 1..50. Defaults to 20.'}, 'columns': {'type': 'array', 'items': {'type': 'string'}, 'default': None, 'nullable': True, 'description': "Fields to return per market, from `list_fields`. `coin` is always\nincluded. Defaults to price, traded notional and the interval's return."}, 'order_by': {'type': 'string', 'default': None, 'nullable': True, 'description': "The field to rank by. Need not appear in `columns`. Defaults to the\ninterval's traded notional."}, 'descending': {'type': 'boolean', 'default': None, 'nullable': True, 'description': 'Rank largest first (the default). Set false for the smallest.'}, 'window_days': {'type': 'integer', 'format': 'uint', 'default': None, 'minimum': 0, 'nullable': True, 'description': 'Recompute the trailing-window fields over this many days, 1..365\n(default 7). The response always states the window it used.'}, 'min_usd_volume_7d_avg': {'type': 'number', 'format': 'double', 'default': None, 'nullable': True, 'description': 'Drop markets whose average daily traded notional over the window is\nbelow this value, so dust cannot top a ranking.'}}}
Output schema
{'type': 'object', 'title': 'CrossSectionResult', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['bar', 'source', 'as_of', 'scope', 'visible_count', 'eligible_count', 'matched_count', 'row_count', 'truncated', 'stat', 'rows', 'notes'], 'properties': {'bar': {'type': 'string', 'description': 'The grain this answer was computed at: `1d` or `1h`.'}, 'rows': {'type': 'array', 'items': True}, 'stat': {'type': 'string', 'description': 'The ranking treatment actually applied: `raw`, `percentile` or\n`zscore`.'}, 'as_of': {'type': 'string', 'description': 'The UTC day (`YYYY-MM-DD`) or completed hour (`YYYY-MM-DDTHH:00:00Z`) the\nanswer describes.'}, 'notes': {'type': 'array', 'items': {'type': 'string'}}, 'scope': {'type': 'string', 'description': 'The market population the ranking ran over.'}, 'source': {'type': 'string', 'description': '`tessera_daily` or `tessera_hourly` â\x80\x94 the clock this answer came from,\nnever the live market.'}, 'row_count': {'type': 'integer', 'format': 'uint', 'minimum': 0, 'description': 'How many markets are in `rows`.'}, 'truncated': {'type': 'boolean', 'description': 'True when `matched_count` exceeds `row_count`.'}, 'matched_count': {'type': 'integer', 'format': 'int64', 'description': 'Markets that reported the ranked field and passed every filter. This is\nthe count the rows are drawn from.'}, 'visible_count': {'type': 'integer', 'format': 'int64', 'description': "Markets in your plan's slice with a row on this interval, before any\nfilter you passed. This is the universe the answer is a statement about."}, 'eligible_count': {'type': 'integer', 'format': 'int64', 'description': 'Markets left after your explicit market filter and any traded-notional\nfloor â\x80\x94 the population the percentile, z-score and deciles were computed\nover.'}}}
query_series
The series for one market or a few (max 10): one row per market per interval over a trailing window, oldest first. Pick bar (1d, the default, for one row per day, or 1h on a Pro key for one row per completed hour). Answers 'is this move backed by real flow' and 'how has positioning built up'. ending_day defaults to the last complete interval. The whole answer is capped, so markets times window_days (times 24 at bar 1h) must stay inside the row cap; the response states the window it used.
Input schema
{'type': 'object', 'title': 'SeriesArgs', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['coins'], 'properties': {'bar': {'type': 'string', 'default': None, 'nullable': True, 'description': '`1d` (the default) for completed UTC days, `1h` for completed UTC hours.'}, 'coins': {'type': 'array', 'items': {'type': 'string'}, 'description': 'The markets to return, 1..10.'}, 'scope': {'type': 'string', 'default': None, 'nullable': True, 'description': '`crypto` (the default), `hip3`, or `all`.'}, 'columns': {'type': 'array', 'items': {'type': 'string'}, 'default': None, 'nullable': True, 'description': 'Fields to return per row, from `list_fields`. The interval column\n(`day` at 1d, `hour` at 1h) and `coin` are always included.'}, 'ending_day': {'type': 'string', 'default': None, 'nullable': True, 'description': 'The last interval to include: `YYYY-MM-DD` or `latest` at `bar: 1d`, a\ncompleted `YYYY-MM-DDTHH:00:00Z` or `latest` at `bar: 1h`.'}, 'window_days': {'type': 'integer', 'format': 'uint', 'default': None, 'minimum': 0, 'nullable': True, 'description': 'Length of the trailing window in days, 1..365. Defaults to 7. At\n`bar: 1h` one window day is 24 hourly rows.'}}}
Output schema
{'type': 'object', 'title': 'SeriesResult', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['bar', 'source', 'as_of', 'scope', 'window_days', 'visible_count', 'eligible_count', 'matched_count', 'row_count', 'truncated', 'rows', 'notes'], 'properties': {'bar': {'type': 'string', 'description': 'The grain this answer was computed at: `1d` or `1h`.'}, 'rows': {'type': 'array', 'items': True}, 'as_of': {'type': 'string', 'description': 'The last interval in the series.'}, 'notes': {'type': 'array', 'items': {'type': 'string'}}, 'scope': {'type': 'string'}, 'source': {'type': 'string'}, 'row_count': {'type': 'integer', 'format': 'uint', 'minimum': 0}, 'truncated': {'type': 'boolean'}, 'window_days': {'type': 'integer', 'format': 'uint', 'minimum': 0, 'description': 'The window the trailing fields were computed over, in days.'}, 'matched_count': {'type': 'integer', 'format': 'int64', 'description': 'How many of the requested markets the series actually has rows for â\x80\x94 less\nthan `eligible_count` when one of them has no data in the window.'}, 'visible_count': {'type': 'integer', 'format': 'int64', 'description': "Markets in your plan's slice with a row on the last interval."}, 'eligible_count': {'type': 'integer', 'format': 'int64', 'description': "The markets you asked for, after the plan's slice and your filter were\nintersected."}}}
screen_universe
Screen the whole market on ONE completed interval with several conditions ANDed together. Pick bar (1d, the default, or 1h on a Pro key; a free key is screened at 1d). Conditions use op >, <, >=, <=, between, top_pct or bottom_pct; top_pct/bottom_pct are deciles of your eligible markets, and the liquidity floor is applied before the deciles so they are measured over the population you are choosing from. Answers 'top-decile funding with bottom-decile open-interest change' and 'open interest rising faster than volume'. A market that does not report a field never satisfies a condition on it.
Input schema
{'type': 'object', '$defs': {'ConditionArg': {'type': 'object', 'required': ['column', 'op', 'value'], 'properties': {'op': {'type': 'string', 'description': 'One of `>`, `<`, `>=`, `<=`, `between`, `top_pct`, `bottom_pct`.\n`top_pct`/`bottom_pct` keep the best/worst `value` percent of the\nmarkets you can see by that field.'}, 'value': {'type': 'number', 'format': 'double', 'description': 'The threshold. For `top_pct`/`bottom_pct` this is a percentage, e.g. 10\nfor the top decile.'}, 'column': {'type': 'string', 'description': 'The field to test, from `list_fields`.'}, 'value2': {'type': 'number', 'format': 'double', 'default': None, 'nullable': True, 'description': 'Required for `between`: the upper bound, inclusive.'}}, 'description': 'One condition of a screen.'}}, 'title': 'ScreenArgs', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['conditions'], 'properties': {'bar': {'type': 'string', 'default': None, 'nullable': True, 'description': '`1d` (the default) for completed UTC days, `1h` for the most recent\ncompleted UTC hour.'}, 'day': {'type': 'string', 'default': None, 'nullable': True, 'description': 'The day or hour to screen: `YYYY-MM-DD` or `latest` at `bar: 1d`, a\ncompleted `YYYY-MM-DDTHH:00:00Z` or `latest` at `bar: 1h`.'}, 'coins': {'type': 'array', 'items': {'type': 'string'}, 'default': None, 'nullable': True, 'description': 'Restrict to these markets.'}, 'scope': {'type': 'string', 'default': None, 'nullable': True, 'description': '`crypto` (the default), `hip3`, or `all`.'}, 'columns': {'type': 'array', 'items': {'type': 'string'}, 'default': None, 'nullable': True, 'description': 'Fields to return per market, from `list_fields`.'}, 'order_by': {'type': 'string', 'default': None, 'nullable': True, 'description': "The field to rank the matches by. Defaults to the interval's traded\nnotional."}, 'conditions': {'type': 'array', 'items': {'$ref': '#/$defs/ConditionArg'}, 'description': 'Conditions, all of which must hold. A market that does not report a\nfield never satisfies a condition on it.'}, 'descending': {'type': 'boolean', 'default': None, 'nullable': True, 'description': 'Rank largest first (the default).'}, 'max_results': {'type': 'integer', 'format': 'uint', 'default': None, 'minimum': 0, 'nullable': True, 'description': 'How many markets to return, 1..50. Defaults to 25.'}, 'min_usd_volume_7d_avg': {'type': 'number', 'format': 'double', 'default': None, 'nullable': True, 'description': 'Drop markets below this average daily traded notional over the window.'}}}
Output schema
{'type': 'object', 'title': 'ScreenResult', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['bar', 'source', 'as_of', 'scope', 'visible_count', 'eligible_count', 'matched_count', 'row_count', 'truncated', 'rows', 'notes'], 'properties': {'bar': {'type': 'string', 'description': 'The grain this answer was computed at: `1d` or `1h`.'}, 'rows': {'type': 'array', 'items': True}, 'as_of': {'type': 'string'}, 'notes': {'type': 'array', 'items': {'type': 'string'}}, 'scope': {'type': 'string'}, 'source': {'type': 'string'}, 'row_count': {'type': 'integer', 'format': 'uint', 'minimum': 0}, 'truncated': {'type': 'boolean'}, 'matched_count': {'type': 'integer', 'format': 'int64', 'description': 'Markets that met every condition.'}, 'visible_count': {'type': 'integer', 'format': 'int64', 'description': "Markets in your plan's slice with a row on this interval, before any\nfilter you passed."}, 'eligible_count': {'type': 'integer', 'format': 'int64', 'description': 'Markets left after your explicit market filter and any\ntraded-notional floor â\x80\x94 the population the percentage conditions were\nmeasured against.'}}}
Changed
screen_universe
Oct. 3, 2026, 2:51 a.m.
Changed
list_fields
Oct. 3, 2026, 2:51 a.m.
Changed
live_market
Oct. 3, 2026, 2:51 a.m.
Changed
funding_divergence
Oct. 3, 2026, 2:51 a.m.
Changed
query_series
Oct. 3, 2026, 2:51 a.m.
Changed
get_universe
Oct. 3, 2026, 2:51 a.m.
Changed
query_cross_section
Oct. 3, 2026, 2:51 a.m.
Changed
get_universe
Sept. 23, 2026, 2:42 a.m.
Changed
query_cross_section
Sept. 21, 2026, 2:49 a.m.
Added
get_universe
Sept. 17, 2026, 12:39 p.m.
Added
query_series
Sept. 17, 2026, 12:39 p.m.
Added
describe_dataset
Sept. 17, 2026, 12:39 p.m.
Added
list_fields
Sept. 17, 2026, 12:39 p.m.
Added
funding_divergence
Sept. 17, 2026, 12:39 p.m.
Added
list_datasets
Sept. 17, 2026, 12:39 p.m.
Added
query_cross_section
Sept. 17, 2026, 12:39 p.m.
Added
live_market
Sept. 17, 2026, 12:39 p.m.
Added
screen_universe
Sept. 17, 2026, 12:39 p.m.