Web Scraping
Scrape, search, map, extract, crawl, and monitor any public web page โ clean markdown and structured data in the unified WebPage schema
Web Scraping
Scrape, search, map, extract, crawl, and monitor any public web page. Content-bearing responses return the unified WebPage schema โ clean markdown/HTML, metadata, structured extraction, and fetch provenance under data.page โ while search and map return a WebPageList (data.items[]).
Base URL: /v1/web/...
Getting Started
1. Scrape a page to markdown
curl "https://www.socialcrawl.dev/v1/web/scrape?url=https://example.com" \
-H "x-api-key: sc_your_api_key_here"The page content arrives at data.page.content.markdown (add formats=markdown,screenshot for a screenshot URL under data.page.media).
2. Search the web
curl "https://www.socialcrawl.dev/v1/web/search?query=social%20media%20data%20api&limit=10" \
-H "x-api-key: sc_your_api_key_here"Web, news, and image sources merge into one data.items[] list, each row tagged with source_type.
3. Go beyond single requests
- Structured extraction โ
GET /v1/web/extractwith aschema(JSON) orpromptreturns typed fields underdata.page.extraction. - Async crawls & batch scrapes โ
POST /v1/web/crawl/POST /v1/web/batch-scrape/POST /v1/web/agentreturn a job id (data.job_id, alwaysjob_โฆ). Every job kind reads through one unified surface: poll withGET /v1/web/jobs/{job_id}(append/errorsfor per-page failures), cancel withDELETE /v1/web/jobs/{job_id}, list withGET /v1/web/jobs. Credits are held up front and settled to actual usage โ unused holds refund automatically. - Change monitoring โ
POST /v1/web/monitors(returnsdata.monitor_id,wm_โฆ) schedules checks as tight as every 5 minutes (cadence_minutes: 5-60, or whole hours up to 1440); checks bill only when they run. List, pause/resume (PATCH), delete, and read check history via the same/v1/web/monitorsfamily. - Interactive sessions โ
POST /v1/web/sessionsopens a short-lived browser you can drive step-by-step withPOST /v1/web/sessions/{session_id}/execute. - Document parse โ
POST /v1/web/parse(multipartfileupload) turns PDFs and office documents into the samedata.pageshape.
Endpoints
์๋ํฌ์ธํธ 22๊ฐ๋ฅผ ์ ๊ณตํด์.
| ์๋ํฌ์ธํธ | ๊ฒฝ๋ก | ํฌ๋ ๋ง ๋ฑ๊ธ |
|---|---|---|
| Start an async batch scrape | /v1/web/batch-scrape | standard (1cr) |
| Start an async web crawl | /v1/web/crawl | standard (1cr) |
| List async web jobs | /v1/web/jobs | standard (0cr) |
| Get an async web job | /v1/web/jobs/{job_id} | standard (0cr) |
| Cancel an async web job | /v1/web/jobs/{job_id} | standard (0cr) |
| Map URLs on a site | /v1/web/map | standard (1cr) |
| Create a web monitor | /v1/web/monitors | standard (0cr) |
| List web monitors | /v1/web/monitors | standard (0cr) |
| Get a web monitor | /v1/web/monitors/{monitor_id} | standard (0cr) |
| Update a web monitor | /v1/web/monitors/{monitor_id} | standard (0cr) |
| Delete a web monitor | /v1/web/monitors/{monitor_id} | standard (0cr) |
| List web monitor checks | /v1/web/monitors/{monitor_id}/checks | standard (0cr) |
| Parse an uploaded document | /v1/web/parse | standard (1cr) |
| Scrape a web page | /v1/web/scrape | standard (1cr) |
| Search the web | /v1/web/search | standard (2cr) |
| List interactive web sessions | /v1/web/sessions | standard (0cr) |
| Get an interactive web session | /v1/web/sessions/{session_id} | standard (0cr) |
| Close an interactive web session | /v1/web/sessions/{session_id} | standard (0cr) |
| Execute an interaction in a web session | /v1/web/sessions/{session_id}/execute | standard (0cr) |
| Extract structured data from a web page | /v1/web/extract | advanced (5cr) |
| Create an interactive web session | /v1/web/sessions | advanced (5cr) |
| Start an async web agent job | /v1/web/agent | premium (25cr) |
Notes
- Method-aware surface: the sync data endpoints (
scrape,search,map,extract) and all reads areGET; async jobs, monitors, sessions, and parse usePOST/PATCH/DELETEas listed above - Authentication via
x-api-keyheader - Content responses follow the unified WebPage schema; job/monitor/session resources return envelope-wrapped status objects with cursor pagination on lists
- Variable-cost work (crawl pages, PDF parsing, enhanced proxy, agent runs) is metered honestly: held, settled to actual usage, and refunded when unused
