Docs menu

Brand API endpoint

Brand Retrieve API

Use Crawlora's Brand Retrieve API to extract supported public Brand data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.

GETapiKeyNo listed credit chargeBrandbrand.retrieveResponseDoc/brand/retrieve

Endpoint facts

Method: GET
API path: /brand/retrieve
Auth: apiKey
Credits: No listed credit charge
Platform: Brand
Response schema: #/definitions/brand.retrieveResponseDoc

Overview

Fetches a domain's homepage and extracts a normalized brand profile (title, description, colors, logos, backdrops, socials, links, and any schema.org organization data). Enrichment-only fields that are not present in the page markup are returned as null. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.

Brand platform page Try Brand Retrieve API in Playground Crawlora API pricing Brand API documentation

Request parameters

Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.

Parameter	Type	Required	Description
domain	string	Yes	Domain to retrieve brand data for, e.g. context.dev
force_language	string	No	Accepted for compatibility; not applied in HTML-only mode
maxSpeed	boolean	No	Optimize for speed by skipping schema.org and footer-link extraction
maxAgeMs	integer	No	Cache freshness window in milliseconds, clamps to 1 day..1 year
timeoutMS	integer	No	Upstream fetch timeout in milliseconds, clamps to 1000..300000
x-api-key (header)	string	Yes	API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/brand/retrieve?maxSpeed=true" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Authentication

Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.

Billing

Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.

Credit cost: No listed credit charge
Charged response: Successful 2xx responses

Plan	Price	Included credits	Daily cap	Rate limit	Overage
Free	$0/mo	2,000	500 daily credits	5/min	No overage
Starter	$9/mo	20,000	5,000 daily credits	15/min	$0.75/1,000 overage credits when enabled
Growth	$29/mo	100,000	25,000 daily credits	45/min	$0.45/1,000 overage credits when enabled
Pro	$79/mo	400,000	No daily cap	120/min	$0.30/1,000 overage credits
Business	$199/mo	1,200,000	No daily cap	300/min	$0.20/1,000 overage credits
Enterprise	$499/mo	5,000,000	No daily cap	1,000/min	$0.12/1,000 overage credits

Infrastructure behavior

This endpoint is executed through Crawlora's managed scraping infrastructure.

Proxy strategy: managed automatically where needed
Browser rendering: enabled for supported targets that require rendered HTML or JavaScript execution
Browser cluster: supported dynamic workloads can be routed through distributed browser instances
Retry behavior: automatic retry/fallback may be used depending on endpoint type
Challenge handling: challenged pages or unusable upstream HTML are detected and surfaced clearly when they cannot be used
Billing: credits are charged only for successful 2xx responses
Observability: responses include request context where available

Response behavior

Example response: ```json {"code":200,"msg":"OK","data":{"domain":"context.dev","title":"Context","description":"Brand intelligence for the modern web.","slogan":"Know every brand.","colors":[{"hex":"#0b0b0b"}],"logos":[{"url":"https://cdn.context.dev/logo.png","type":"logo"},{"url":"https://context.dev/favicon.ico","resolution":{"width":32,"height":32,"aspect_ratio":1},"type":"icon"}],"backdrops":[{"url":"https://cdn.context.dev/og.png"}],"socials":[{"type":"x","url":"https://x.com/context"},{"type":"linkedin","url":"https://www.linkedin.com/company/context"}],"address":{"street":"1 Market St","city":"San Francisco","country":"US","state_province":"CA","postal_code":"94105"},"stock":{"ticker":"CTXT","exchange":"NASDAQ"},"is_nsfw":false,"email":"[email protected]","phone":"+1-555-0100","links":{"careers":"https://context.dev/careers","privacy":"https://context.dev/legal/privacy","terms":"https://context.dev/terms","contact":"https://context.dev/contact","blog":"https://context.dev/blog","pricing":"https://context.dev/pricing"},"primary_language":"en","source":{"type":"html","url":"https://context.dev"}}} ```

Catalog quality warnings

missing example for required query param: domain

Error behavior

Crawlora does not silently return bad data when the upstream page cannot be used.

Status	Common failure case
400	Invalid input or missing required parameter
429	Plan or endpoint rate limit exceeded
500	Internal execution error
502	Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved

When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
404	Not Found	#/definitions/app.Response
408	Request Timeout	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "domain": "context.dev",
    "title": "Context",
    "description": "Brand intelligence for the modern web.",
    "slogan": "Know every brand.",
    "colors": [
      {
        "hex": "#0b0b0b"
      }
    ],
    "logos": [
      {
        "url": "https://cdn.context.dev/logo.png",
        "type": "logo"
      },
      {
        "url": "https://context.dev/favicon.ico",
        "resolution": {
          "width": 32,
          "height": 32,
          "aspect_ratio": 1
        },
        "type": "icon"
      }
    ],
    "backdrops": [
      {
        "url": "https://cdn.context.dev/og.png"
      }
    ],
    "socials": [
      {
        "type": "x",
        "url": "https://x.com/context"
      },
      {
        "type": "linkedin",
        "url": "https://www.linkedin.com/company/context"
      }
    ],
    "address": {
      "street": "1 Market St",
      "city": "San Francisco",
      "country": "US",
      "state_province": "CA",
      "postal_code": "94105"
    },
    "stock": {
      "ticker": "CTXT",
      "exchange": "NASDAQ"
    },
    "is_nsfw": false,
    "email": "[email protected]",
    "phone": "+1-555-0100",
    "links": {
      "careers": "https://context.dev/careers",
      "privacy": "https://context.dev/legal/privacy",
      "terms": "https://context.dev/terms",
      "contact": "https://context.dev/contact",
      "blog": "https://context.dev/blog",
      "pricing": "https://context.dev/pricing"
    },
    "primary_language": "en",
    "source": {
      "type": "html",
      "url": "https://context.dev"
    }
  }
}

Request schema

No body schema

Response schema

#/definitions/brand.retrieveResponseDoc

Field	Type	Required	Example
code	integer	No	200
data	brand.BrandResponse	No
data.address	brand.Address	No
data.address.city	string	No
data.address.country	string	No
data.address.country_code	string	No
data.address.postal_code	string	No
data.address.state_code	string	No
data.address.state_province	string	No
data.address.street	string	No
data.backdrops	array	No
data.backdrops[].colors	array	No
data.backdrops[].colors[].hex	string	No	#0b0b0b
data.backdrops[].colors[].name	string	No
data.backdrops[].resolution	brand.Resolution	No
data.backdrops[].resolution.aspect_ratio	number	No	1
data.backdrops[].resolution.height	integer	No	512
data.backdrops[].resolution.width	integer	No	512
data.backdrops[].url	string	No
data.colors	array	No
data.colors[].hex	string	No	#0b0b0b
data.colors[].name	string	No
data.description	string	No	Brand intelligence for the modern web.
data.domain	string	No	context.dev
data.email	string	No
data.industries	brand.Industries	No
data.industries.eic	array	No
data.industries.eic[].industry	string	No
data.industries.eic[].subindustry	string	No
data.is_nsfw	boolean	No	false
data.links	brand.Links	No
data.links.blog	string	No
data.links.careers	string	No
data.links.contact	string	No
data.links.pricing	string	No
data.links.privacy	string	No
data.links.terms	string	No
data.logos	array	No
data.logos[].colors	array	No
data.logos[].colors[].hex	string	No	#0b0b0b
data.logos[].colors[].name	string	No
data.logos[].mode	string	No
data.logos[].resolution	brand.Resolution	No
data.logos[].resolution.aspect_ratio	number	No	1
data.logos[].resolution.height	integer	No	512
data.logos[].resolution.width	integer	No	512
data.logos[].type	string	No	icon
data.logos[].url	string	No	https://context.dev/favicon.ico
data.phone	string	No
data.primary_language	string	No	en
data.slogan	string	No
data.socials	array	No
data.socials[].type	string	No	x
data.socials[].url	string	No	https://x.com/context
data.source	brand.SourceDetail	No
data.source.type	string	No	html
data.source.url	string	No	https://context.dev
data.stock	brand.Stock	No
data.stock.exchange	string	No	NASDAQ
data.stock.ticker	string	No	NVDA
data.title	string	No	Context
msg	string	No	OK

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/brand/retrieve?maxSpeed=true" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Responsible public web data workflows

Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.

Read Crawlora terms

More Brand endpoint docs Brand scraper API platform page Crawlora API pricing Try Brand Retrieve API in Playground

Open in Playground Back to group

Docs menu

Brand API endpoint

Brand Retrieve API

GETapiKeyNo listed credit chargeBrandbrand.retrieveResponseDoc/brand/retrieve

Endpoint facts

Method: GET
API path: /brand/retrieve
Auth: apiKey
Credits: No listed credit charge
Platform: Brand
Response schema: #/definitions/brand.retrieveResponseDoc

Overview

Brand platform page Try Brand Retrieve API in Playground Crawlora API pricing Brand API documentation

Request parameters

Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.

Parameter	Type	Required	Description
domain	string	Yes	Domain to retrieve brand data for, e.g. context.dev
force_language	string	No	Accepted for compatibility; not applied in HTML-only mode
maxSpeed	boolean	No	Optimize for speed by skipping schema.org and footer-link extraction
maxAgeMs	integer	No	Cache freshness window in milliseconds, clamps to 1 day..1 year
timeoutMS	integer	No	Upstream fetch timeout in milliseconds, clamps to 1000..300000
x-api-key (header)	string	Yes	API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/brand/retrieve?maxSpeed=true" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Authentication

Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.

Billing

Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.

Credit cost: No listed credit charge
Charged response: Successful 2xx responses

Plan	Price	Included credits	Daily cap	Rate limit	Overage
Free	$0/mo	2,000	500 daily credits	5/min	No overage
Starter	$9/mo	20,000	5,000 daily credits	15/min	$0.75/1,000 overage credits when enabled
Growth	$29/mo	100,000	25,000 daily credits	45/min	$0.45/1,000 overage credits when enabled
Pro	$79/mo	400,000	No daily cap	120/min	$0.30/1,000 overage credits
Business	$199/mo	1,200,000	No daily cap	300/min	$0.20/1,000 overage credits
Enterprise	$499/mo	5,000,000	No daily cap	1,000/min	$0.12/1,000 overage credits

Infrastructure behavior

This endpoint is executed through Crawlora's managed scraping infrastructure.

Proxy strategy: managed automatically where needed
Browser rendering: enabled for supported targets that require rendered HTML or JavaScript execution
Browser cluster: supported dynamic workloads can be routed through distributed browser instances
Retry behavior: automatic retry/fallback may be used depending on endpoint type
Challenge handling: challenged pages or unusable upstream HTML are detected and surfaced clearly when they cannot be used
Billing: credits are charged only for successful 2xx responses
Observability: responses include request context where available

Response behavior

Catalog quality warnings

missing example for required query param: domain

Error behavior

Crawlora does not silently return bad data when the upstream page cannot be used.

Status	Common failure case
400	Invalid input or missing required parameter
429	Plan or endpoint rate limit exceeded
500	Internal execution error
502	Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved

When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
404	Not Found	#/definitions/app.Response
408	Request Timeout	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "domain": "context.dev",
    "title": "Context",
    "description": "Brand intelligence for the modern web.",
    "slogan": "Know every brand.",
    "colors": [
      {
        "hex": "#0b0b0b"
      }
    ],
    "logos": [
      {
        "url": "https://cdn.context.dev/logo.png",
        "type": "logo"
      },
      {
        "url": "https://context.dev/favicon.ico",
        "resolution": {
          "width": 32,
          "height": 32,
          "aspect_ratio": 1
        },
        "type": "icon"
      }
    ],
    "backdrops": [
      {
        "url": "https://cdn.context.dev/og.png"
      }
    ],
    "socials": [
      {
        "type": "x",
        "url": "https://x.com/context"
      },
      {
        "type": "linkedin",
        "url": "https://www.linkedin.com/company/context"
      }
    ],
    "address": {
      "street": "1 Market St",
      "city": "San Francisco",
      "country": "US",
      "state_province": "CA",
      "postal_code": "94105"
    },
    "stock": {
      "ticker": "CTXT",
      "exchange": "NASDAQ"
    },
    "is_nsfw": false,
    "email": "[email protected]",
    "phone": "+1-555-0100",
    "links": {
      "careers": "https://context.dev/careers",
      "privacy": "https://context.dev/legal/privacy",
      "terms": "https://context.dev/terms",
      "contact": "https://context.dev/contact",
      "blog": "https://context.dev/blog",
      "pricing": "https://context.dev/pricing"
    },
    "primary_language": "en",
    "source": {
      "type": "html",
      "url": "https://context.dev"
    }
  }
}

Request schema

No body schema

Response schema

#/definitions/brand.retrieveResponseDoc

Field	Type	Required	Example
code	integer	No	200
data	brand.BrandResponse	No
data.address	brand.Address	No
data.address.city	string	No
data.address.country	string	No
data.address.country_code	string	No
data.address.postal_code	string	No
data.address.state_code	string	No
data.address.state_province	string	No
data.address.street	string	No
data.backdrops	array	No
data.backdrops[].colors	array	No
data.backdrops[].colors[].hex	string	No	#0b0b0b
data.backdrops[].colors[].name	string	No
data.backdrops[].resolution	brand.Resolution	No
data.backdrops[].resolution.aspect_ratio	number	No	1
data.backdrops[].resolution.height	integer	No	512
data.backdrops[].resolution.width	integer	No	512
data.backdrops[].url	string	No
data.colors	array	No
data.colors[].hex	string	No	#0b0b0b
data.colors[].name	string	No
data.description	string	No	Brand intelligence for the modern web.
data.domain	string	No	context.dev
data.email	string	No
data.industries	brand.Industries	No
data.industries.eic	array	No
data.industries.eic[].industry	string	No
data.industries.eic[].subindustry	string	No
data.is_nsfw	boolean	No	false
data.links	brand.Links	No
data.links.blog	string	No
data.links.careers	string	No
data.links.contact	string	No
data.links.pricing	string	No
data.links.privacy	string	No
data.links.terms	string	No
data.logos	array	No
data.logos[].colors	array	No
data.logos[].colors[].hex	string	No	#0b0b0b
data.logos[].colors[].name	string	No
data.logos[].mode	string	No
data.logos[].resolution	brand.Resolution	No
data.logos[].resolution.aspect_ratio	number	No	1
data.logos[].resolution.height	integer	No	512
data.logos[].resolution.width	integer	No	512
data.logos[].type	string	No	icon
data.logos[].url	string	No	https://context.dev/favicon.ico
data.phone	string	No
data.primary_language	string	No	en
data.slogan	string	No
data.socials	array	No
data.socials[].type	string	No	x
data.socials[].url	string	No	https://x.com/context
data.source	brand.SourceDetail	No
data.source.type	string	No	html
data.source.url	string	No	https://context.dev
data.stock	brand.Stock	No
data.stock.exchange	string	No	NASDAQ
data.stock.ticker	string	No	NVDA
data.title	string	No	Context
msg	string	No	OK

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/brand/retrieve?maxSpeed=true" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Responsible public web data workflows

Read Crawlora terms

More Brand endpoint docs Brand scraper API platform page Crawlora API pricing Try Brand Retrieve API in Playground

Open in Playground Back to group

Brand Retrieve API

Endpoint facts

Overview

Request parameters

cURL example

Authentication

Billing

Infrastructure behavior

Response behavior

Catalog quality warnings

Error behavior

Failure responses

Example JSON response

Code examples

Responsible public web data workflows

Related

Brand Retrieve API

Endpoint facts

Overview

Request parameters

cURL example

Authentication

Billing

Infrastructure behavior

Response behavior

Catalog quality warnings

Error behavior

Failure responses

Example JSON response

Code examples

Responsible public web data workflows

Related