Brand

One-call brand dossier

Runs several domain-keyed extractions in parallel and aggregates them into one response. Default parts: logo, estimated traffic, domain authority, Google ads, and the homepage as clean markdown (max 6 credits). Opt-in parts, requested explicitly via parts=: organic (organic keywords/traffic/rank), backlinks (backlink counts), registration (RDAP domain facts), agent_ready (llms.txt / agents.md / UCP probe) — 1 credit each. Each part succeeds or fails independently (parts.<name>.ok), so one blocked source never sinks the report. Credits = sum of successful, non-cached parts (cached parts are free). markdown is the combined report.

Credits: 6 (refunded on failure).

get/api/v1/brand

Request

  • Base URL: https://scrapewhale.dev
  • URL: https://scrapewhale.dev/api/v1/brand
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

domainstring required

The brand domain to profile. Accepts a bare domain or a full URL.

partsstring[]

Comma-separated parts. Default: logo, traffic, authority, ads, homepage. Opt-in extras: organic, backlinks, registration, agent_ready.

format'json' | 'markdown' | 'both'

Response shape: "json" (structured data only), "markdown" (markdown only), or "both".

Response

Success.

domainstring required
creditsChargedinteger required

Sum across successful, non-cached parts.

partsobject required

Keyed by part name (logo, traffic, authority, ads, homepage).

markdownstring

Combined brand report markdown.

Changes

No recorded changes to this operation across all 1 revision of this API.