GET
/
brand
/
retrieve
import BrandDev from 'brand.dev';

const client = new BrandDev({
  apiKey: process.env['BRAND_DEV_API_KEY'], // This is the default and can be omitted
});

const brand = await client.brand.retrieve({ domain: 'domain' });

console.log(brand.brand);
{
  "status": "<string>",
  "brand": {
    "domain": "<string>",
    "title": "<string>",
    "description": "<string>",
    "slogan": "<string>",
    "colors": [
      {
        "hex": "<string>",
        "name": "<string>"
      }
    ],
    "logos": [
      {
        "url": "<string>",
        "mode": "<string>",
        "group": 123,
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123
        }
      }
    ],
    "backdrops": [
      {
        "url": "<string>",
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123
        }
      }
    ],
    "socials": [
      {
        "type": "<string>",
        "url": "<string>"
      }
    ],
    "address": {
      "street": "<string>",
      "city": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "state_province": "<string>",
      "state_code": "<string>",
      "postal_code": "<string>"
    },
    "stock": {
      "ticker": "<string>",
      "exchange": "<string>"
    },
    "fonts": [
      {
        "usage": "<string>",
        "name": "<string>"
      }
    ]
  },
  "code": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
domain
string
required

Domain name to retrieve brand data for

​
force_language
enum<string>

Optional parameter to force the language of the retrieved brand data

Available options:
albanian,
arabic,
azeri,
bengali,
bulgarian,
cebuano,
croatian,
czech,
danish,
dutch,
english,
estonian,
farsi,
finnish,
french,
german,
hausa,
hawaiian,
hindi,
hungarian,
icelandic,
indonesian,
italian,
kazakh,
kyrgyz,
latin,
latvian,
lithuanian,
macedonian,
mongolian,
nepali,
norwegian,
pashto,
pidgin,
polish,
portuguese,
romanian,
russian,
serbian,
slovak,
slovene,
somali,
spanish,
swahili,
swedish,
tagalog,
turkish,
ukrainian,
urdu,
uzbek,
vietnamese,
welsh
​
maxSpeed
boolean

Optional parameter to optimize the API call for maximum speed. When set to true, the API will skip time-consuming operations for faster response at the cost of less comprehensive data.

​
timeoutMS
integer

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Required range: 1 <= x <= 300000

Response

200
application/json

Successful response

​
status
string

Status of the response, e.g., 'ok'

​
brand
object

Detailed brand information

​
code
integer

HTTP status code