# Firecrawl API

Firecrawl API is an open-source web crawling and scraping API that converts websites into clean, Large Language Model (LLM)-ready data. It is open source and self-hosted, installable on Unraid and Proxmox.

Canonical page: https://ourlocalhost.com/app/272/firecrawl-api

## Description

Firecrawl API is an open-source web crawling and scraping API that converts websites into clean, Large Language Model (LLM)-ready data. It renders JavaScript-heavy pages, discovers relevant subpages, and extracts structured content including images and PDFs. Designed for homelab builders and AI developers seeking a self-hosted scraping backend. This container exposes the API endpoint and expects companion services (Playwright, Redis, RabbitMQ, PostgreSQL) on the firecrawl Docker network.

## Platform availability

Available on 2 of 9 platforms: Unraid, Proxmox.

## Health score

82/100 (Excellent), based on 4 of 4 factors.
- Maintained: 100 (last commit 14 days ago)
- Popular: 100 (189,447 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 70 (1 GB minimum RAM)

## Links

- Unraid: https://ca.unraid.net/apps/firecrawl-api-192zuxt0onrqn9?q=firecrawl-api
- GitHub: https://github.com/firecrawl/firecrawl
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=firecrawl
- Official website: https://firecrawl.dev
- Documentation: https://docs.firecrawl.dev

## Common questions

### Which ports should I expose for the Firecrawl container?

Expose port 3002 for the API HTTP endpoint. Ports 3004 and 3005 are internal to the container and do not need to be published to the host.

### Which companion services must the Firecrawl container find on the Docker network?

The container expects firecrawl-redis, firecrawl-rabbitmq, firecrawl-postgres, and firecrawl-playwright to be available on the firecrawl Docker network.

### Does the Python SDK require an API key?

Yes, create the Firecrawl client with your API key. Without it, scrape or crawl calls will fail.

### What should I check after self-hosting Firecrawl with Docker Compose?

Verify a local scrape, understand the open-source limits, and prepare the stack for production.

---
Source: Our Local Host (https://ourlocalhost.com/app/272/firecrawl-api), the self-hosted and open-source app directory.