Skip to main content
GET
/
brand
/
transaction_identifier
JavaScript
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 response = await client.brand.identifyFromTransaction({ transaction_info: 'transaction_info' });

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

transaction_info
string
required

Transaction information to identify the brand

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.

country_gl
enum<string>

Optional country code (GL parameter) to specify the country. This affects the geographic location used for search queries.

Available options:
ad,
ae,
af,
ag,
ai,
al,
am,
an,
ao,
aq,
ar,
as,
at,
au,
aw,
az,
ba,
bb,
bd,
be,
bf,
bg,
bh,
bi,
bj,
bm,
bn,
bo,
br,
bs,
bt,
bv,
bw,
by,
bz,
ca,
cc,
cd,
cf,
cg,
ch,
ci,
ck,
cl,
cm,
cn,
co,
cr,
cu,
cv,
cx,
cy,
cz,
de,
dj,
dk,
dm,
do,
dz,
ec,
ee,
eg,
eh,
er,
es,
et,
fi,
fj,
fk,
fm,
fo,
fr,
ga,
gb,
gd,
ge,
gf,
gh,
gi,
gl,
gm,
gn,
gp,
gq,
gr,
gs,
gt,
gu,
gw,
gy,
hk,
hm,
hn,
hr,
ht,
hu,
id,
ie,
il,
in,
io,
iq,
ir,
is,
it,
jm,
jo,
jp,
ke,
kg,
kh,
ki,
km,
kn,
kp,
kr,
kw,
ky,
kz,
la,
lb,
lc,
li,
lk,
lr,
ls,
lt,
lu,
lv,
ly,
ma,
mc,
md,
mg,
mh,
mk,
ml,
mm,
mn,
mo,
mp,
mq,
mr,
ms,
mt,
mu,
mv,
mw,
mx,
my,
mz,
na,
nc,
ne,
nf,
ng,
ni,
nl,
no,
np,
nr,
nu,
nz,
om,
pa,
pe,
pf,
pg,
ph,
pk,
pl,
pm,
pn,
pr,
ps,
pt,
pw,
py,
qa,
re,
ro,
rs,
ru,
rw,
sa,
sb,
sc,
sd,
se,
sg,
sh,
si,
sj,
sk,
sl,
sm,
sn,
so,
sr,
st,
sv,
sy,
sz,
tc,
td,
tf,
tg,
th,
tj,
tk,
tl,
tm,
tn,
to,
tr,
tt,
tv,
tw,
tz,
ua,
ug,
um,
us,
uy,
uz,
va,
vc,
ve,
vg,
vi,
vn,
vu,
wf,
ws,
ye,
yt,
za,
zm,
zw
city
string

Optional city name to prioritize when searching for the brand.

mcc
string

Optional Merchant Category Code (MCC) to help identify the business category/industry.

phone
number

Optional phone number from the transaction to help verify brand match.

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