Skip to content
clusters: prooflayer · edgemarket · edgefinance · synthforge · mediakit · wordmint · webprobe · locale · comppoint
$ man scrape

/scrape(1)

PRICE / CALL
$0.04
USDC · base mainnet · scheme: exact
METHOD
POST
CLUSTER
webprobe
CATEGORY
utilities
STATUS
live
NAME
scrape web scraper / html extractor
SYNOPSIS
POST https://x402.org/v1/scrape
     Content-Type: application/json
     X-PAYMENT:    <signed-transferWithAuthorization>

     { ... }
↳ first call → 402 Payment Required. Sign USDCtransferWithAuthorization, retry with theX-PAYMENT header.
DESCRIPTION

Web scraper / HTML extractor. Title, OG/Twitter meta, body in text/HTML/markdown, optional links. Cheerio-based.

INPUTrequest schema
propertytypedescriptionreq?
urlstringPublic http/https URL to scrape.required
formatstring'text' (default), 'html', or 'markdown'.
enum: text · html · markdown
optional
include_linksbooleanInclude array of unique links found on the page (max 500). Default false.optional
user_agentstringOverride the User-Agent header.optional
OUTPUTresponse shape
fieldtypedescription
urlstringFinal URL fetched after following redirects.
final_urlstringFinal URL after redirects.
status_codenumberHTTP status code returned by the upstream server.
titlestringPage title from the <title> tag.
descriptionstringMeta description from the page's <meta name="description"> or OG description tag.
canonicalstringCanonical URL from <link rel="canonical"> when present.
langstringLanguage code from the <html lang> attribute, like en or fr.
h1stringText of the first <h1> heading on the page.
ogobjectAll og:* meta tags.
twitterobjectAll twitter:* meta tags.
textstringBody when format=text.
htmlstringBody when format=html.
markdownstringBody when format=markdown.
formatstringOutput format of the body content: text, html, or markdown.
linksarrayArray of {href, text} when include_links=true.
body_charsnumberCharacter count of the extracted body content.
EXAMPLEStwo ways to call
EXAMPLE 1 · curl
curl -X POST https://x402.org/v1/scrape \
  -H 'Content-Type: application/json' \
  -d '{ }'
first response = 402 Payment Required with payment requirements; sign + retry with X-PAYMENT.
EXAMPLE 2 · mcp
# install once
claude mcp add x402 --command "npx x402-deployer-mcp"

# then ask Claude Code:
# "use the scrape tool to ..."
MCP server handles payment automatically — your coding agent just calls the tool by name.
METADATA
tags
scrapefetchhtmlextractmetadataurl
methods
POST
cluster
webprobe
price
$0.04 USDC per call
ADJACENTother endpoints in webprobe
endpointdescriptionprice
arxiv-summarizearXiv paper summarizer / research-paper TLDR.$0.04
rss-from-anythingRSS feed generator / HTML to RSS converter.$0.04
scrape-websiteWeb scraper / HTML to text / website content extractor.$0.04
screenshotWebsite screenshot / URL to PNG/JPG.$0.04
webpage-diffWebpage change detection / website monitor / content diff.$0.04
website-screenshotURL to PNG / JPG / website screenshot tool.$0.04
arxiv-searcharXiv full-text search.$0.03
domain-suggestBrandable domain suggester / startup-name brainstormer / product-name proposer / domain candidate generator.$0.05
SEE ALSO
agentutility(7) · webprobe(7) · x402(7) · mcp(7) · llms.txt · registry.json · bazaar.x402.org