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

const client = new BrandDev({
  apiKey: 'My API Key',
});

const brand = await client.brand.retrieve();

console.log(brand.brand);
{
  "status": "<string>",
  "brand": {
    "domain": "<string>",
    "title": "<string>",
    "description": "<string>",
    "slogan": "<string>",
    "colors": [
      {
        "hex": "<string>",
        "name": "<string>"
      }
    ],
    "logos": [
      {
        "url": "<string>",
        "mode": "light",
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123,
          "aspect_ratio": 123
        },
        "type": "icon"
      }
    ],
    "backdrops": [
      {
        "url": "<string>",
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123,
          "aspect_ratio": 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>"
    },
    "is_nsfw": true,
    "email": "<string>",
    "phone": "<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

Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cannot be used with name or ticker parameters.

name
string

Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporation'). Must be 3-30 characters. Cannot be used with domain or ticker parameters.

Required string length: 3 - 30
ticker
string

Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A'). Must be 1-6 characters, letters/numbers/dots only. Cannot be used with domain or name parameters.

Required string length: 1 - 6
force_language
enum<string>

Optional parameter to force the language of the retrieved brand data. Works with all three lookup methods.

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. Works with all three lookup methods.

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

The response is of type object.