Skip to main content
POST
Dark Web Crawl

Authentication

Requires an API key in the Authorization header.

Request

url
string
required
The .onion address to crawl. Must contain .onion.
depth
number
Crawl depth, 13. Higher depth follows more links. Default: 1.
force
boolean
Set true to bypass the cache and re-crawl. Default: false.

Response

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

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.