πŸ“Downloadable Files

The Downloadable Files section provides access to downloadable export files and supporting resources across the platform. These files can be used to retrieve structured data, charts, analytics outputs, and other materials for external analysis, reporting, and workflow integration.

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.

Also found on the Trader & Wallet subpage here.

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

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.

Also found on the Cohorts subpage here.

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 liquidation heatmap data for the selected coin, returning price-bin ranges with liquidation value, position count, and the most impacted segment for each bin.

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

Also found on the Liquidation subpage here and the Positions & Market Exposure 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 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.

Also found on the Positions & Market Exposure 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 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 Cohorts 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 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.

Also found on the Positions & Market Exposure 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 (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.

Also found on the Positions & Market Exposure 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 Cohorts 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

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!

Also found on the Order Data subpage here.

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!

Also found on the Order Data subpage here.

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.

Also found on the Leaderboards subpage here.

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