Skip to main content
GET
/
v1
/
perps
/
balance
curl "https://api.yield.xyz/v1/perps/balance?address=0x..." \
  -H "x-api-key: your_api_key"

Documentation Index

Fetch the complete documentation index at: https://yieldxyz.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Balance

Returns user’s trading account balance. 
curl "https://api.yield.xyz/v1/perps/balance?address=0x..." \
  -H "x-api-key: your_api_key"

​
Response

{
  "balances": [
    {
      "provider": "hyperliquid",
      "total": "10000",
      "available": "8000",
      "inPosition": "2000",
      "unrealizedPnl": "150"
    }
  ]
}