Skip to main content
POST
Onion Render

Authentication

Requires an API key in the Authorization header.

Request

url
string
required
The .onion URL to fetch typically a url returned by Onion Search. Must contain .onion.

Response

url
string
The onion URL that was fetched.
title
string
The page title.
status
number
HTTP status returned by the onion service.
live
boolean
Whether the service responded successfully.
truncated
boolean
Whether the HTML was truncated to stay within size limits.
html
string
Sanitized HTML scripts and active content stripped, safe to render in a sandboxed frame.
text
string
Plain-text content extracted from the page.
emails
string[]
Email addresses found on the page.
phones
string[]
Phone numbers found on the page.
Outbound links found on the page.
onions
string[]
Other .onion addresses linked from the page.
credits
number
Credits charged (0 when served from cache).

Credits

1 credit per render. Repeat renders of the same URL are served from cache for free.