Skip to main content
GET
/
v1
/
perps
/
positions
curl "https://api.yield.xyz/v1/perps/positions?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 Positions

Returns all open positions for a user. 
curl "https://api.yield.xyz/v1/perps/positions?address=0x..." \
  -H "x-api-key: your_api_key"

​
Query Parameters

ParameterTypeDescription
addressstringUser’s wallet address
providerstringFilter by provider

​
Response

{
  "positions": [
    {
      "id": "pos_123",
      "market": "BTC-USD-PERP",
      "provider": "hyperliquid",
      "side": "LONG",
      "size": "0.5",
      "entryPrice": "42000",
      "currentPrice": "43000",
      "leverage": 10,
      "unrealizedPnl": "500",
      "liquidationPrice": "38000"
    }
  ]
}