Social Fetch
Web

Generate web page HTML

Fetch and return cleaned HTML for a web page.

Operation

GET/v1/web/html

Headers

x-api-keystringrequired(header)

API key (`sfk_...`)

Parameters

urlstringrequired(query)

Absolute http or https URL to fetch.

min 1 chars · max 2083 chars

Response fields

data
objectrequired

Endpoint-specific response payload.

dataurl
stringrequired

URL that was fetched.

datastatus
integerrequired

HTTP status code reported for the page fetch.

datahtml
stringrequired

Cleaned or processed HTML for the page.

datametadata
object

Page metadata such as title when available.

meta
objectrequired

Metadata describing the request and billing outcome.

metarequestId
stringrequired

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integerrequired

Credits charged for this request.

≥ 0

metaversion
stringrequired

Public API version that served the response.

one of: v1

Code example

Responses

HTML extraction result.

Error codes

bad_requestinsufficient_creditsinternal_errorlookup_failedtemporarily_unavailableunauthorized

On this page