---
title: "Start Site Crawl"
method: POST
path: "/crawl"
---

# Start Site Crawl

`POST /crawl`

## Request

- Base URL: `https://seoscoreapi.com` (the document declares no server; this is the origin it was published from)
- URL: `https://seoscoreapi.com/crawl`
- Auth: none declared. Required headers: `X-API-Key`

Start a multi-page crawl of one site (async).

Follows same-site links from `url`, plus the URLs in the sitemap, up to your page cap,
and reports broken pages, redirects, duplicate titles and headings, pages missing a
title or heading, orphan pages (in the sitemap, linked from nowhere crawled) and slow
pages. Plain HTTP requests, 4 at a time, robots.txt honoured.

**Limits.** Pro: 25 pages per crawl, 20 crawls a month. Ultra: 100 pages, 100 crawls a
month. Any other plan: one Deep Audit credit covers a 25-page crawl. A failed crawl is
not counted and a credit is returned.

Returns `job_id`; poll `GET /crawl/{job_id}`. `site_map` is a shareable page with the
site diagram once the crawl has finished.

## Headers

- `X-API-Key` string, required: Your API key

## Request body

- CrawlRequest
  - `url` string, required: Where to start (e.g., https://example.com)
  - `max_pages` integer, nullable: Fewer pages than your plan's cap, if you want

## Response `202`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/seoscoreapi/apis/seo-score-api.md) · [All operations](https://skmtc.dev/seoscoreapi/apis/seo-score-api/llms.txt) · [OpenAPI document](https://skmtc.dev/seoscoreapi/apis/seo-score-api/revisions/877a3044b5be?raw)