---
title: "Crawl the URLs the site declares and map the links between them: orphans, undeclared pages, per-page status, canonical, text ratio, JSON-LD, noindex. Up to 300 pages in one pass; pages up to 500 (Watch, Studio) or 5000 (Agency, Network) runs as a background job in chunks of 300, advanced by every poll of /api/depth/{id} and every hour. Sites declaring more than the cap are sampled across path families. Licence-gated; 404 without a key. Returns 202 with a job id"
method: POST
path: "/api/depth"
---

# Crawl the URLs the site declares and map the links between them: orphans, undeclared pages, per-page status, canonical, text ratio, JSON-LD, noindex. Up to 300 pages in one pass; pages up to 500 (Watch, Studio) or 5000 (Agency, Network) runs as a background job in chunks of 300, advanced by every poll of /api/depth/{id} and every hour. Sites declaring more than the cap are sampled across path families. Licence-gated; 404 without a key. Returns 202 with a job id

`POST /api/depth`

## Request

- Base URL: `https://crawlcheck.io`
- URL: `https://crawlcheck.io/api/depth`
- Auth: one of:
  - API key in header `x-crawlcheck-key`
  - HTTP bearer

## Headers

- `x-crawlcheck-key` string, required

## Request body

- object
  - `domain` string, required
  - `pages` integer: Page cap; above 300 runs as a job

## Response `202`

{id, state, pages, job, url}; poll /api/depth/{id}

- object, nullable
  - `ok` boolean, nullable
  - `id` string, nullable
  - `domain` string, nullable
  - `state` string, nullable
  - `pages` number, nullable
  - `job` boolean, nullable
  - `url` string, nullable
  - `json` string, nullable

## Other responses

- `400`: No domain
- `404`: No valid licence key

---

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