> ## Documentation Index
> Fetch the complete documentation index at: https://docs.encrata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Dark Web Crawl

> Crawl a specific .onion address via Encrata's self-hosted onion crawler to discover emails, linked onion sites, and page metadata.

## Authentication

Requires an API key in the `Authorization` header.

```bash theme={"dark"}
Authorization: Bearer YOUR_API_KEY
```

## Request

<ParamField body="url" type="string" required>
  The `.onion` address to crawl. Must contain `.onion`.
</ParamField>

<ParamField body="depth" type="number">
  Crawl depth, `1`–`3`. Higher depth follows more links. Default: `1`.
</ParamField>

<ParamField body="force" type="boolean">
  Set `true` to bypass the cache and re-crawl. Default: `false`.
</ParamField>

## Response

<ResponseField name="url" type="string">The crawled onion URL.</ResponseField>
<ResponseField name="depth" type="number">The depth that was crawled.</ResponseField>
<ResponseField name="live" type="boolean">Whether the site responded.</ResponseField>
<ResponseField name="count" type="number">Number of pages/nodes discovered.</ResponseField>
<ResponseField name="emails" type="string[]">Email addresses found across the crawl.</ResponseField>
<ResponseField name="onions" type="string[]">Other `.onion` addresses linked from the site.</ResponseField>
<ResponseField name="nodes" type="object[]">Per-page metadata for each discovered node.</ResponseField>
<ResponseField name="credits" type="number">Credits charged (`0` when served from cache).</ResponseField>

<ResponseExample>
  ```json theme={"dark"}
  {
    "url": "http://exampleonion...onion",
    "depth": 1,
    "live": true,
    "count": 12,
    "emails": ["admin@exampleonion.onion"],
    "onions": ["http://another...onion"],
    "nodes": [{ "url": "http://exampleonion...onion/", "title": "Index" }],
    "credits": 5
  }
  ```
</ResponseExample>

## Credits

5 credits per depth level (depth 1 = 5 credits, depth 3 = 15 credits). Repeat crawls of the same URL and depth are served from cache for free.