Noviqa SDK

Appearance

staff.overview ​

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

retrieve ​

GET/admin/v1/overview

Dashboard overview

Totals of the accounts in the caller's group scope: accounts, trading accounts online now, per group the stored balance, credit and open volume plus live equity, margin, floating profit and margin-call count, today's trade deals and the five most traded symbols. Amounts are per group in the group's currency, never added across groups. Today is the trading day on the server clock (day). When execution does not answer, live is false and the live amounts are 0.

More details

Rights: the staff member needs every one of: reports.

Returns
Promise<Overview>
The answer's data.
Errors
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
ts
import { staff } from "@/lib/noviqa"

const data = await staff.overview.retrieve()
bash
curl -X GET "$NOVIQA_API_URL/admin/v1/overview" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": {
    "accounts": 1,
    "at": "2026-09-25T10:15:00Z",
    "day": "2026-09-25T10:15:00Z",
    "deals_today": {
      "count": 1,
      "profit": "12.40",
      "volume": "0.10"
    },
    "groups": [
      {
        "accounts": 1,
        "balance": "1000.00",
        "buy_volume": "1.08452",
        "credit": "0.00",
        "currency": "USD",
        "equity": "1012.40",
        "group": "real\\standard",
        "margin": "108.45",
        "margin_calls": 1,
        "profit": "12.40",
        "sell_volume": "1.08452"
      }
    ],
    "live": true,
    "online": 1,
    "top_symbols": [
      {
        "deals": 1,
        "symbol": "EURUSD",
        "volume": "0.10"
      }
    ]
  },
  "request_id": "5b7f2c1e"
}
ts
staff.overview.retrieve(options?: RequestOptions): Promise<report.Overview>