Perps - Wallet Overview
curl --request GET \
--url https://public-api.birdeye.so/perps/v1/wallet/overview \
--header 'X-API-KEY: <api-key>'import requests
url = "https://public-api.birdeye.so/perps/v1/wallet/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/wallet/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"data": {
"perp_equity": 4820256.661112,
"long_value": 7711796.4816,
"short_value": 27162652.130878,
"unrealized_pnl": 519753.636517,
"order_count": 528268,
"order_count_90d": 40946,
"win": 204298,
"win_90d": 18111,
"loss": 50566,
"loss_90d": 2810,
"volume_usd": 2877059275.010704,
"volume_90d_usd": 287016529.073075,
"open_volume_usd": 1317279026.67999,
"open_volume_90d_usd": 155549308.313184,
"realized_pnl": 171489764.775849,
"realized_pnl_90d": 9018515.858766,
"funding_fee": -1923466.812288,
"funding_fee_90d": -2530808.146744,
"first_trade": 1748185475,
"last_trade": 1778818326,
"open_value": 34874448.612478,
"total_pnl": 172009518.412366,
"total_pnl_90d": 9538269.495283,
"win_rate": 0.8015961453951912,
"win_rate_90d": 0.8656851966923187,
"roe": 0.11145774849176364,
"roi": 0.13018484413895512,
"roi_90d": 0.05797850184333872,
"bias": -4.035232357272615,
"leverage": 7.234977525954543,
"bias_text": "Very Bearish"
}
}{
"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 Wallet
Perps Wallet Overview
GET
/
perps
/
v1
/
wallet
/
overview
Perps - Wallet Overview
curl --request GET \
--url https://public-api.birdeye.so/perps/v1/wallet/overview \
--header 'X-API-KEY: <api-key>'import requests
url = "https://public-api.birdeye.so/perps/v1/wallet/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/wallet/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"data": {
"perp_equity": 4820256.661112,
"long_value": 7711796.4816,
"short_value": 27162652.130878,
"unrealized_pnl": 519753.636517,
"order_count": 528268,
"order_count_90d": 40946,
"win": 204298,
"win_90d": 18111,
"loss": 50566,
"loss_90d": 2810,
"volume_usd": 2877059275.010704,
"volume_90d_usd": 287016529.073075,
"open_volume_usd": 1317279026.67999,
"open_volume_90d_usd": 155549308.313184,
"realized_pnl": 171489764.775849,
"realized_pnl_90d": 9018515.858766,
"funding_fee": -1923466.812288,
"funding_fee_90d": -2530808.146744,
"first_trade": 1748185475,
"last_trade": 1778818326,
"open_value": 34874448.612478,
"total_pnl": 172009518.412366,
"total_pnl_90d": 9538269.495283,
"win_rate": 0.8015961453951912,
"win_rate_90d": 0.8656851966923187,
"roe": 0.11145774849176364,
"roi": 0.13018484413895512,
"roi_90d": 0.05797850184333872,
"bias": -4.035232357272615,
"leverage": 7.234977525954543,
"bias_text": "Very Bearish"
}
}{
"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 single Hyperliquid wallet summary across perpetual trading activity.
- Use this endpoint for equity, PnL, ROI, ROE, volume, win-rate-style, and directional overview fields exposed by the service.
- This is the wallet summary layer, not the wallet’s per-position inventory.
- Pair with wallet open positions when you need the exact current risk book.
- Lite
- Starter
- Premium
- Business
- Enterprise
Hyperliquid
Compute Unit ⚙️
Compute Unit ⚙️
- This endpoint consumes
5 CUper request.
Use Cases 💡
Use Cases 💡
- Show a trader profile summary for one perp wallet.
- Evaluate whether a wallet is worth deeper review before loading open positions.
- Power wallet intelligence views focused on derivatives performance and exposure.
- Compare a shortlist of notable wallets across high-level perp metrics.
How to Use 🛠️
How to Use 🛠️
- Pass one Hyperliquid wallet address.
- Read the response as a summarized wallet profile across the available perp metrics.
- If the wallet matters, continue to
Perps Wallet Open Positionsfor actual live exposure.
Best Practices ✅
Best Practices ✅
- Use overview as the lightweight profile layer and reserve position-level calls for drill-down.
- Keep point-in-time snapshots if you need to analyze wallet performance changes over time.
- Compare wallet-level summary with token-level market state before drawing conclusions about conviction or risk.
Authorizations
API key for authentication
Headers
Specify the perpetuals exchange. Currently supports hyperliquid.
Available options:
hyperliquid Query Parameters
The address of the wallet.
Was this page helpful?

