---
title: "One-call brand dossier"
method: GET
path: "/api/v1/brand"
tags: ["Brand"]
---

# One-call brand dossier

`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`

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).

## Query parameters

- `domain` string, required
- `parts` string[]
- `format` 'json' | 'markdown' | 'both'

## Response `200`

Success.

- BrandReport: Aggregated brand dossier. Each part succeeds or fails independently; `markdown` is the combined report (omitted when format=json).
  - `domain` string, required
  - `creditsCharged` integer, required: Sum across successful, non-cached parts.
  - `parts` object, required: Keyed by part name (logo, traffic, authority, ads, homepage).
  - `markdown` string: Combined brand report markdown.

## Other responses

- `400`: Invalid parameters.
- `401`: Missing or invalid API key.
- `402`: Insufficient credits.
- `422`: Extraction/conversion failed — credits refunded. `code` carries the failure category.
- `429`: Rate limit exceeded (60 requests/min per key).

---

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