---
title: "Retrieve brand data by domain"
method: GET
path: "/brand/retrieve"
tags: ["Brand"]
---

# Retrieve brand data by domain

`GET /brand/retrieve`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/brand/retrieve`
- Auth: API key in header `x-api-key`

Returns a brand profile for a domain (title, description, brand colors as hex, logos and icons ranked best-first, backdrops, socials, links, and any schema.org organization data). Enrichment-only fields that are not present in the page markup are returned as null.

## Query parameters

- `domain` string, required
- `force_language` string
- `maxSpeed` boolean
- `maxAgeMs` integer
- `timeoutMS` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- BrandRetrieveResponseDoc
  - `code` integer
  - `data` BrandBrandResponse
    - `address` BrandAddress
      - `city` string: City of the brand's office.
      - `country` string: Country of the brand's office.
      - `country_code` string: Country code of the brand's office.
      - `postal_code` string: Postal code of the brand's office.
      - `state_code` string: State or province code of the brand's office.
      - `state_province` string: State or province of the brand's office.
      - `street` string: Street address of the brand's office.
    - `backdrops` BrandBackdrop[]: Large images that represent the brand, such as the social sharing image.
      - `colors` BrandColor[]: Dominant colors of the backdrop image. Not currently returned.
        - `hex` string: Color as a lowercase hex code, for example `#0b0b0b`.
        - `name` string: Name of the color. Not currently returned.
      - `resolution` BrandResolution
        - `aspect_ratio` number: Width divided by height.
        - `height` integer: Height of the image in pixels.
        - `width` integer: Width of the image in pixels.
      - `url` string: URL of the backdrop image.
    - `colors` BrandColor[]: Brand colors found on the site, each as a hex code.
      - `hex` string: Color as a lowercase hex code, for example `#0b0b0b`.
      - `name` string: Name of the color. Not currently returned.
    - `description` string: Short description of the brand, taken from the site.
    - `domain` string: Domain that was profiled, without `www.` or path.
    - `email` string: Contact email the site lists. Omitted when none is found.
    - `industries` BrandIndustries
      - `eic` BrandEIC[]: Industry and sub-industry classifications of the brand.
        - `industry` string: Industry the brand belongs to.
        - `subindustry` string: More specific sub-industry within that industry.
    - `is_nsfw` boolean: Always `false`; adult-content detection is not performed.
    - `links` BrandLinks
      - `blog` string: URL of the brand's blog. `null` when no matching link is found.
      - `careers` string: URL of the brand's careers page. `null` when no matching link is found.
      - `contact` string: URL of the brand's contact page. `null` when no matching link is found.
      - `pricing` string: URL of the brand's pricing page. `null` when no matching link is found.
      - `privacy` string: URL of the brand's privacy policy. `null` when no matching link is found.
      - `terms` string: URL of the brand's terms page. `null` when no matching link is found.
    - `logos` BrandLogo[]: Logos and icons of the brand, with the declared brand mark first.
      - `colors` BrandColor[]: Dominant colors of the logo image. Not currently returned.
        - `hex` string: Color as a lowercase hex code, for example `#0b0b0b`.
        - `name` string: Name of the color. Not currently returned.
      - `mode` string: Display mode the logo variant is meant for. Not currently returned.
      - `resolution` BrandResolution
        - `aspect_ratio` number: Width divided by height.
        - `height` integer: Height of the image in pixels.
        - `width` integer: Width of the image in pixels.
      - `theme` string: Theme is the intended background for the candidate. It stays separate from the established Mode response field.
      - `type` string: Kind of image: `logo` for the declared brand mark or `icon` for a site icon.
      - `url` string: URL of the logo or icon image.
    - `phone` string: Contact phone number the site lists. Omitted when none is found.
    - `primary_language` string: Primary language of the site, as a language code such as `en`. Omitted when unknown.
    - `slogan` string: Tagline or slogan of the brand. Omitted when the site gives none.
    - `socials` BrandSocial[]: Social media profiles the site links to.
      - `type` string: Social network the profile is on, for example `x` or `linkedin`.
      - `url` string: URL of the social media profile.
    - `source` BrandSourceDetail
      - `type` string: Kind of source the profile was built from, for example `html`.
      - `url` string: URL of the page the profile was built from, after any redirect.
    - `stock` BrandStock
      - `exchange` string: Stock exchange the brand is listed on, for example `NASDAQ`.
      - `ticker` string: Stock ticker symbol of the brand, for example `NVDA`.
    - `title` string: Brand name, preferring the site name over the page title.
  - `msg` string

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `408`: Request Timeout
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/028417aa35bb?raw)