Perps - Token Overview
curl --request GET \
--url https://public-api.birdeye.so/perps/v1/token/overview \
--header 'X-API-KEY: <api-key>'import requests
url = "https://public-api.birdeye.so/perps/v1/token/overview"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://public-api.birdeye.so/perps/v1/token/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"data": {
"price": 80707,
"position_count": 27967,
"open_interest": 2176626728.25445,
"long_liquidation_1h": 0,
"short_liquidation_1h": 0,
"long_liquidation_4h": 1368222.64619,
"short_liquidation_4h": 13790.85989,
"long_liquidation_1d": 1506653.41144,
"short_liquidation_1d": 9848277.21284,
"long_liquidation_7d": 32705301.59656,
"short_liquidation_7d": 32312554.24219
}
}{
"success": false,
"message": "Bad request"
}{
"success": false,
"message": "Unauthorized"
}{
"success": false,
"message": "Access Denied"
}{
"success": false,
"message": "Too many requests"
}{
"success": false,
"message": "Internal Server Error"
}Perps Token
Perps Token Overview
GET
/
perps
/
v1
/
token
/
overview
Perps - Token Overview
curl --request GET \
--url https://public-api.birdeye.so/perps/v1/token/overview \
--header 'X-API-KEY: <api-key>'import requests
url = "https://public-api.birdeye.so/perps/v1/token/overview"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://public-api.birdeye.so/perps/v1/token/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"data": {
"price": 80707,
"position_count": 27967,
"open_interest": 2176626728.25445,
"long_liquidation_1h": 0,
"short_liquidation_1h": 0,
"long_liquidation_4h": 1368222.64619,
"short_liquidation_4h": 13790.85989,
"long_liquidation_1d": 1506653.41144,
"short_liquidation_1d": 9848277.21284,
"long_liquidation_7d": 32705301.59656,
"short_liquidation_7d": 32312554.24219
}
}{
"success": false,
"message": "Bad request"
}{
"success": false,
"message": "Unauthorized"
}{
"success": false,
"message": "Access Denied"
}{
"success": false,
"message": "Too many requests"
}{
"success": false,
"message": "Internal Server Error"
}- Usage Note
- Accessibility
- Chain Supported
- Returns a token-level perpetual market snapshot for one Hyperliquid market.
- Use this endpoint for current market structure such as price, open interest, position count, and liquidation context.
- This is a summarized market view, not a row-by-row position ledger.
- Join with open-positions or liquidation-map endpoints when you need participant-level or price-bucket detail.
- Lite
- Starter
- Premium
- Business
- Enterprise
Hyperliquid
Compute Unit ⚙️
Compute Unit ⚙️
- This endpoint consumes
5 CUper request.
Use Cases 💡
Use Cases 💡
- Show a perp market summary card with price, open interest, and positioning context.
- Compare one market’s current structure before and after large moves or liquidation waves.
- Power derivatives research pages that summarize crowding, exposure, and recent market state.
- Provide a quick market-health view before loading heavier position-level data.
How to Use 🛠️
How to Use 🛠️
- Pass the target Hyperliquid perp token identifier.
- Read this overview first to decide whether you need position inventory or liquidation clustering next.
- Follow with
Perps Token Open Positionsfor wallet-level exposure orPerps Token Liquidation Mapfor liquidation concentration.
Best Practices ✅
Best Practices ✅
- Use this endpoint for the fast summary layer in dashboards, then lazy-load heavier detail endpoints on demand.
- Keep a clear distinction between current snapshot fields and time-series or execution data from other surfaces.
- Pair it with wallet-side perp endpoints when you need both market state and participant attribution.
Authorizations
API key for authentication
Headers
Specify the perpetuals exchange. Currently supports hyperliquid.
Available options:
hyperliquid Query Parameters
The symbol of a coin/token (e.g: BTC, SOL, ETH).
Was this page helpful?

