πŸ‘₯Cohorts

The Segments & Cohorts endpoints provide analytics on grouped wallet and position data. These allow for aggregating statistics across defined user or asset segments, viewing segment composition, and analyzing performance by cohort.

circle-check

Get Cohorts

/api/external/segments

Returns every segment (cohort) that exists in the system along with the rules that define them. Each cohort includes its ID, name, category, and the criteria used to classify wallets or positions, such as size or PnL ranges. It only provides the segment definitions themselves, not the wallets inside them.

Request Examples

Response

200 Success: Returns a list of available segments and their metadata.

chevron-rightResponse Examplehashtag

circle-check

Get Cohort Summary

/api/external/segments/{segmentId}/summary

Returns metadata and aggregate statistics for a specific trader segment (cohort). The response includes the cohort definition (name, category, emoji, and criteria thresholds), a snapshot summary of currently open perpetual positions for traders in that cohort, and the top 10 open perp assets by activity/value. It also includes the current trader count in the cohort and the trader count from 24 hours ago for quick comparison. Use the optional positionAge filter to scope the summary to wallets that opened at least one position within the selected timeframe. See Position Age Filterarrow-up-right for details on how wallet eligibility works.

chevron-rightPath Parametershashtag
Parameter
Type
Description

segmentId

string

The unique identifier of the cohort. See Legend.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

positionAge

string

Filters the summary to wallets that have opened at least one position within the selected timeframe. Default: all. Available values: all, 24h, 7d, 30d.

Request Examples

Response

200 Success: Returns the requested segment profile and aggregated open perp statistics.

chevron-rightResponse Examplehashtag

circle-check

Get All Positions by Cohort (Opened/Closed)

/api/external/positions

Provides a complete historical record of every perpetual position opened or closed on Hyperliquid since April 4, 2025. Each entry includes the venue, symbol, size, cohort and direction, alongside full metrics for valuation and risk-checking like entry price, mark/mid pricing, leverage limits, and margin configuration.

Results also detail accumulated funding, unrealized PnL, and specific lifecycle timestamps where a null closeTime indicates an active position. Liquidation prices were only recorded at closure from April 4 to September 2, 2025, but have updated continuously at each block interval since then. Data for all requested addresses is paginated using the nextCursor field.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

number

Maximum number of positions to return per request.

coin

string

Coin symbol to filter by (for example ETH, BTC, LINEA). If omitted, positions for all coins are returned.

nextCursor

string

Cursor for pagination. Use the nextCursor value from the previous response to fetch the next page.

address

string

One or more wallet addresses to include.

start

string

Start of the time window (ISO 8601, UTC).

end

string

End of the time window (ISO 8601, UTC). If omitted, the API uses β€œnow”.

open

boolean

Filter by position status. true returns only open positions, false returns only closed positions. If omitted, both are returned.

segmentId

number

Filter positions by trader segment (cohort). Available values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16. See Cohorts Legendarrow-up-right.

Request Examples

Response

200 Success: Returns a list of positions that match the provided filters. Pagination is supported via nextCursor.

chevron-rightResponse Examplehashtag

circle-check

Get Cohort Bias History

/api/external/segments/{segmentId}/bias-history

Returns a timestamped history of bias and exposure analytics for a single segment (cohort) over a defined time window. Each snapshot captures how the cohort was leaning at that point in time, including bias score, exposure ratio, open value, and active perp equity. Results are paginated using nextCursor and can be filtered by position recency timeframe.

chevron-rightPath Parametershashtag
Parameter
Type
Description

segmentId

number

The unique identifier of the cohort. See Legend.arrow-up-right

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

number

Maximum number of positions to return per request.

nextCursor

string

Cursor for pagination. Use the nextCursor value from the previous response to fetch the next page.

start

string

Start of the time window (ISO 8601, UTC).

end

string

End of the time window (ISO 8601, UTC). If omitted, the API uses β€œnow”.

positionRecencyTimeframe

string

Filters qualifying wallets by position recency. Default: all. Available values: 24h, 7d, 30d, all.

Request Examples

Response

200 Success: Returns timestamped bias and exposure snapshots for the requested segment over the specified time window.

chevron-rightReponse Examplehashtag

circle-check

Get Position Breakdown by Cohort (Download File)

/api/external/exports/coins/{coin}/position-breakdown-by-cohort

Exports position breakdown by cohort for the selected coin, returning cohort-level metrics such as segment details, total position value, long position value, position count, value close to liquidation, bias, timestamp, and past comparison values.

The download link expires quickly (about 120 seconds), so it should be used shortly after it is returned.

Also found on the Positions & Market Exposure subpage here and the Downloadable Files subpage here.

chevron-rightPath Parametershashtag
Parameter
Type
Description

coin

string

Coin symbol (case-insensitive), for example BTC, ETH.

Request Examples

Response

200 Success: Redirects to a temporary pre-signed S3 URL for the requested export file.

chevron-rightResponse Examplehashtag

circle-check

Get Cohort Metrics (Download File)

/api/external/exports/coins/{coin}/segment-metrics

Exports cohort metrics for the selected coin, returning metrics grouped by segment, with each segment including its metadata and timestamped values for position count, long position count, total position value, long position value, and bias. Each metrics object includes a columns array that defines the order of values in data for easy parsing and analysis.

The download link expires quickly (about 120 seconds), so it should be used shortly after it is returned.

Also found on the Downloadable Files subpage here.

chevron-rightPath Parametershashtag
Parameter
Type
Description

coin

string

Coin symbol (case-insensitive), for example BTC, ETH.

Request Examples

Response

200 Success: Redirects to a temporary pre-signed S3 URL for the requested export file.

chevron-rightResponse Examplehashtag

circle-check

Get Position Metrics by Coin and Segment (Cohort)

/api/external/position-metrics/coin/{coin}/segment/{segment}

Retrieves time-series position metrics for a specific coin within a specific segment (cohort) over a given time window. Use it to analyze how positioning and exposure for one cohort evolves on a single market, and paginate through longer ranges with nextCursor.

Also found on the Positions & Market Exposure subpage here.

chevron-rightPath Parametershashtag
Parameter
Type
Description

coin

number

Coin ticker (for example BTC, ETH).

segment

number

Segment (cohort) key (path). Allowed values: 1 through 16. See Legend.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

number

Maximum number of metric rows to return in one response.

nextCursor

string

Cursor for pagination. Pass the value from the previous response to fetch the next page.

start

string

Start of the time window (ISO8601).

end

string

End of the time window (ISO8601).

Request Examples

Response

200 Success: Returns an array of position metric rows plus nextCursor when more results are available.

chevron-rightResponse Examplehashtag

circle-check

Get Positions Heatmap

/api/external/positions/heatmap

Retrieves a heatmap style overview of open positions across all coins and trader segments (cohorts). This gives you a quick visual snapshot of where different trader groups are positioned, how much value they hold, and whether they are leaning long or short across the market.

Also found on the Positions & Market Exposure subpage here.

Positions Heatmap from app.coinmarketman.com/hypertracker/heatmap

chevron-rightQuery Parametershashtag
Parameter
Type
Description

openedWithin

string

Data aggregation period (24h/7d/30d/All).

Request Examples

Response

200 Success: Returns an aggregated positional heatmap across coins and segments.

chevron-rightResponse Examplehashtag

circle-check

Get Liquidation Risk by Asset

api/external/{segmentId}/assets/liquidation-risk

Retrieves the percentage of open interest at high liquidation risk for each asset within a given segment (cohort). It shows how much of the total exposure is close to being liquidated. For example: If BTC has $1,000,000 in total open interest and $100,000 of that is within 75% of the liquidation threshold, then the liquidation risk by asset for XYZ is 10%.

The endpoint can return up to 500 results per request. Lower limits usually result in faster response times.

Also found on Positions & Market Exposure subpage here

circle-info

Understanding Liquidation Risk Liquidation risk indicates how close positions are to being liquidated. This data is crucial for monitoring market health and identifying potential cascading liquidation scenarios.

chevron-rightPath Parametershashtag
Parameter
Type
Description

segmentId [required]

number

The cohort ID to analyze liquidation risk for. See Legend.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

offset

number

The number of items to skip

limit

number

The maximum number of items to return

Request Examples

Response

200 Success: Returns liquidation risk data by asset

chevron-rightResponse Examplehashtag

circle-check

Get Cohort Bias (Download File)

/api/external/exports/segments-bias-charts-data-24h

Returns a 302 redirect to a short-lived download link so you can fetch an export file directly from S3. The export includes segment bias chart data over time (showing whether a segment is leaning more long or short at each timestamp). The columns field tells you what each value in the data rows represents, so the file can be used easily in charts or reports. The download link expires quickly (about 120 seconds), so it should be used shortly after it is returned.

The download link expires quickly (about 120 seconds), so it should be used shortly after it is returned.

Also found on the Downloadable Files subpage here.

Request Examples

Response

200 Success: Redirects to a temporary pre-signed S3 URL for the requested export file.

chevron-rightResponse Examplehashtag

Last updated