Luxor Documentation Hub Logo
Derivatives/API Documentation

Positions

Retrieve position history for a specific currency type

GET
/api/v1/derivatives/positions/{currency_type}

Authorization

authorization<token>

Use your API key here.

In: header

Path Parameters

currency_typeRequiredstring

Currency type (e.g., BTC, USD)

Query Parameters

start_datestring

Start date for position history (YYYY-MM-DD format)

Pattern: "^\\d{4}-\\d{2}-\\d{2}$"Format: "date"
end_datestring

End date for position history (YYYY-MM-DD format)

Pattern: "^\\d{4}-\\d{2}-\\d{2}$"Format: "date"
page_sizeinteger

Number of items per page

Default: 50Minimum: 1Maximum: 100
page_numberinteger

Page number for pagination

Default: 1Minimum: 1
curl -X GET "https://app.luxor.tech/api/v1/derivatives/positions/<string>?start_date=2019-08-24&end_date=2019-08-24&page_size=50&page_number=1" \
  -H "authorization: <token>"

Position history

{
  "currency_type": "BTC",
  "start_date": "2025-09-01",
  "end_date": "2025-10-01",
  "summary": {
    "realized_gain_loss": 32.74492868,
    "unrealized_gain_loss": 0,
    "total_gain_loss": 32.74492868,
    "margin_requirement": 6.9700358
  },
  "positions": [
    {
      "date": "2025-09-11",
      "net_position_ph": -37249,
      "net_position_wavg": 0.00005466,
      "net_position_reference_rate": null,
      "wavg_long_hashprice": 0.00005466,
      "total_ph_long": 9551,
      "long_gain_loss": -3.37496788,
      "position_breakdown_reference_rate": null,
      "short_gain_loss": 4.01998183,
      "total_ph_short": 46800,
      "wavg_short_hashprice": 0.00005802,
      "unrealized_gain_loss": 0,
      "realized_gain_loss": 0.12599658,
      "total_gain_loss": 0.12599658,
      "initial_margin_percentage": 0.87,
      "maintenance_margin": 0.14,
      "upfront_long_ph": 1252,
      "margin_required": 0.12599658,
      "delivery_quota_ph": 870,
      "notional_delivery_quota": 4.2773539
    }
  ]
}

Previous

Payments

Next

Balances