Get derivatives balances

Returns current balance information including margin balances, repayment balances, margin requirements, and available balances for a specific currency type.

Authorization

authorization<token>

Use your API key here.

In: header

Path Parameters

currency_typeRequiredstring

Currency type for derivatives operations

Value in: "BTC" | "USD"

curl -X GET "https://app.luxor.tech/api/v2/derivatives/balances/BTC" \
  -H "authorization: <token>"

Default Response

{
  "currency_type": "BTC",
  "current_margin_balance": {
    "realized_margin_balance": 110.887551818,
    "unrealized_margin_balance": 110.887551818,
    "effective_margin_balance": 110.887551818
  },
  "current_repayment_balance": {
    "upfront_payment_credits": 1310.613298448,
    "upfront_repayment_made": 1232.437007498,
    "upfront_repayment_balance": 78.1425895
  },
  "current_margin_requirement": {
    "maintenance_requirement": 6.9700358,
    "initial_buffer_percentage": 0,
    "initial_buffer_requirement": 6.9700358
  },
  "current_available": {
    "maintenance_available": 103.91748238,
    "initial_buffer_available": 103.91748238
  }
}

Get derivatives balances

Authorization

Path Parameters

Response

TypeScript