Prospect demo — Supadata (unofficial)
GET/web/scrape

Extract webpage content as Markdown

Extracts webpage content as Markdown from a URL. Use noLinks to strip Markdown links and lang to request a preferred language using an ISO 639-1 code. The response also includes webpage metadata and URLs found on the page.

3 parameters
urlstringrequired
The URL of the webpage to scrape.
noLinksbooleanoptional
Set to true to strip Markdown links from the extracted content. Defaults to false when omitted.
Default:false
langstringoptional
Preferred language for the scraped content, specified as an ISO 639-1 code. Defaults to en when omitted.
Default:en

7 status codes
200Returns the scraped URL, extracted Markdown content, character count, and URLs found on the page. May also include the webpage name, description, and Open Graph URL.
urlstringrequired
The URL that was scraped
contentstringrequired
The Markdown content extracted from the URL
namestringoptional
The name of the webpage
descriptionstringoptional
A description of the webpage
ogUrlstringoptional
Open Graph URL for the webpage
countCharactersnumberrequired
The number of characters in the content
urlsarray<string>required
List of URLs found on the webpage
400Returned when the scrape request is invalid.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
401Returned when the request is unauthorized.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
403Returned when the request is forbidden.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
404Returned when the requested resource is not found.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
429Returned when the request limit is exceeded.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation
500Returned when an internal error occurs.
errorstringrequired
Error code identifying the type of error
Allowed:invalid-requestinternal-errorforbiddenunauthorizedupgrade-requiredtranscript-unavailablenot-foundlimit-exceeded
messagestringrequired
Human readable error message
detailsstringrequired
Detailed error description
documentationUrlstringoptional
URL to error documentation

Error handling

A 400 indicates an invalid request, a 401 an unauthorized request, a 403 a forbidden request, and a 404 a missing resource. A 429 indicates the request limit was exceeded, and a 500 indicates an internal error; provide url to identify the webpage to scrape.