arrow_back All endpoints

Web Page Scraper

POST/api/v1/tools/web-scrape3 credits per callscrapescraperextracthtmlparsecrawlcontent

Downloads a page through the SSRF-guarded client and returns its structure: title, meta description, canonical, language, Open Graph tags, every heading, deduplicated links marked internal/external and nofollow, images with alt text, and the readable text with a word count. An optional simple selector (tag name, .class or #id) returns just the text of matching elements.

receipt_long
Why 3 credits?

Downloads and parses a whole page, which is several times the work of a metadata-only fetch.

Any HTTP client works. Replace the key with one from your dashboard.

bash
curl -X POST https://toolkitbackend-j69m.onrender.com/api/v1/tools/web-scrape \
  -H "Authorization: Bearer tb_live_<your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com",
  "selector": ".product-title",
  "includeText": true
}'

Input

FieldTypeRequiredDefaultDescription
urlstringrequired- Absolute http(s) address of the page.
selectorstringoptional- Optional simple selector: a tag name, .class or #id. Full CSS is not supported.
includeTextbooleanoptionaltrue Include the page's readable text. Turn off for a smaller response.

Output

FieldTypeDescription
finalUrlstringAddress after redirects.
statusCodeintegerHTTP status returned.
titlestringDocument title.
metaDescriptionstringMeta description, when present.
canonicalstringCanonical URL, when declared.
headingsarrayEvery heading with its level.
linksarrayDeduplicated links with text, internal flag and nofollow flag.
imagesarrayImage URLs with alt text and declared dimensions.
openGraphobjectog: tags as key/value pairs.
selectorMatchesarrayText of nodes matching the selector, when one was given.
textstringReadable page text, truncated.
wordCountintegerWords in the readable text.

Try it

Sends a real POST /api/v1/tools/web-scrape from your browser and charges 3 credits to your account.

Sign in to run this endpoint. New accounts start with free credits.