Skip to main content
GET
/
brand
/
retrieve-by-ticker
JavaScript
import BrandDev from 'brand.dev';

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

const response = await client.brand.retrieveByTicker({ ticker: 'ticker' });

console.log(response.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>",
    "industries": {
      "eic": [
        {
          "industry": "Aerospace & Defense",
          "subindustry": "Defense Systems & Military Hardware"
        }
      ]
    },
    "links": {
      "careers": "<string>",
      "privacy": "<string>",
      "terms": "<string>",
      "contact": "<string>",
      "blog": "<string>",
      "pricing": "<string>"
    }
  },
  "code": 123
}

Authorizations

Authorization
string
header
required

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

Query Parameters

ticker
string
required

Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A'). Must be 1-15 characters, letters/numbers/dots only.

Required string length: 1 - 15
ticker_exchange
enum<string>

Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.

Available options:
AMEX,
AMS,
AQS,
ASX,
ATH,
BER,
BME,
BRU,
BSE,
BUD,
BUE,
BVC,
CBOE,
CNQ,
CPH,
DFM,
DOH,
DUB,
DUS,
DXE,
EGX,
FSX,
HAM,
HEL,
HKSE,
HOSE,
ICE,
IOB,
IST,
JKT,
JNB,
JPX,
KLS,
KOE,
KSC,
KUW,
LIS,
LSE,
MCX,
MEX,
MIL,
MUN,
NASDAQ,
NEO,
NSE,
NYSE,
NZE,
OSL,
OTC,
PAR,
PNK,
PRA,
RIS,
SAO,
SAU,
SES,
SET,
SGO,
SHH,
SHZ,
SIX,
STO,
STU,
TAI,
TAL,
TLV,
TSX,
TSXV,
TWO,
VIE,
WSE,
XETRA
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

Successful response

status
string

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

brand
object

Detailed brand information

code
integer

HTTP status code