Skip to content

trader.language ​

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

retrieve ​

GET/trader/v1/language

Mail language

The language the account's mail and reports are written in: its own choice (language, empty = the group's), the group's default, the effective one and the available ones. Only the signed-in account is ever read: the login comes from the session, never from the request.

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<Language>
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.language.retrieve()
bash
curl -X GET "$NOVIQA_API_URL/trader/v1/language" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": {
    "available": [
      "string"
    ],
    "default": "string",
    "effective": "string",
    "language": "string"
  },
  "request_id": "5b7f2c1e"
}
ts
trader.language.retrieve(options?: RequestOptions): Promise<account.Language>

update ​

PUT/trader/v1/language

Choose the mail language

Sets the account's mail language to one of the available languages, or "" to follow the group's. language is required. Journaled. Answers the language as GET does. An investor (read-only) session is refused with trade.read_only.

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.
Request body
languagestring
one of the available languages, or "" to follow the group's language
Returns
Promise<Language>
The answer's data.
Errors
400invalid_input: invalid input
401auth.session_expired: session expired, sign in again
403auth.csrf_invalid: request refused: reload the page and try 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
403trade.read_only: read-only access cannot trade
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.language.update({
  language: "de"
})
bash
curl -X PUT "$NOVIQA_API_URL/trader/v1/language" \
  -H "Authorization: Bearer $NOVIQA_TOKEN" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "language": "de"
}'
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": {
    "available": [
      "string"
    ],
    "default": "string",
    "effective": "string",
    "language": "string"
  },
  "request_id": "5b7f2c1e"
}
ts
trader.language.update(body: http.docTraderLanguage, options?: RequestOptions): Promise<account.Language>