Noviqa SDK

Appearance

trader.symbols ​

3 methods on trader.symbols. Each returns the answer's data and throws NoviqaError on a failed answer.

list ​

GET/trader/v1/symbols

Tradable symbols

Every symbol the account's group may trade, after the group's symbol settings (volumes, stops and freeze levels, allowed order types, fill policies and expirations, swaps, sessions), ordered by path.

Parameters
X-HST-Accountstring · header
Intended signed-in login captured by the browser tab before dispatch and retained across retries. A mismatch returns auth.account_changed (409) before mutation or refresh rotation. This never selects or authorizes an account; omission preserves existing API client compatibility.
Returns
Promise<Symbol[]>
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
409auth.account_changed: the signed-in account changed; sign in again before continuing
500internal: something went wrong
ts
import { trader } from "@/lib/noviqa"

const data = await trader.symbols.list()
bash
curl -X GET "$NOVIQA_API_URL/trader/v1/symbols" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": [
    {
      "allowed_expirations": [
        "string"
      ],
      "allowed_fill_policies": [
        "string"
      ],
      "allowed_order_types": [
        "string"
      ],
      "background_color": "string",
      "base_currency": "string",
      "base_currency_digits": 1,
      "basis_symbol": "string",
      "book_depth": 1,
      "calc_type": "forex",
      "category": "string",
      "cfi_code": "string",
      "chart_price": "bid"
    }
  ],
  "request_id": "5b7f2c1e"
}
ts
trader.symbols.list(options?: RequestOptions): Promise<market.Symbol[]>

retrieve ​

GET/trader/v1/symbols/{id}

One tradable symbol

One symbol as the account's group trades it. not_found when the symbol does not exist or the group does not trade it.

Parameters
X-HST-Accountstring · header
Intended signed-in login captured by the browser tab before dispatch and retained across retries. A mismatch returns auth.account_changed (409) before mutation or refresh rotation. This never selects or authorizes an account; omission preserves existing API client compatibility.
idinteger · pathrequired
Numeric id.
Returns
Promise<Symbol>
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
404not_found: not found
409auth.account_changed: the signed-in account changed; sign in again before continuing
500internal: something went wrong
ts
import { trader } from "@/lib/noviqa"

const data = await trader.symbols.retrieve(1)
bash
curl -X GET "$NOVIQA_API_URL/trader/v1/symbols/1" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": {
    "allowed_expirations": [
      "string"
    ],
    "allowed_fill_policies": [
      "string"
    ],
    "allowed_order_types": [
      "string"
    ],
    "background_color": "string",
    "base_currency": "string",
    "base_currency_digits": 1,
    "basis_symbol": "string",
    "book_depth": 1,
    "calc_type": "forex",
    "category": "string",
    "cfi_code": "string",
    "chart_price": "bid"
  },
  "request_id": "5b7f2c1e"
}
ts
trader.symbols.retrieve(id: number, options?: RequestOptions): Promise<market.Symbol>

sessions ​

GET/trader/v1/symbols/{id}/sessions

Symbol sessions and holidays

The symbol's weekly quote and trade sessions (UTC, the clock validation checks), the holidays of the next 30 days that close it (server time), whether it trades now, and when closed the next trade session opening (RFC3339; holidays do not move it). not_found when the group does not trade the symbol.

Parameters
X-HST-Accountstring · header
Intended signed-in login captured by the browser tab before dispatch and retained across retries. A mismatch returns auth.account_changed (409) before mutation or refresh rotation. This never selects or authorizes an account; omission preserves existing API client compatibility.
idinteger · pathrequired
Numeric id.
Returns
Promise<SymbolSessions>
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
404not_found: not found
409auth.account_changed: the signed-in account changed; sign in again before continuing
500internal: something went wrong
ts
import { trader } from "@/lib/noviqa"

const data = await trader.symbols.sessions(1)
bash
curl -X GET "$NOVIQA_API_URL/trader/v1/symbols/1/sessions" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": {
    "currently_open": true,
    "holidays": [
      {
        "date": "string",
        "effect": "string",
        "end_time": "string",
        "id": "string",
        "is_full_day": true,
        "name": "Ann Smith",
        "start_time": "string"
      }
    ],
    "next_session_open_at": "string",
    "sessions": [
      {
        "close_time": "string",
        "day_of_week": 1,
        "open_time": "string",
        "session_type": "string"
      }
    ],
    "symbol_id": "string",
    "ts_ns": 1
  },
  "request_id": "5b7f2c1e"
}
ts
trader.symbols.sessions(id: number, options?: RequestOptions): Promise<market.SymbolSessions>