Noviqa SDK

Appearance

staff.marginCalls ​

1 method on staff.marginCalls. Each returns the answer's data and throws NoviqaError on a failed answer.

list ​

GET/admin/v1/margin-calls

Accounts at margin call or stop out

Live money and levels of accounts, read from execution: by default those at or below their margin call level (stop outs included), each with its name and called_at (when it last reached the margin call level; zero while its status is ok). Rows are limited to trading accounts whose group is in the caller's group scope. trade.timeout when execution does not answer.

More details

Rights: the staff member needs every one of: risk.view.

Parameters
levelstring · query
margin_call (default): at or below the margin call level; stop_out: at or below the stop out level; all: every account.
margin_call stop_out all
groupstring · query
Group mask, e.g. real\*; empty = every group in scope.
Returns
Promise<AccountRisk[]>
The answer's data.
Errors
400invalid_input: invalid input
401auth.session_expired: session expired, sign in again
403auth.invalid_terminal: this terminal cannot be used here
403auth.otp_enrol_required: your group requires one-time codes: set them up to continue
403auth.password_change_required: you must change your password first
403forbidden: you do not have access to this action
500internal: something went wrong
504trade.timeout: request timed out
ts
import { staff } from "@/lib/noviqa"

const data = await staff.marginCalls.list({
  level: "margin_call",
  group: "string"
})
bash
curl -X GET "$NOVIQA_API_URL/admin/v1/margin-calls?level=margin_call&group=string" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": [
    {
      "called_at": "2026-09-25T10:15:00Z",
      "group": "real\\standard",
      "last_name": "Smith",
      "login": 1001,
      "money": {
        "agent_commission": "1.08452",
        "balance": "1000.00",
        "balance_prev_day": "1.08452",
        "balance_prev_month": "1.08452",
        "blocked_commission": "1.08452",
        "blocked_profit": "1.08452",
        "credit": "0.00",
        "currency": "USD",
        "currency_digits": 1,
        "day": "2026-09-25T10:15:00Z",
        "effective_leverage": "1.08452",
        "equity": "1012.40"
      },
      "name": "Ann Smith",
      "positions": 1,
      "risk": {
        "free_margin_mode": "ignore_pl",
        "level_type": "percent",
        "leverage": 100,
        "leverage_profile": "string",
        "margin_call_level": "1.08452",
        "margin_mode": "netting",
        "stop_out_level": "1.08452"
      },
      "status": "active"
    }
  ],
  "request_id": "5b7f2c1e"
}
ts
staff.marginCalls.list(query?: { level?, group? }, options?: RequestOptions): Promise<models.AccountRisk[]>