Brand

Retrieve brand data by domain

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.

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

Query parameters

domainstring required

Domain to retrieve brand data for, e.g. context.dev

force_languagestring

Accepted for compatibility; not applied in HTML-only mode

maxSpeedboolean

Optimize for speed by skipping schema.org and footer-link extraction

maxAgeMsinteger

Cache freshness window in milliseconds, clamps to 1 day..1 year

timeoutMSinteger

Upstream fetch timeout in milliseconds, clamps to 1000..300000

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "backdrops": [
      {
        "colors": [
          {
            "hex": "#0b0b0b"
          }
        ],
        "resolution": {
          "aspect_ratio": 1,
          "height": 512,
          "width": 512
        }
      }
    ],
    "colors": [
      {
        "hex": "#0b0b0b"
      }
    ],
    "description": "Brand intelligence for the modern web.",
    "domain": "context.dev",
    "logos": [
      {
        "colors": [
          {
            "hex": "#0b0b0b"
          }
        ],
        "resolution": {
          "aspect_ratio": 1,
          "height": 512,
          "width": 512
        },
        "type": "icon",
        "url": "https://context.dev/favicon.ico"
      }
    ],
    "primary_language": "en",
    "socials": [
      {
        "type": "x",
        "url": "https://x.com/context"
      }
    ],
    "source": {
      "type": "html",
      "url": "https://context.dev"
    },
    "stock": {
      "exchange": "NASDAQ",
      "ticker": "NVDA"
    },
    "title": "Context"
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.