API Reference

Currently, we have the following endpoints available for use:

Historical Data API

This endpoint allows you to access market candle data for a given Spot market/token listed on Hyperliquid.

Required params:

Name	Description
limit	Sets the limit for number of candlesticks to be returned.
where	Defines the pair name for which data is to be returned.

Optional params:

Name	Description
offset	First N items to be excluded from the response.
order_by	Order the response in a particular manner e.g. Ascending, Descending etc.

Returned Fields

The following fields are returned in the response:

Name	Description
id	Unique identification number of the pair.
symbol	Symbol of the pair.
coin	Name of the token.
open	Opening price of the asset for that time period.
high	Highest price point reached during the time period.
low	Lowest price point reached during the time period.
close	The final trading price when the time period ends.
volume	Total number of units traded during the time period.
startTime	Timestamp when the time period begins.
endTime	Timestamp when the time period ends.
interval	The time duration of each candlestick. Determines the granularity of the price data.
isBarClosed	A boolean flag indicating whether this candlestick is the most recent one in the current data set.
isLastBar	A boolean flag indicating whether the candlestick is the most recent one in the current data set.
numberTrades	The total count of individual trades that occurred during the time period

Tokens API

This endpoint allows you to access various metadata like supply, volume for specified tokens on Hyperliquid.

Optional params:

Name	Description
limit	Sets the limit for number of results to be returned.
offset	First N items to be excluded from the response.
order_by	Order the response in a particular manner, e.g. Ascending, Descending etc.
where	Filter conditions to select specific tokens based on fields like Id, totalSupply, or other metadata attributes.

Returned fields

The following fields are returned in the response:

Name	Description
coin	The base asset or token.
id	Unique identifier of the token.
symbol	The ticker symbol representing the token.
markPrice	The current fair value of the token.
marketCap	The market capitalization of the token.
midPrice	The average of the current bid and ask prices for the token.
prevDayPrice	The token’s price exactly 24 hours ago.
dayBaseVolume	The total trading volume over the past 24 hours.
dayNotionalVolume	The total trading volume over the past 24 hours
fullyDilutedValuation	The market value of the token assuming all possible tokens are in circulation.
totalSupply	The total number of tokens that have been minted or issued.
circulatingSupply	The number of tokens currently in circulation and available to the public.
latestTimestamp	The timestamp of the most recent market data update.