GET/brand/retrieve

Retrieve brand data by domain

Retrieve logos, backdrops, colors, industry, description, and more from any domain

Context.dev·$0.03 per call

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "context-dev",
  path: "/brand/retrieve",
  query: {
    "domain": "example"
  }
});

console.log(output);

Query parameters

domainrequired

string

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

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).

Response

code

number

brand.email

string

brand.links.blog

string

brand.links.login

null

brand.links.terms

string

brand.links.signup

null

brand.links.careers

string

brand.links.contact

null

brand.links.pricing

string

brand.links.privacy

string

brand.logos.0.url

string

brand.logos.0.mode

string

brand.logos.0.type

string

brand.logos.0.colors.0.hex

string

brand.logos.0.colors.0.name

string

brand.logos.0.resolution.width

number

brand.logos.0.resolution.height

number

brand.logos.0.resolution.aspect_ratio

number

brand.title

string

brand.colors.0.hex

string

brand.colors.0.name

string

brand.domain

string

brand.slogan

string

brand.address.city

string

brand.address.country

string

brand.address.country_code

string

brand.is_nsfw

boolean

brand.socials.0.url

string

brand.socials.0.type

string

brand.backdrops.0.url

string

brand.backdrops.0.colors.0.hex

string

brand.backdrops.0.colors.0.name

string

brand.backdrops.0.resolution.width

number

brand.backdrops.0.resolution.height

number

brand.backdrops.0.resolution.aspect_ratio

number

brand.industries.eic.0.industry

string

brand.industries.eic.0.subindustry

string

brand.description

string

brand.primary_language

string

status

string

key_metadata.credits_consumed

number

key_metadata.credits_remaining

number