Get Cohort Summary
Get a real-time aggregate snapshot of a HyperTracker cohort's positioning on Hyperliquid. Shows trader count, bias direction, leverage, OI split, and profit metrics. Ideal for: sentiment analysis, cohort tracking, smart money monitoring.
Catalog action Blockchain Data
Get a real-time aggregate snapshot of a HyperTracker cohort's positioning on Hyperliquid. Shows trader count, bias direction, leverage, OI split, and profit metrics. Ideal for: sentiment analysis, cohort tracking, smart money monitoring.
At a Glance
| Field | Value |
|---|---|
| Action ID | hypertracker-get-cohort-summary |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | hypertracker, hyperliquid, cohort, sentiment, analytics, read |
Payload Schema
| Field | Type | Required | Description |
|---|---|---|---|
apiKey | string | No | HyperTracker API key (falls back to HYPERTRACKER_API_KEY env var) |
cohort | string | Yes | Cohort name to query. Size cohorts: shrimp, fish, dolphin, apex predator, small whale, whale, tidal whale, leviathan. PnL cohorts: money printer, smart money, consistent grinder, humble earner, exit liquidity, semi-rekt, full rekt, giga-rekt. |
positionAge | string | No | Filter positions by age window. Defaults to all. |
Result Schema
| Field | Type | Required | Description |
|---|---|---|---|
cohortName | string | Yes | Human-readable cohort name |
cohortId | number | Yes | Numeric segment ID for this cohort |
cohortCategory | string | Yes | Whether this cohort is classified by account size or PnL performance |
traderCount | number | Yes | Total number of traders in this cohort |
tradersInPosition | number | Yes | Number of traders currently holding open positions |
tradersInProfit | number | Yes | Number of traders currently in profit |
inPositionPercent | number | Yes | Percentage of cohort traders that have open positions (0-100) |
perpBias | number | Yes | Net directional bias ratio (positive = bullish, negative = bearish) |
biasLabel | string | Yes | Human-readable bias label: Very Bullish, Bullish, Slightly Bullish, Indecisive, Slightly Bearish, Bearish, Very Bearish |
exposureRatio | number | Yes | Ratio of open notional to equity |
totalPositionValue | number | Yes | Total notional value of all open positions in USD |
longValue | number | Yes | Total notional value of long positions in USD |
shortValue | number | Yes | Total notional value of short positions in USD |
longPositionCount | number | Yes | Count of open long positions |
shortPositionCount | number | Yes | Count of open short positions |
activePerpEquity | number | Yes | Total perp equity of traders currently in position (USD) |
Examples
json{ "type": "hypertracker-get-cohort-summary", "payload": { "cohort": "example-cohort" }, "children": []}
bashcurl -X POST "https://api.b3os.org/v1/actions/hypertracker-get-cohort-summary/test" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "inputs": { "cohort": "example-cohort" }}'
Payload fields can use workflow expressions such as {{$trigger.body.amount}}, {{$nodes.fetch.result.price}}, and {{$props.asset}} when the value should come from a trigger, prior node, or reusable workflow prop.