# BeeCrawl

> Self-hostable web scraping, crawling, search, and extraction API.

## Docs

- [Cancel a batch scrape](https://docs.beecrawl.dev/api-reference/async-jobs/cancel-a-batch-scrape.md)
- [Cancel a crawl](https://docs.beecrawl.dev/api-reference/async-jobs/cancel-a-crawl.md)
- [Get batch scrape status and results](https://docs.beecrawl.dev/api-reference/async-jobs/get-batch-scrape-status-and-results.md)
- [Get crawl status and results](https://docs.beecrawl.dev/api-reference/async-jobs/get-crawl-status-and-results.md)
- [Start a batch scrape](https://docs.beecrawl.dev/api-reference/async-jobs/start-a-batch-scrape.md)
- [Start an asynchronous crawl](https://docs.beecrawl.dev/api-reference/async-jobs/start-an-asynchronous-crawl.md)
- [Map a site](https://docs.beecrawl.dev/api-reference/discovery/map-a-site.md)
- [Extract structured data](https://docs.beecrawl.dev/api-reference/extraction/extract-structured-data.md)
- [Check API health](https://docs.beecrawl.dev/api-reference/scraping/check-api-health.md)
- [Scrape a page](https://docs.beecrawl.dev/api-reference/scraping/scrape-a-page.md)
- [Search the web](https://docs.beecrawl.dev/api-reference/search/search-the-web.md)
- [Asynchronous jobs](https://docs.beecrawl.dev/docs/async-jobs.md): Submit and poll crawls and batch scrapes.
- [Authentication](https://docs.beecrawl.dev/docs/authentication.md): Configure API key authentication for BeeCrawl.
- [Browser rendering](https://docs.beecrawl.dev/docs/browser-rendering.md): Understand the automatic Playwright rendering path.
- [Firecrawl compatibility](https://docs.beecrawl.dev/docs/firecrawl-compatibility.md): Keep existing Firecrawl v2 SDK integrations pointed at BeeCrawl.
- [BeeCrawl](https://docs.beecrawl.dev/docs/introduction.md): A small, self-hostable API for extracting useful data from the web.
- [Quickstart](https://docs.beecrawl.dev/docs/quickstart.md): Run BeeCrawl locally and make your first API request.
- [Node.js SDK](https://docs.beecrawl.dev/docs/sdk-node.md): Use BeeCrawl from Node.js and TypeScript.
- [Python SDK](https://docs.beecrawl.dev/docs/sdk-python.md): Use BeeCrawl from Python.
- [Rust SDK](https://docs.beecrawl.dev/docs/sdk-rust.md): Use BeeCrawl from Rust with an async HTTP client.
- [Self-hosting](https://docs.beecrawl.dev/docs/self-hosting.md): Deploy the BeeCrawl API, worker, browser engine, and Postgres.

## OpenAPI Specs

- [openapi](https://docs.beecrawl.dev/docs/openapi.yaml)