Noviqa SDK

Appearance

trader.company ​

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

retrieve ​

GET/trader/v1/company

Company pages

The company name, website, e-mail and support pages of the account's group, with the [login] and [lang] macros filled. deposit_url and withdraw_url are empty for demo accounts. Group URLs take precedence over allocation settings. The selected links set uses the current persisted account/client country, never a country query parameter. An omitted language uses the account/client/group language. Reload after reconnect or focus to observe settings changes.

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.
langstring · query
Language code to fill [lang] with, e.g. en; when the link does not offer it, its first language is used.
Returns
Promise<Links>
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.company.retrieve({
  lang: "string"
})
bash
curl -X GET "$NOVIQA_API_URL/trader/v1/company?lang=string" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": {
    "company": "HS Markets Ltd",
    "deposit_url": "string",
    "email": "ann@example.com",
    "links": [
      {
        "caption": "string",
        "caption_type": 1,
        "sort": 1,
        "url": "string"
      }
    ],
    "support_email": "string",
    "support_url": "string",
    "website": "string",
    "withdraw_url": "string"
  },
  "request_id": "5b7f2c1e"
}
ts
trader.company.retrieve(query?: { lang? }, options?: RequestOptions): Promise<whitelabel.Links>