Social Fetch
Web

Crawl web pages

Crawl a small set of web pages synchronously.

Operation

GET/v1/web/crawl

Headers

x-api-keystringrequired(header)

API key (`sfk_...`)

Parameters

urlarrayrequired(query)

URLs to crawl. Repeat the `url` query parameter for multiple pages (max 5).

Response fields

data
objectrequired

Endpoint-specific response payload.

dataresults
arrayrequired

Per-URL crawl results.

dataresults[]url
stringrequired

Final URL associated with this crawl result.

dataresults[]status
integerrequired

HTTP status code reported for the page fetch.

dataresults[]success
booleanrequired

Whether the page was crawled successfully.

dataresults[]markdown
object

Markdown extracted from the page when available.

dataresults[]markdownraw
string

Raw markdown for the crawled page.

dataresults[]markdownfit
string

Filtered markdown for the crawled page.

dataresults[]html
string

HTML content for the page when returned by the crawler.

dataresults[]metadata
object

Page metadata such as title or description when available.

dataresults[]errorMessage
string

Provider error message when the page crawl failed.

datasummary
objectrequired

Summary counts for the crawl batch.

datasummaryrequestedUrls
integerrequired

Number of URLs requested in the crawl batch.

≥ 0

datasummarysucceeded
integerrequired

Number of URLs that crawled successfully.

≥ 0

datasummaryfailed
integerrequired

Number of URLs that failed to crawl.

≥ 0

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

Crawl results.

Error codes

bad_requestinsufficient_creditsinternal_errorlookup_failedtemporarily_unavailableunauthorized

On this page