# OctoCrawl

> OctoCrawl turns a public web page into readable Markdown and, on supported pages, fields you can check against the source. It reports blocks, timeouts and missing fields with a reason instead of inventing content. It is open source (AGPL-3.0) and runs on your own computer through REST, a TypeScript SDK or MCP.

Try one public page in the browser at https://octocrawl.dev/ (three previews a day). The source code is at https://github.com/77777R7/w2l.

## Get started

- [Introduction](https://octocrawl.dev/docs/index.md): Try OctoCrawl with one public URL and learn what a verified result looks like.
- [Connect MCP](https://octocrawl.dev/docs/connect-mcp/index.md): Choose an MCP client, copy its local OctoCrawl setup, and run a first task.

## Guides

- [Extract a public page](https://octocrawl.dev/docs/guides/extract-page/index.md): Get readable Markdown, a final URL, status, and elapsed time from a public web page.
- [Amazon.sg product JSON](https://octocrawl.dev/docs/guides/amazon-product/index.md): Check a product ASIN, Singapore delivery region, currency, and missing fields.
- [Monitor to HTTPS Webhook](https://octocrawl.dev/docs/guides/monitor-webhook/index.md): Create a document Monitor and verify durable delivery by eventId.
- [Page through batch results](https://octocrawl.dev/docs/guides/batch-results/index.md): Queue a durable URL batch and inspect every result through pagination.

## Reference

- [Limits and result states](https://octocrawl.dev/docs/limits/index.md): Understand preview quotas, supported sites, incomplete fields, blocks, and timeouts.
- [Advanced reference](https://octocrawl.dev/docs/reference/index.md): Find REST, SDK, and self-hosted entry points after your first OctoCrawl result.

## Project

- [Privacy](https://octocrawl.dev/docs/privacy/index.md): What the public OctoCrawl page records about a visit and a preview, what it never records, and how long it keeps it.

## Optional

- [All documentation in one file](https://octocrawl.dev/llms-full.txt)