staff.branding

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

getAdminV1Branding

GET/admin/v1/branding

The brand of this domain (staff)

Public, read before sign-in: company name, colors, image URLs and default symbols of the white label that owns the host the app was opened on (the Origin header, else the host). ?domain= asks for another host.

Parameters

domainstring · query

Host name to resolve instead of the request's own.

Returns

Promise<brandView>

The answer's data.

Errors

400invalid_input: invalid input

500internal: something went wrong

SDKcURL

import { staff } from "@/lib/noviqa"

const data = await staff.branding.getAdminV1Branding({
  domain: "string"
})

bash

curl -X GET "$NOVIQA_API_URL/admin/v1/branding?domain=string" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"

Response 200

json

{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": {
    "address": "1 High St",
    "allocations": [
      {
        "allocation_id": 1,
        "countries": [
          "string"
        ],
        "currency": "USD",
        "default_leverage": 1,
        "description": "string",
        "kind": "string",
        "leverages": [
          1
        ]
      }
    ],
    "banner_url": "string",
    "color_accent": "string",
    "color_primary": "string",
    "color_secondary": "string",
    "company": "HS Markets Ltd",
    "default_symbols": [
      "string"
    ],
    "demo_url": "string",
    "deposit_url": "string",
    "eula_url": "string",
    "icon_url": "string"
  },
  "request_id": "5b7f2c1e"
}

staff.branding.getAdminV1Branding(query?: { domain? }, options?: RequestOptions): Promise<http.brandView>

getAdminV1BrandingIdImage

GET/admin/v1/branding/{id}/{image}

A brand image (staff)

Public. The URL comes from the branding answer and changes with each edit, so the image is cached for a day.

Parameters

idinteger · pathrequired

Numeric id.

imagestring · pathrequired

logo banner icon

Returns

Promise<Response>