Developer Portal
Trader APIsHTTP APITrading

Account MetricsGET

Returns latest metrics snapshot for the authenticated user's account (PnL, Equity, Balance, Margins)

View as Markdown
GET
/accounts/{account_id}/metrics

Authorization

AuthorizationRequiredBearer <token>

JWT token obtained from the login endpoint

In: header

Path Parameters

account_idRequiredstring

Account ID to fetch metrics for

curl -X GET "http://localhost:8081/api/v1/accounts/acc_123456/metrics" \
  -H "Authorization: Bearer <token>"

Successfully retrieved account metrics

{
  "account_id": "acc_123456",
  "timestamp": 1707849123456,
  "pnl": 1250.5,
  "equity": 101250.5,
  "balance": 100000,
  "credit": 500,
  "used_margin": 5000,
  "free_margin": 96250.5,
  "margin_level": 2025.01,
  "position_pnl_by_id": {
    "pos_001": 500.25,
    "pos_002": 750.25
  },
  "prices": {
    "pos_001": 1.23456,
    "pos_002": 1.23789
  }
}

Double Position

Places a market order matching the position's symbol, side, and remaining open quantity. When the order fills, the resulting deal is merged into the existing position (VWAP recalculation + quantity increase).

Margin Preview

Advisory preview of the additional margin needed to open `volume` lots of `symbol_id` as a market BUY and as a market SELL, priced at the current bid. Account, group, symbol and access status, holidays and quotes are checked as for a BUY; trading sessions, volume limits, exposure limits, price protection and long-only restrictions on SELL are not, so an order can still be rejected. Pending orders are margin-checked when they trigger, not when placed. `required_margin` is clamped at 0, while `used_margin_after` and `free_margin_after` reflect margin released by hedging.