# Firecrawl — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API |
> |---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Web scraping, crawling, and structured data extraction API.

**Category:** Web Scraping | **Website:** [firecrawl.dev](https://firecrawl.dev) | **Docs:** [docs.firecrawl.dev](https://docs.firecrawl.dev)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/firecrawl/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### Scrape

Scrape a single URL and return its content in markdown or structured formats.

**Estimated cost:** $0.003+

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | URL to scrape |
| `formats` | string[] | No | Output formats (e.g. 'markdown', 'json') |
| `actions` | object[] | No | Browser actions to perform before scraping |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/firecrawl/scrape \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>","formats":"<string[]>","actions":"<object[]>"}'
```

### Crawl

Crawl a website starting from a URL, following links up to a configurable limit.

**Estimated cost:** $0.01+

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Starting URL to crawl |
| `limit` | number | No | Max pages to crawl (default 10) |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/firecrawl/crawl \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>","limit":"<number>"}'
```

### Crawl Status

Check the status of an ongoing crawl job.

**Estimated cost:** Free

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `id` | string | Yes | Crawl job ID |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/firecrawl/crawl-status \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"<string>"}'
```

### Map

Discover all URLs on a website without scraping their content.

**Estimated cost:** $0.004

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | URL to map |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/firecrawl/map \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### Extract

Extract structured data from one or more URLs using AI.

**Estimated cost:** $0.007+

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `urls` | string[] | Yes | URLs to extract data from |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/firecrawl/extract \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":"<string[]>"}'
```

### Extract Status

Check the status of an extraction job.

**Estimated cost:** Free

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `id` | string | Yes | Extract job ID |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/firecrawl/extract-status \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"<string>"}'
```

### Batch Scrape

Scrape multiple URLs in a single batch request.

**Estimated cost:** $0.003+/url

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `urls` | string[] | Yes | URLs to scrape |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/firecrawl/batch-scrape \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":"<string[]>"}'
```

### Batch Scrape Status

Check the status of a batch scrape job.

**Estimated cost:** Free

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `id` | string | Yes | Batch scrape job ID |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/firecrawl/batch-scrape-status \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"<string>"}'
```

### Search

Search the web and return scraped content from top results.

**Estimated cost:** $0.005

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search query |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/firecrawl/search \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```
