Noviqa SDK

Appearance

staff.accountOverrides ​

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

list ​

GET/admin/v1/account-overrides

List explicit individual settings

Paginated flat explicit selections only, scoped by account group and hidden-account rights. login and symbol_id are exact filters; group is an optional mask. Default limit 100, maximum 500; offset starts at zero. Values preserve explicit false, zero and nullable choices.

More details

Rights: the staff member needs every one of: accounts.overrides.view.

Parameters
logininteger · query
groupstring · query
symbol_idinteger · query
limitinteger · query
offsetinteger · query
Returns
Promise<OverridePage>
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
ts
import { staff } from "@/lib/noviqa"

const data = await staff.accountOverrides.list({
  login: 1001,
  group: "string",
  symbol_id: 1
})
bash
curl -X GET "$NOVIQA_API_URL/admin/v1/account-overrides?login=1001&group=string&symbol_id=1" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": {
    "items": [
      {
        "commission_id": 1,
        "field": "string",
        "group": "real\\standard",
        "login": 1001,
        "policy_revision": 1,
        "scope": "string",
        "symbol": "EURUSD",
        "symbol_id": 1,
        "value": null,
        "version": 1
      }
    ],
    "limit": 1,
    "offset": 1,
    "total": 1
  },
  "request_id": "5b7f2c1e"
}
ts
staff.accountOverrides.list(query?: { login?, group?, symbol_id?, limit?, offset? }, options?: RequestOptions): Promise<account.OverridePage>