Scrape
Scrape a single URL into markdown, JSON, links, or a screenshot.
POST
/api/v1/scrape1 + add-onsScrape one URL and get back the formats you ask for. Peep automatically escalates from a fast HTTP fetch to a stealth browser when a page needs JavaScript or trips anti-bot defenses — you just get clean output. Pass a YouTube URL to get full video intelligence (see YouTube).
Request
| Parameter | Type | Description |
|---|---|---|
urlrequired | string | The absolute URL to scrape. |
formats | string[] | Any of markdown, html, rawHtml, links, images, screenshot, json, changeTracking. Defaults to ["markdown"]. |
onlyMainContent | boolean | Strip nav, footers, and boilerplate, keeping the main article. Defaults to true. |
includeTags / excludeTags | string[] | CSS selectors to force-keep or force-drop. |
waitFor | number | Milliseconds to wait for content to settle before capturing. |
actions | object[] | Browser actions to run before scraping (click, type, scroll, wait, screenshot…). |
schema / prompt | object / string | With formats: ["json"], extract structured data via a JSON schema or natural-language prompt (+4 credits). |
proxy | string | Set to stealth to route through the anti-bot stack (+4 credits). |
respectRobotsTxt | boolean | Honor robots.txt. Bypass is a paid-tier feature. Defaults to true. |
Example
bash
curl -X POST https://peep.shownomore.com/api/v1/scrape \
-H "Authorization: Bearer peep_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com",
"formats": [
"markdown",
"links"
],
"onlyMainContent": true
}'Response
json
{
"success": true,
"data": {
"markdown": "# Example Domain\n\nThis domain is for use in…",
"links": ["https://www.iana.org/domains/example"],
"metadata": { "title": "Example Domain", "statusCode": 200 }
},
"creditsUsed": 1,
"cached": false
}