Assets

Fetch tradeable assets, prices, OHLCV candles, and orderbooks

Fetch asset details, prices, OHLCV chart data, and orderbook snapshots.

The examples on this page use Hyperliquid (provider: 'hyperliquid'). Replace the provider value with any supported DEX from getProviders().

getAssets

Returns all tradeable assets for a specified DEX with funding rates, open interest, and volume.

import { getAssets } from '@lifi/perps-sdk';

const { assets } = await getAssets(client, { provider: 'hyperliquid' });

for (const asset of assets) {
  console.log(asset.displaySymbol, asset.markPrice, `${asset.maxLeverage}x`);
}
// BTC 95000.50 50x
// ETH 3200.25 50x

Parameters

Parameter	Type	Required	Description
client	PerpsSDKClient	Yes	SDK client
params.provider	string	Yes	Provider identifier
options	SDKRequestOptions	No	Request options

Returns

AssetsResponse — { assets: Asset[] }:

Each Asset:

Field	Type	Description
assetId	string	Provider’s canonical identity (e.g., "BTC", "xyz:PURR", "@142")
market	string	Market category (e.g., "hyperliquid", "xyz", "spot")
displaySymbol	string	UI-friendly base symbol (e.g., "BTC", "PURR")
displayQuote	string | null	Quote asset (e.g., "USDC")
displayName	string?	Full asset name (e.g., "Bitcoin")
logoURI	string	URL to asset logo
szDecimals	number	Size decimal places
maxLeverage	number	Maximum allowed leverage
onlyIsolated	boolean	Whether only isolated margin is supported
isMarginCollateral	boolean?	Whether this asset can be used as margin collateral
funding	FundingInfo	Current funding rate and next funding time
openInterest	string?	Total open interest in USD
volume24h	string?	24-hour trading volume in USD
prevDayPrice	string?	Previous day’s price
markPrice	string	Current mark price

API Reference: GET /assets

---

getAsset

Returns details for a single asset.

import { getAsset } from '@lifi/perps-sdk';

const btc = await getAsset(client, { provider: 'hyperliquid', symbol: 'BTC' });
console.log(btc.markPrice, btc.funding.rate);
// 95000.50 0.0001

Parameters

Parameter	Type	Required	Description
client	PerpsSDKClient	Yes	SDK client
params.provider	string	Yes	Provider identifier
params.symbol	string	Yes	Asset identifier (e.g., BTC)
options	SDKRequestOptions	No	Request options

Returns

Asset — Single asset object (same shape as above).

API Reference: GET /assets/

---

getPrices

Returns current mid prices for all assets. Lightweight endpoint for frequent polling.

import { getPrices } from '@lifi/perps-sdk';

const { prices } = await getPrices(client, { provider: 'hyperliquid' });
for (const p of prices) {
  console.log(p.assetId, p.price);
}
// BTC 95000.50
// ETH 3200.25

Parameters

Parameter	Type	Required	Description
client	PerpsSDKClient	Yes	SDK client
params.provider	string	Yes	Provider identifier
params.symbols	string[]	No	Filter to specific asset IDs
options	SDKRequestOptions	No	Request options

Returns

PricesResponse — { prices: AssetPrice[] }:

Each AssetPrice:

Field	Type	Description
assetId	string	Asset identifier
price	string	Current mid price

API Reference: GET /prices

---

getOhlcv

Returns OHLCV candle data for charts.

import { getOhlcv } from '@lifi/perps-sdk';

const { candles } = await getOhlcv(client, {
  provider: 'hyperliquid',
  symbol: 'BTC',
  interval: '1h',
  limit: 100,
});

for (const candle of candles) {
  console.log(candle.t, candle.o, candle.h, candle.l, candle.c, candle.v);
}

Parameters

Parameter	Type	Required	Description
client	PerpsSDKClient	Yes	SDK client
params.provider	string	Yes	Provider identifier
params.symbol	string	Yes	Asset identifier
params.interval	string	Yes	Candle interval: 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 8h, 12h, 1d, 3d, 1w, 1M
params.startTime	number	No	Start timestamp in milliseconds
params.endTime	number	No	End timestamp in milliseconds
params.limit	number	No	Max candles to return (default 100, max 1000)
options	SDKRequestOptions	No	Request options

Returns

OhlcvResponse:

Field	Type	Description
provider	string	Provider identifier
assetId	string	Asset identifier
interval	string	Candle interval
candles	Candle[]	Array of candle data

Each Candle:

Field	Type	Description
t	number	Timestamp in milliseconds
o	string	Open price
h	string	High price
l	string	Low price
c	string	Close price
v	string	Volume

API Reference: GET /ohlcv/

---

getOrderbook

Returns current orderbook snapshot with bids and asks.

import { getOrderbook } from '@lifi/perps-sdk';

const book = await getOrderbook(client, {
  provider: 'hyperliquid',
  symbol: 'BTC',
  depth: 20,
});

console.log('Best bid:', book.bids[0].price, book.bids[0].size);
console.log('Best ask:', book.asks[0].price, book.asks[0].size);

Parameters

Parameter	Type	Required	Description
client	PerpsSDKClient	Yes	SDK client
params.provider	string	Yes	Provider identifier
params.symbol	string	Yes	Asset identifier
params.depth	number	No	Number of price levels (default 20, max 100)
options	SDKRequestOptions	No	Request options

Returns

OrderbookResponse:

Field	Type	Description
provider	string	Provider identifier
assetId	string	Asset identifier
bids	OrderbookLevel[]	Bid price levels (descending)
asks	OrderbookLevel[]	Ask price levels (ascending)
timestamp	number	Snapshot timestamp in milliseconds

Each OrderbookLevel:

Field	Type	Description
price	string	Price level
size	string	Size at this price level

API Reference: GET /orderbook/