Endpoint Playground

Try the Brand Retrieve API

Test Crawlora's Brand Retrieve API with realistic prefilled parameters. Generate a cURL request, inspect the expected structured JSON response, and open the full docs or pricing page when you are ready to integrate this public web data extraction endpoint into your application.

Endpoint facts

Method: GET
API path: /brand/retrieve
Platform: Brand
Auth: apiKey
Credits: No listed credit charge
Required params: domain
Common optional params: force_language, maxSpeed, maxAgeMs, timeoutMS

Brand Retrieve API documentation Brand platform page Crawlora API pricing

Prefilled cURL

curl "https://api.crawlora.net/api/v1/brand/retrieve?domain=<domain>" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters visible to crawlers

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

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"
    }
  }
}

Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

1 shown

Group

Method

Auth

Endpoint

GETapiKeyNo listed credit chargebrand.retrieveResponseDocBrand

GET /brand/retrieve

Retrieve brand data by domain

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.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Required query parameters

domain

requiredstring

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

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "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"
    }
  }
}

Endpoint details

Method: GET
Path: /brand/retrieve
Authentication: apiKey
Credit cost: No listed credit charge
Platform: Brand
Parameters: 6 documented fields

Request parameters

domain:queryforce_language:querymaxSpeed:querymaxAgeMs:querytimeoutMS:queryx-api-key:header

Response schema fields

codedatadata.addressdata.address.citydata.address.countrydata.address.country_codedata.address.postal_codedata.address.state_codedata.address.state_provincedata.address.streetdata.backdropsdata.backdrops[].colors

Sample response summary

{
  "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"
    }
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/brand/retrieve?domain=<domain>" \
  -H "x-api-key: $CRAWLORA_API_KEY"

View endpoint docs Open platform page Browse all endpoints Pricing

Try the Brand Retrieve API

Endpoint facts

Method: GET
API path: /brand/retrieve
Platform: Brand
Auth: apiKey
Credits: No listed credit charge
Required params: domain
Common optional params: force_language, maxSpeed, maxAgeMs, timeoutMS

Brand Retrieve API documentation Brand platform page Crawlora API pricing

Prefilled cURL

curl "https://api.crawlora.net/api/v1/brand/retrieve?domain=<domain>" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters visible to crawlers

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

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"
    }
  }
}

Retrieve brand data by domain

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

{ "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" } } }

Endpoint details

Method: GET
Path: /brand/retrieve
Authentication: apiKey
Credit cost: No listed credit charge
Platform: Brand
Parameters: 6 documented fields

Request parameters

domain:queryforce_language:querymaxSpeed:querymaxAgeMs:querytimeoutMS:queryx-api-key:header

Response schema fields

Sample response summary

{
  "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"
    }
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/brand/retrieve?domain=<domain>" \
  -H "x-api-key: $CRAWLORA_API_KEY"

View endpoint docs Open platform page Browse all endpoints Pricing