Get User Balance
curl --request GET \
--url https://persephone.superform.xyz/v1/balances/{address} \
--header 'SF-API-KEY: <api-key>'import requests
url = "https://persephone.superform.xyz/v1/balances/{address}"
headers = {"SF-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'SF-API-KEY': '<api-key>'}};
fetch('https://persephone.superform.xyz/v1/balances/{address}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://persephone.superform.xyz/v1/balances/{address}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"SF-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://persephone.superform.xyz/v1/balances/{address}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("SF-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://persephone.superform.xyz/v1/balances/{address}")
.header("SF-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://persephone.superform.xyz/v1/balances/{address}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["SF-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"balances": [
{
"user_address": "<string>",
"amount": "<string>",
"chain_id": "<string>",
"decimals": 123,
"icon": "<string>",
"is_stable": true,
"is_btc": true,
"is_eth": true,
"name": "<string>",
"price": "<string>",
"symbol": "<string>",
"last_updated": "2023-11-07T05:31:56Z",
"token_address": "<string>",
"token_type": "<string>",
"value_usd": "<string>",
"value_btc": "<string>",
"value_eth": "<string>",
"vault_id": "<string>",
"vault": {
"id": "<string>",
"address": "<string>",
"chain_id": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"friendly_name": "<string>",
"category": "<string>",
"type": "4626",
"description": "<string>",
"short_description": "<string>",
"visibility": "listed",
"availability": "available",
"risk_rating": "<string>",
"risk_data": {
"pool_rating": "<string>",
"pool_rating_color": "<string>",
"pool_rating_description": "<string>",
"pool_url": "<string>",
"pool_design": {
"rating": "<string>",
"rating_color": "<string>"
},
"chain": {
"rating": "<string>",
"rating_color": "<string>",
"underlying": [
{
"name": "<string>",
"rating": "<string>",
"rating_color": "<string>",
"url": "<string>"
}
]
},
"assets": {
"rating": "<string>",
"rating_color": "<string>",
"underlying": [
{
"name": "<string>",
"rating": "<string>",
"rating_color": "<string>",
"url": "<string>"
}
]
},
"protocols": {
"rating": "<string>",
"rating_color": "<string>",
"underlying": [
{
"name": "<string>",
"rating": "<string>",
"rating_color": "<string>",
"url": "<string>"
}
]
}
},
"status_message": "<string>",
"external_url": "<string>",
"has_rewards": true,
"is_on_mobile": true,
"has_timelock": true,
"timelock_duration": "<string>",
"timelock_unit": "<string>",
"is_supervault": true,
"is_on_earn_page": true,
"is_on_mobile_earn": true,
"is_supervault_v2": true,
"asset_ids": [
"<string>"
],
"provider_ids": [
"<string>"
],
"yield_source_ids": [
"<string>"
],
"metadata": {
"audits": [
{
"date": "2023-11-07T05:31:56Z",
"url": "<string>",
"auditor": "<string>"
}
],
"kyc": [
{
"issuer": "<string>",
"issuer_link": "<string>",
"provider": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"other": [
{
"info": "<string>",
"description": "<string>"
}
]
},
"stats_basic": {
"apy_snapshot_now": 123,
"apy_snapshot_day": 123,
"apy_snapshot_week": 123,
"apy_snapshot_month": 123,
"apy_snapshot_year": 123,
"apy_snapshot_all_time": 123,
"apy_change_day": 123,
"apy_change_week": 123,
"apy_change_month": 123,
"apy_change_year": 123,
"apy_change_all_time": 123,
"tvl_total": 123,
"tvl_superform": 123,
"tvl_total_change_day": 123,
"tvl_total_change_week": 123,
"tvl_total_change_month": 123,
"tvl_total_change_year": 123,
"tvl_total_change_all_time": 123,
"tvl_superform_change_day": 123,
"tvl_superform_change_week": 123,
"tvl_superform_change_month": 123,
"tvl_superform_change_year": 123,
"tvl_superform_change_all_time": 123,
"sharpe_snapshot_day": 123,
"sharpe_snapshot_week": 123,
"sharpe_snapshot_month": 123,
"sharpe_snapshot_year": 123,
"sharpe_snapshot_all_time": 123,
"return_day": 123,
"return_week": 123,
"return_month": 123,
"return_year": 123,
"return_all_time": 123,
"pps": 123,
"pps_usd": 123,
"reward_rate": 123,
"net_inflow_total_day": 123,
"net_inflow_total_week": 123,
"net_inflow_total_month": 123,
"net_inflow_total_day_assets": 123,
"net_inflow_total_week_assets": 123,
"net_inflow_total_month_assets": 123
},
"deployment_date": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"providers": [
{
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"type": "<string>",
"description": "<string>",
"is_hidden": true
}
],
"assets": [
{
"id": "<string>",
"address": "<string>",
"chain_id": "<string>",
"decimals": 123,
"icon": "<string>",
"is_btc": true,
"is_eth": true,
"is_stable": true,
"name": "<string>",
"price_usd": 123,
"price_usd_24h_change": 123,
"symbol": "<string>"
}
],
"rewards": [
{
"type": "<string>",
"logo": "<string>",
"reward_rate": 123,
"rate_type": "<string>",
"address": "<string>",
"symbol": "<string>",
"reward_multiplier": 123,
"chain_id": "<string>",
"remarks": "<string>",
"remarks_url": "<string>",
"is_configurable": true,
"total_supply": "<string>",
"reward_source": "<string>",
"reward_up_base_rate": 123
}
],
"chain": {
"id": "<string>",
"name": "<string>",
"icon": "<string>",
"currency_symbol": "<string>",
"is_l1": true
}
},
"assets": [
{
"asset_id": "<string>",
"is_btc": true,
"is_eth": true,
"is_stable": true,
"name": "<string>",
"symbol": "<string>",
"price": 123,
"decimals": 123,
"icon": "<string>",
"chain_id": "<string>",
"address": "<string>"
}
],
"performance": {
"cost_method": "<string>",
"average_cost": 123,
"total_pnl": 123,
"growth": 123,
"total_unrealized_pnl": 123,
"unrealized_breakdown": {
"underlying": 123,
"yield": 123,
"rewards": 123
},
"total_realized_pnl": 123,
"realized_breakdown": {
"underlying": 123,
"yield": 123,
"rewards": 123
}
},
"action": "<string>",
"status": "<string>",
"strategy_id": "<string>",
"underlying_amount": "<string>",
"token_sub_type": "token"
}
],
"total_portfolio_value_usd": 123,
"total_vault_share_value_usd": 123,
"avg_vault_share_apy": 123,
"portfolio_performance": {
"portfolio_value_usd": 123,
"total_pnl": 123,
"total_unrealized_pnl": 123,
"growth": 123,
"unrealized_breakdown": {
"underlying": 123,
"yield": 123,
"rewards": 123
},
"total_realized_pnl": 123,
"realized_breakdown": {
"underlying": 123,
"yield": 123,
"rewards": 123
}
},
"hypercore": {
"perp_account_value_usd": 123,
"perp_margin_used_usd": 123,
"perp_withdrawable_usd": 123,
"spot_usdc_value_usd": 123,
"total_value_usd": 123,
"spot_balances": [
{
"coin": "<string>",
"token_index": 123,
"amount": "<string>",
"hold": "<string>",
"value_usd": 123,
"priced": true
}
],
"stale": true,
"spot_unavailable": true,
"last_updated": "2023-11-07T05:31:56Z",
"spot_value_usd": 123
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Balances
Get User Balance
GET
/
v1
/
balances
/
{address}
Get User Balance
curl --request GET \
--url https://persephone.superform.xyz/v1/balances/{address} \
--header 'SF-API-KEY: <api-key>'import requests
url = "https://persephone.superform.xyz/v1/balances/{address}"
headers = {"SF-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'SF-API-KEY': '<api-key>'}};
fetch('https://persephone.superform.xyz/v1/balances/{address}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://persephone.superform.xyz/v1/balances/{address}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"SF-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://persephone.superform.xyz/v1/balances/{address}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("SF-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://persephone.superform.xyz/v1/balances/{address}")
.header("SF-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://persephone.superform.xyz/v1/balances/{address}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["SF-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"balances": [
{
"user_address": "<string>",
"amount": "<string>",
"chain_id": "<string>",
"decimals": 123,
"icon": "<string>",
"is_stable": true,
"is_btc": true,
"is_eth": true,
"name": "<string>",
"price": "<string>",
"symbol": "<string>",
"last_updated": "2023-11-07T05:31:56Z",
"token_address": "<string>",
"token_type": "<string>",
"value_usd": "<string>",
"value_btc": "<string>",
"value_eth": "<string>",
"vault_id": "<string>",
"vault": {
"id": "<string>",
"address": "<string>",
"chain_id": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"friendly_name": "<string>",
"category": "<string>",
"type": "4626",
"description": "<string>",
"short_description": "<string>",
"visibility": "listed",
"availability": "available",
"risk_rating": "<string>",
"risk_data": {
"pool_rating": "<string>",
"pool_rating_color": "<string>",
"pool_rating_description": "<string>",
"pool_url": "<string>",
"pool_design": {
"rating": "<string>",
"rating_color": "<string>"
},
"chain": {
"rating": "<string>",
"rating_color": "<string>",
"underlying": [
{
"name": "<string>",
"rating": "<string>",
"rating_color": "<string>",
"url": "<string>"
}
]
},
"assets": {
"rating": "<string>",
"rating_color": "<string>",
"underlying": [
{
"name": "<string>",
"rating": "<string>",
"rating_color": "<string>",
"url": "<string>"
}
]
},
"protocols": {
"rating": "<string>",
"rating_color": "<string>",
"underlying": [
{
"name": "<string>",
"rating": "<string>",
"rating_color": "<string>",
"url": "<string>"
}
]
}
},
"status_message": "<string>",
"external_url": "<string>",
"has_rewards": true,
"is_on_mobile": true,
"has_timelock": true,
"timelock_duration": "<string>",
"timelock_unit": "<string>",
"is_supervault": true,
"is_on_earn_page": true,
"is_on_mobile_earn": true,
"is_supervault_v2": true,
"asset_ids": [
"<string>"
],
"provider_ids": [
"<string>"
],
"yield_source_ids": [
"<string>"
],
"metadata": {
"audits": [
{
"date": "2023-11-07T05:31:56Z",
"url": "<string>",
"auditor": "<string>"
}
],
"kyc": [
{
"issuer": "<string>",
"issuer_link": "<string>",
"provider": "<string>"
}
],
"faq": [
{
"question": "<string>",
"answer": "<string>"
}
],
"other": [
{
"info": "<string>",
"description": "<string>"
}
]
},
"stats_basic": {
"apy_snapshot_now": 123,
"apy_snapshot_day": 123,
"apy_snapshot_week": 123,
"apy_snapshot_month": 123,
"apy_snapshot_year": 123,
"apy_snapshot_all_time": 123,
"apy_change_day": 123,
"apy_change_week": 123,
"apy_change_month": 123,
"apy_change_year": 123,
"apy_change_all_time": 123,
"tvl_total": 123,
"tvl_superform": 123,
"tvl_total_change_day": 123,
"tvl_total_change_week": 123,
"tvl_total_change_month": 123,
"tvl_total_change_year": 123,
"tvl_total_change_all_time": 123,
"tvl_superform_change_day": 123,
"tvl_superform_change_week": 123,
"tvl_superform_change_month": 123,
"tvl_superform_change_year": 123,
"tvl_superform_change_all_time": 123,
"sharpe_snapshot_day": 123,
"sharpe_snapshot_week": 123,
"sharpe_snapshot_month": 123,
"sharpe_snapshot_year": 123,
"sharpe_snapshot_all_time": 123,
"return_day": 123,
"return_week": 123,
"return_month": 123,
"return_year": 123,
"return_all_time": 123,
"pps": 123,
"pps_usd": 123,
"reward_rate": 123,
"net_inflow_total_day": 123,
"net_inflow_total_week": 123,
"net_inflow_total_month": 123,
"net_inflow_total_day_assets": 123,
"net_inflow_total_week_assets": 123,
"net_inflow_total_month_assets": 123
},
"deployment_date": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"providers": [
{
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"type": "<string>",
"description": "<string>",
"is_hidden": true
}
],
"assets": [
{
"id": "<string>",
"address": "<string>",
"chain_id": "<string>",
"decimals": 123,
"icon": "<string>",
"is_btc": true,
"is_eth": true,
"is_stable": true,
"name": "<string>",
"price_usd": 123,
"price_usd_24h_change": 123,
"symbol": "<string>"
}
],
"rewards": [
{
"type": "<string>",
"logo": "<string>",
"reward_rate": 123,
"rate_type": "<string>",
"address": "<string>",
"symbol": "<string>",
"reward_multiplier": 123,
"chain_id": "<string>",
"remarks": "<string>",
"remarks_url": "<string>",
"is_configurable": true,
"total_supply": "<string>",
"reward_source": "<string>",
"reward_up_base_rate": 123
}
],
"chain": {
"id": "<string>",
"name": "<string>",
"icon": "<string>",
"currency_symbol": "<string>",
"is_l1": true
}
},
"assets": [
{
"asset_id": "<string>",
"is_btc": true,
"is_eth": true,
"is_stable": true,
"name": "<string>",
"symbol": "<string>",
"price": 123,
"decimals": 123,
"icon": "<string>",
"chain_id": "<string>",
"address": "<string>"
}
],
"performance": {
"cost_method": "<string>",
"average_cost": 123,
"total_pnl": 123,
"growth": 123,
"total_unrealized_pnl": 123,
"unrealized_breakdown": {
"underlying": 123,
"yield": 123,
"rewards": 123
},
"total_realized_pnl": 123,
"realized_breakdown": {
"underlying": 123,
"yield": 123,
"rewards": 123
}
},
"action": "<string>",
"status": "<string>",
"strategy_id": "<string>",
"underlying_amount": "<string>",
"token_sub_type": "token"
}
],
"total_portfolio_value_usd": 123,
"total_vault_share_value_usd": 123,
"avg_vault_share_apy": 123,
"portfolio_performance": {
"portfolio_value_usd": 123,
"total_pnl": 123,
"total_unrealized_pnl": 123,
"growth": 123,
"unrealized_breakdown": {
"underlying": 123,
"yield": 123,
"rewards": 123
},
"total_realized_pnl": 123,
"realized_breakdown": {
"underlying": 123,
"yield": 123,
"rewards": 123
}
},
"hypercore": {
"perp_account_value_usd": 123,
"perp_margin_used_usd": 123,
"perp_withdrawable_usd": 123,
"spot_usdc_value_usd": 123,
"total_value_usd": 123,
"spot_balances": [
{
"coin": "<string>",
"token_index": 123,
"amount": "<string>",
"hold": "<string>",
"value_usd": 123,
"priced": true
}
],
"stale": true,
"spot_unavailable": true,
"last_updated": "2023-11-07T05:31:56Z",
"spot_value_usd": 123
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Authorizations
API key required for authentication. Use the value {{v2_api_key}} in Postman.
Path Parameters
User wallet address
Query Parameters
Optional balances provider override (one of: zerion, dune, debank, zapper, octav)
Response
A successful response.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
HyperCoreBalance carries a user's Hyperliquid HyperCore holdings, which are off-EVM and therefore invisible to every balance provider and RPC read. Without it a funded perps user's portfolio total is short by the amount they deposited, which reads to them as lost money rather than moved money.
Scope note. total_value_usd is folded into total_portfolio_value_usd and portfolio_performance.portfolio_value_usd, and HyperCore PnL is folded into total_pnl_usd and into the unrealized and realized totals: there is ONE set of portfolio figures covering vaults and HyperCore together, not a separate perps set to add on.
total_pnl_usd is therefore unrealized plus realized, for a perps user exactly as for a vault one. Unrealized comes from open positions' unrealizedPnl in clearinghouseState; realized is the remainder, which is also where funding payments land - the cost-basis feed excludes them, so they reach PnL through accountValue, and funding is realized.
What stays vault-only: growth, which means yield plus rewards and is neither of those for a perp; and the per-source breakdowns (underlying, yield, rewards), because perp PnL decomposes into none of them.
/v1/user/pnl/historical carries HyperCore in its aggregates too, with the per-snapshot hypercore_* fields exposed so a client can render a vault-only series. There is no history to backfill - Hyperliquid publishes none and cost basis accumulates forward from the first read - so a series steps when HyperCore first appears rather than being reconstructed backwards.
Do not add hypercore.total_value_usd to either portfolio total; it is already in both.
Show child attributes
Show child attributes