Getting Started

Quickstart

Get up and running with RenderNest in under 2 minutes. Generate an API key and make your first inspection call.

1Obtain an API Key

wf_live_9a7b8c1d2e3f405162738495a6b7c8d9

2Make Your First API Request

Here is an example calling the inspection endpoint to extract technical metadata, OpenGraph cards, and headings hierarchy:

cURL Requestbash

curl -X POST https://api-rendernest.duckdns.org/v1/inspect \
  -H "Authorization: Bearer wf_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com"
  }'

JavaScript (Node / Browser)javascript

const response = await fetch("https://api-rendernest.duckdns.org/v1/inspect", {
  method: "POST",
  headers: {
    "Authorization": "Bearer wf_live_your_api_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    url: "https://example.com"
  })
});

const data = await response.json();
console.log(data);

Pythonpython

import requests

response = requests.post(
    "https://api-rendernest.duckdns.org/v1/inspect",
    headers={
        "Authorization": "Bearer wf_live_your_api_key",
        "Content-Type": "application/json"
    },
    json={"url": "https://example.com"}
)

print(response.json())

3Understand the Response

You will receive a standard JSON response with timing metrics, title, headings, links, and content metadata:

200 OK Responsejson

{
  "success": true,
  "request_id": "req_1725432100_9f8e7d",
  "data": {
    "url": "https://example.com",
    "final_url": "https://example.com",
    "status_code": 200,
    "title": "Example Domain",
    "description": "",
    "language": "en",
    "canonical": "https://example.com",
    "favicon": "https://example.com/favicon.ico",
    "open_graph": {},
    "twitter_card": {},
    "json_ld": [],
    "headings": [
      { "level": 1, "text": "Example Domain" }
    ],
    "links": [
      { "href": "https://www.iana.org/domains/example", "text": "More information...", "is_external": true }
    ],
    "images": [],
    "content": { "word_count": 27, "paragraphs_count": 2 },
    "technical": { "load_time_ms": 142 }
  }
}