API Reference
Comprehensive reference for all Chuger endpoints, including parameters, responses, and examples for scraping, content extraction, and search.
curl "https://api.chuger.com/v1/scrape?url=https://news.ycombinator.com" \ -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.chuger.com/v1/scrape?url=https://news.ycombinator.com", {
headers: {
"Authorization": "Bearer YOUR_API_KEY"
}
});
const data = await response.json();
import requests
response = requests.get(
"https://api.chuger.com/v1/scrape",
params={"url": "https://news.ycombinator.com"},
headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()
{
"url": "https://news.ycombinator.com",
"html": "<!DOCTYPE html>
<html>
<head>
<title>Hacker News</title>
</head>
<body>
...",
"status": "success"
}
curl "https://api.chuger.com/v1/content?url=https://example.com/blog-post" \ -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.chuger.com/v1/content?url=https://example.com/blog-post", {
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const { markdown } = await response.json();
{
"url": "https://example.com/blog-post",
"title": "Blog Post Title",
"markdown": "# Blog Post Title
Clean content without ads or navigation.
## Section
More structured text.",
"status": "success"
}
curl "https://api.chuger.com/v1/serp?query=AI tools" \ -H "Authorization: Bearer YOUR_API_KEY"
response = requests.get(
"https://api.chuger.com/v1/serp",
params={"query": "AI tools"},
headers={"Authorization": "Bearer YOUR_API_KEY"}
)
{
"query": "AI tools",
"results": [
{
"title": "Best AI Tools 2024",
"url": "https://example.com/ai-tools",
"snippet": "Discover top AI productivity tools..."
}
]
}
const urls = [
"https://example.com/page1",
"https://example.com/page2"
];
const response = await fetch("https://api.chuger.com/v1/content/bulk", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({ urls })
});
curl -X POST "https://api.chuger.com/v1/content/bulk" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"urls": ["https://example.com/page1", "https://example.com/page2"]}'
{
"results": [
{
"url": "https://example.com/page1",
"markdown": "# Page 1
Content...",
"title": "Page 1 Title"
}
]
}
Overview
Access all Chuger endpoints at https://api.chuger.com/v1. Authenticate requests using your API key in the Authorization header as a Bearer token. Obtain your key from the dashboard.
All endpoints use the same credit pool. Monitor usage in your dashboard.
Scrape HTML
Retrieve raw HTML from any URL.
Content to Markdown
Convert web pages to clean markdown.
SERP Search
Search the web by keyword and get results.
Bulk Content
Process multiple URLs in one request.
Authentication
Set up authentication in every request.
Bearer token. Format: Bearer YOUR_API_KEY.
Get API Key
Log in to app.chuger.com/dashboard and navigate to API Tokens.
Add to Request
Include the header in all calls.
Test
Use the playground to verify.
Scrape Raw HTML (/v1/scrape)
Fetch raw HTML content from a URL. Use this for custom parsing needs.
The URL to scrape. Must be publicly accessible.
Raw HTML content with original structure.
Echoed input URL.
Content to Markdown (/v1/content)
Convert a web page to clean markdown. Removes ads, navigation, and boilerplate automatically.
Target URL for markdown conversion.
Clean markdown output ready for LLMs.
Extracted page title.
Ideal for feeding web content directly to AI models. Markdown preserves structure better than HTML.
SERP Search (/v1/serp)
Perform keyword-based web search. Returns top results with snippets.
Search keywords.
Bulk Content (/v1/content/bulk)
Process multiple URLs in a single request. Supports up to 10 URLs.
Array of URLs to process.
Bulk requests consume credits per URL. Use webhooks for large batches exceeding 10 URLs.
Webhook Integrations
For async operations like bulk processing, add a webhook_url query parameter to receive completion notifications.
URL to POST results upon completion.
Use to poll status or match webhook payloads.
Last updated today
Built with Documentation.AI