📖REST API Endpoint Directory

Every HyperTracker REST API endpoint in one place, organized for fast lookup.

This page is a complete index of all REST API endpoints available in the documentation. Use it as a glossary to quickly find an endpoint by topic, object type, or workflow. Each group links to the full reference page where you will find parameters, examples, and response schemas.

Wallets

Everything that is keyed by a wallet address. Use this section when you want to build wallet pages, watchlists, or account management flows.

circle-check

Get Wallets

/external/api/wallets

Retrieves a paginated list of all wallets with flexible filtering and sorting options. You can filter by individual wallet addresses, segment (cohort), open positions, favorites, vault ownership and claimed status, and view key metrics such as perp equity, bias, open value, exposure, and unrealized PnL. Results also include earliest activity, liquidation proximity, display settings, and verification details.

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

chevron-rightQuery Parametershashtag
Parameter
Type
Description

offset

number

The number of items to skip before starting to collect the result set

limit

number

The maximum number of items to return

order

array

Order direction (options: asc/desc, default: desc)

orderBy

string

Field to order results by. Options: address, totalEquity, earliestActivityAt, perpPnl, perpEquity, perpBias, openValue, sumUpnl, closestLiqProgress, countOpenPositions, exposureRatio

segmentIds

array

Filter by specific cohort IDs (e.g., Shrimp, Whale, etc.) See Legend.

hasOpenPositions

boolean

Filter wallets that currently have open positions

address

string

Filter by one or more wallet addresses.

Request Examples

Response

200 Success: Returns paginated wallet list

chevron-rightResponse Examplehashtag

Positions, Exposure, Market Analytics

Position-level state and market-level aggregation that explains who holds what, where risk concentrates, and how exposure shifts over time. Use this to power heatmaps, ranked positions, cohort position summaries, and market-wide analytics views.

Get All Positions (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 Open Position Exposure by Coin

/api/external/positions/coins

Returns a ranked list of all coins currently held in open perpetual positions ordered by total open value descending. Each entry includes the coin ticker, total position value, long and short breakdown, and position counts by side.

Request Examples

Response

200 Success: Returns an array of all coins with open positions on the network, sorted by totalValue descending.

chevron-rightResponse Examplehashtag

circle-check

Get Position Metrics (General)

/api/external/position-metrics/general

Returns time-series snapshots of overall perpetual market positioning across all tracked wallets and coins within a selected time window. Each snapshot includes the total number of open positions, the split between long and short positions, total open interest and its long and short components, total perp equity, and how many positions are currently in profit. Results are returned as a time-ordered series and can be paginated using nextCursor.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

string

Maximum number of metric snapshots 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”.

Request Examples

Response

200 Success: Returns a list of general position metric snapshots for the requested time window, plus an optional cursor for pagination.

chevron-rightResponse Examplehashtag

Get Perp Volume Metrics

/api/external/metrics/perp-volume

Retrieves perpetual volume metrics over a specified time period. Supports pagination via nextCursor and optional limiting of returned items.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

number

Number of positions to return.

nextCursor

string

Cursor for pagination to fetch the next page.

start

string

Start period of time (ISO timestamp).

end

string

End period of time (ISO timestamp).

Request Examples

Response

200 Success: Returns perp volume metrics in JSON format, with a cursor for pagination.

chevron-rightResponse Examplehashtag

circle-check

Get Perpetual Market Overview Metrics

/api/external/position-metrics/general

Returns a time-series of market-wide snapshots powering the Open Interest, Total Open Positions, Open Interest vs Perp Equity, and Positions In Profit charts. Each snapshot includes total open interest with long and short split, total position count with long and short breakdown, total perp equity, and the number of positions currently in profit. Results are paginated using nextCursor.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

number

Maximum number of metric snapshots to return per request.

nextCursor

string

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

start

string

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

end

string

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

Request Examples

Response

200 Success: Returns aggregated position-level metrics.

chevron-rightResponse Examplehashtag

circle-check

Get Coin Positioning, PnL and Funding Over Time

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

Returns a time-series of aggregated perpetual position data for a specific coin. Each snapshot includes open position count, total notional exposure, and position size with long and short breakdowns, plus cumulative unrealized PnL and funding costs across all positions for that coin. Results are paginated using nextCursor.

chevron-rightPath Parametershashtag
Parameter
Type
Description

coin

number

Coin ticker (for example BTC, ETH).

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 (ISO 8601, UTC). If omitted, the API uses “now”.

Request Examples

Response

200 Success: Returns a list of metric snapshots for the requested coin, plus an optional cursor for pagination.

chevron-rightResponse Examplehashtag

circle-check

Get Position Metrics by Coin and Position Size Buckets

/api/external/position-metrics/coin/{coin}/position-size-bucket/{sizeBucketId}

Returns a time-series of position metrics for a specific coin, filtered by position size bucket. Size buckets segment positions from retail (<$1k) through to whale (>$2.5m), allowing granular analysis of how different trader size groups are positioned in a given asset. Each snapshot includes position count and total position value with long and short breakdown. Results are paginated using nextCursor.

chevron-rightPath Parametershashtag
Parameter
Type
Description

coin

string

Coin ticker (for example BTC, ETH).

sizeBucketId

number

Position size bucket key. See bucket definitions below.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

number

Maximum number of metric rows to return in one response.

start

string

Start of the time window (ISO8601).

end

string

End of the time window (ISO8601).

nextCursor

string

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

chevron-rightSize Bucket Referencehashtag
ID
Size Range

1

<$1k

2

$1k - $10k

3

$10k - $25k

4

$25k - $50k

5

$50k - $100k

6

$100k - $250k

7

$250k - $500k

8

$500k - $1m

9

$1m - $2.5m

10

>$2.5m

Request Examples

Response

200 Success: Returns a paginated array of position metric snapshots for the requested coin and size bucket.

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.

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 User Fills

/api/external/fills

Returns trade fills (executions) within a selected time window for the requested filters. Each fill represents a single matched execution and includes the wallet address, traded symbol, execution price and size, side (B buy or A sell), execution timestamp, and position impact (the position before the fill and whether it opened or closed long or short exposure). It also provides execution identifiers (order id and trade id), whether the execution crossed the spread, the transaction hash when available, and all fee attribution including fee amount, fee token, optional builder address, and builder fee.

This endpoint can only be queried one day at a time: end must be within the same calendar day as start. All data fully available from July 2025. TWAPs are listed with the address "0x0000000000000000000000000000000000000000000000000000000000000000".

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

number

Maximum number of metric rows to return in one response.

coin

string

Filter by one or more coin symbols (for example ETH, BTC).

nextCursor

string

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

address

string

Filter by one or more wallet addresses.

builder

string

Filter by one or more builder addresses.

start

string

Start of the time window (ISO8601).

end

string

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

side

string

Filter by fill side. Allowed values: A, B.

Request Examples

Response

200 Success: Returns a list of fills that match the provided filters.

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 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.

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

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

Order Data and Liquidity Intent

Exchange-wide snapshots of open orders captured in rolling 5-minute intervals, designed to analyze liquidity, clustering, and order intent across all markets. Use this to study stop and take-profit density, limit concentration, and how those clusters evolve over time.

circle-check

Get Orders for the Latest Snapshot

/api/external/orders/5m-snapshots/latest

Returns a paginated list of orders captured in the most recent 5-minute snapshot. You can narrow results by market (coin), trader identity (address), a specific order (oid), a time window, and order type. Use nextCursor to fetch subsequent pages.

Currently on a 5-min granularity for all open orders. 1-min granularity coming soon!

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

number

Limit number of results returned. Default value: 100.

nextCursor

string

Pagination cursor returned by the previous response. Provide this to continue fetching the next page of results.

coin

string

Market identifier (coin symbol) to filter orders by, for example BTC.

address

string

Trader account address to filter orders by.

oid

string

Filter by a specific order ID. Useful when you want to retrieve one known order from the snapshot.

start

string

Start of the time filter window (ISO8601). Only orders at or after this timestamp are returned.

end

string

End of the time filter window (ISO8601). Only orders at or before this timestamp are returned.

orderType

string

Restrict results to a specific order type. Allowed values: Limit, Stop Limit, Stop Market, Take Profit Limit, Take Profit Market.

Request Examples

Response

200 Success: Returns an orders array containing order objects from the latest snapshot.

chevron-rightResponse Examplehashtag

circle-check

Get Timestamp for the Latest Available Orders Snapshot

/api/external/orders/5m-snapshots/latest-snapshot-timestamp

Returns the timestamp of the most recent 5-minute orders snapshot that is currently available. This is useful if you want to know what snapshot your “latest” data corresponds to, or if you want to detect when a new snapshot has been published.

Currently on a 5-min granularity for all open orders. 1-min granularity coming soon!

Request Examples

Response

200 Success: Returns the timestamp for the latest available snapshot.

chevron-rightResponse Examplehashtag

circle-check

Get 5m Orders Snapshot

/api/external/orders/5m-snapshots/{snapshotTime}

Returns a paginated list of orders captured in the 5-minute snapshot identified by snapshotTime.

Use this endpoint when you want a specific historical snapshot rather than “latest”. The snapshot timestamp must follow these rules:

  • It must be aligned to a 5-minute boundary (for example 11:05, 11:10, 11:15, etc.)

  • It must be on or after 2026-01-19T11:05:00+00:00

  • It cannot be in the future

You can additionally filter the orders inside that snapshot by market (coin), trader address, order id, time window, and order type. Use nextCursor to paginate through large snapshots.

Currently on a 5-min granularity for all open orders. 1-min granularity coming soon!

chevron-rightQuery Parametershashtag
Parameter
Type
Description

snapshotTime

string

Snapshot timestamp (path). Must be a multiple of 5 minutes, must be >= 2026-01-19T11:05:00+00:00and cannot be in the future.

limit

number

Limit number of results returned. Default value: 100.

nextCursor

string

Pagination cursor returned by the previous response. Provide this to continue fetching the next page of results.

coin

string

Market identifier (coin symbol) to filter orders by, for example BTC.

address

string

Trader account address to filter orders by.

oid

string

Filter by a specific order ID. Useful when you want to retrieve one known order from the snapshot.

start

string

Start of the time filter window (ISO8601). Only orders at or after this timestamp are returned.

end

string

End of the time filter window (ISO8601). Only orders at or before this timestamp are returned.

orderType

string

Restrict results to a specific order type. Allowed values: Limit, Stop Limit, Stop Market, Take Profit Limit, Take Profit Market.

Request Examples

Response

200 Success: Returns a JSON payload containing an orders array for the requested snapshot, plus nextCursor when more results are available.

chevron-rightResponse Examplehashtag

Segments and Cohorts

Endpoints for defining cohorts and retrieving cohort-scoped analytics such as membership, position breakdowns, bias, and risk distribution. Use this when you want segmentation-based views rather than individual wallet analysis.

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 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 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.

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

Leaderboards, Rankings, Discovery

Ranked outputs that help you identify top performers, trending accounts, popular wallets, and vault leaders. Use this to build leaderboards, discovery feeds, and “top accounts” style dashboards.

circle-check

Get PERP PnL Leaderboard

/api/external/leaderboards/perp-pnl

Returns a perpetual PnL leaderboard for wallets ranked by performance over a selectable time horizon. Each row contains the wallet address and a full performance snapshot including current perp equity, open notional exposure, long exposure, exposure ratio and directional bias, absolute PnL and PnL percentage for day, week, month, and all-time, plus trading volume for the same periods. Results can be sorted and ranked by PnL over day, week, month, or all-time, and paginated using offset and limit.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

offset

number

Number of rows to skip before returning results (pagination).

limit

number

Number of results to return. Allowed values: 25, 50, 100.

order

string

Sort direction. Allowed values: asc, desc. Default: desc.

orderBy

string

Field used to sort results by PnL period. Allowed values: pnlDay, pnlWeek, pnlMonth, pnlAllTime.

rankBy

string

Field used to compute the leaderboard rank by PnL period. Allowed values: pnlDay, pnlWeek, pnlMonth, pnlAllTime.

Request Examples

Response

200 Success: Returns the total number of eligible wallets and a page of leaderboard rows.

chevron-rightResponse Examplehashtag

Builder Analytics

Builder attribution and performance metrics, including summaries and user-level breakdowns. Use this to track partner performance and builder economics.

circle-check

Get Builders List

/api/external/builders/list/timeframe/{timeframe}

Returns the full Builders table on the Builders page. Each row in that table corresponds to one entry in this response: a ranked list of all builders on the Hyperliquid network for the selected timeframe, ordered by revenue descending. Each entry includes the builder's display name, wallet address, fee rate, user count, volume, and total revenue for the specified period.

chevron-rightPath Parametershashtag
Parameter
Type
Description

timeframe

string

Time period for builder statistics. Available values: 24h, 7d, 30d, all

Request Examples

Response

200 Success: Returns a builders array containing all active builders on the network, sorted by revenue descending for the requested timeframe.

chevron-rightResponse Exampleshashtag

circle-check

Get Builder Profile

/api/external/builders/{builder}/profile

Returns a comprehensive profile for a specific builder address. This includes identity metadata (name, URL, social links), lifetime and period-based revenue totals, the builder's fee rate, their single biggest revenue day, progress toward revenue milestones, and a full breakdown of analytics and volume distribution across 24h, 7d, 30d, and all-time windows.

chevron-rightPath Parametershashtag
Parameter
Type
Description

builder

string

The builder's wallet address.

Request Examples

Response

200 Success: Returns the full profile for the requested builder address.

chevron-rightResponse Exampleshashtag

Get Builder’s Users and Activity

/api/external/builders/{builder}/users

Shows all users who are connected to a specific builder and reveals both their engagement and their trading performance. You can see each user’s address, equity, recent profit and loss over the last 24 hours, 7 days, 30 days or all-time, how much they have paid in builder fees, and the total trading volume they have generated. It also includes profile information when available, like display name or social details, plus basic activity such as how long the account has been active.

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

chevron-rightPath Parametershashtag
Parameter
Type
Description

builder

string

The builder's wallet address.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

offset

number

Number of results to skip before starting the list.

limit

number

Maximum number of user records to return.

order

string

Sorting direction. Allowed values: asc, desc.

orderBy

string

Field to order results by (e.g. createdAt, trades, volume).

period

string

Period to show results for (available: 24h, 7d, 30d, all. Default value is "all").

Request Examples

Response

200 Success: Returns builder user activity data.

chevron-rightResponse Exampleshashtag

circle-check

Get Builder Fills

/api/external/fills

Returns trade fills (executions) within a selected time window for the requested filters. Each fill represents a single matched execution and includes the wallet address, traded symbol, execution price and size, side (B buy or A sell), execution timestamp, and position impact (the position before the fill and whether it opened or closed long or short exposure). It also provides execution identifiers (order id and trade id), whether the execution crossed the spread, the transaction hash when available, and all fee attribution including fee amount, fee token, optional builder address, and builder fee.

This endpoint can only be queried one day at a time: end must be within the same calendar day as start. All data fully available from July 2025. TWAPs are listed with the address "0x0000000000000000000000000000000000000000000000000000000000000000".

chevron-rightQuery Parametershashtag
Parameter
Type
Description

limit

number

Maximum number of metric rows to return in one response.

coin

string

Filter by one or more coin symbols (for example ETH, BTC).

nextCursor

string

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

address

string

Filter by one or more wallet addresses.

builder

string

Filter by one or more builder addresses.

start

string

Start of the time window (ISO8601).

end

string

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

side

string

Filter by fill side. Allowed values: A, B.

Request Examples

Response

200 Success: Returns a list of fills that match the provided filters.

chevron-rightResponse Examplehashtag

circle-check

Get Builders All-Time Revenue, Daily Revenue and Users

/api/external/builders/all-time-revenue

Returns the data powering the Total Revenue, Daily Revenue, and Unique Users charts on the HyperTracker Live Builder Analytics page. Each row covers one calendar day and includes two metrics: the total builder fees collected across the entire Hyperliquid ecosystem, and the number of distinct users who generated those fees. The series runs from the earliest recorded date through to the current day.

To calculate all-time total revenue, sum the revenue field across all rows in the response. This is the same figure shown in the Total Revenue chart on the Live Builder Analytics page.

Request Examples

Response

200 Success: Returns a columnar time-series object covering all recorded days of builder revenue activity.

chevron-rightResponse Examplehashtag

$HYPE Token

Get an insight into $HYPE Token data. Use this to get a deeper understanding of where the market is positioned for $HYPE.

Get All HYPE Token Holders

/api/external/hype/holders

Returns a complete list of all HYPE token holders. For each holder you can see their wallet address, whether they have claimed their tokens, how many tokens they own, and what percentage of the total supply that amount represents.

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

chevron-rightQuery Parametershashtag
Parameter
Type
Description

offset

number

Number of results to skip before starting the list.

limit

number

Maximum number of holder records to return.

order

string

Sort direction. Allowed values: asc, desc.

orderBy

string

Field to order by. Allowed values: balance, percentage, address, updatedAt.

Request Examples

Response

200 Success: Returns all HYPE token holder data.

chevron-rightResponse Examplehashtag

Downloadable Files

High-level overview of data based on different categories like cohorts, orders and positions.

circle-check

Get Total Wallets Equity Chart (Download File)

/api/external/exports/total-wallets-equity-chart-data

Exports Total Wallets Equity chart data including the all-time-high breakdown, the same breakdown from 24 hours earlier, and historical time-series values for total, perp, spot, staking, and vault equity. Each section includes a columns array that defines the order of values in data, and historical entries are returned with timestamps.

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

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 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.

Request Examples

Response

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

chevron-rightResponse Examplehashtag

circle-check

Get Liquidation Heatmap (Download File)

/api/external/exports/coins/{coin}/liquidation-heatmap

Exports cohort bias time-series data grouped by segmentId, where each segment contains timestamped bias values. Each segment includes a columns array that defines the order of values in data, making the export easy to parse for charts, reporting, or analytics.

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

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 Breakdown by Cohort (Download File)

/api/external/exports/coins/{coin}/{file}

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.

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 Breakdown by Size (Download File)

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

Returns a 302 redirect to a download link for the Position Breakdown by Size. The downloaded file contains the Positions by Size for the selected coin. 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.

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 Positions (Download File)

/api/external/exports/coins/{coin}/positions

Exports position breakdown by size for a selected coin, returning size-segment metrics such as size range, position count, total position value, long position value, value close to liquidation, bias, and past comparison values, along with the export timestamp.

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

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 (Download File)

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

Exports position metrics time-series data for the selected coin, including timestamped values for position count, long position count, total position value, and long position value. The columns array 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.

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.

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

Get 5m Orders Snapshot (Download File)

/api/external/orders/5m-snapshots/{snapshotTime}/download

Returns a download link (URL) for the 5-minute orders snapshot file at the specified snapshotTime. Use this when you want to download the snapshot as a file instead of retrieving orders as JSON.

snapshotTime must follow these rules:

  • Aligned to a 5-minute boundary

  • >= 2026-01-19T11:05:00+00:00

  • Not in the future

Currently on a 5-min granularity for all open orders. 1-min granularity coming soon!

chevron-rightQuery Parametershashtag
Parameter
Type
Description

snapshotTime

string

Snapshot timestamp (path). Must be a multiple of 5 minutes, must be >= 2026-01-19T11:05:00+00:00and cannot be in the future.

Request Examples

Response

200 Success: Returns a JSON object containing a downloadUrl for the requested snapshot.

chevron-rightResponse Examplehashtag

/api/external/orders/5m-snapshots/coins/{coin}/download

Returns a download link (URL) for the latest 5-minute orders snapshot for a specific coin.

Currently on a 5-min granularity for all open orders. 1-min granularity coming soon!

chevron-rightQuery Parametershashtag
Parameter
Type
Description

coin

string

Coin identifier to fetch the latest snapshot for (path parameter).

Request Examples

Response

200 Success: Returns a JSON object containing a downloadUrl.

chevron-rightResponse Examplehashtag

circle-check

/api/external/leaderboards/perp-pnl/{period}/download

Returns a temporary, pre-signed download link for exporting the perpetual PnL leaderboard for a selected period. The returned URL can be opened directly in a browser or fetched programmatically to download the export file. The link expires automatically after a short time.

chevron-rightQuery Parametershashtag
Parameter
Type
Description

period

string

Leaderboard period to export. Allowed values: day, week, month, all.

Request Examples

Response

200 Success: Returns a temporary download URL.

chevron-rightResponse Examplehashtag

Last updated