Why use it as a Scraping API
- One endpoint for any target URL
- API-key auth, no browser orchestration required
- HTML by default, or Markdown or JSON on request, ready for existing parsers
- Easy fit for ETL, monitoring, AI ingestion, and data pipelines
Endpoint
GET https://parsing.webunlocker.gologin.com/v1/scrape?url={encoded_url}
Authentication
Send your API key in headers:Request model
Quickstart
cURL
Python
JavaScript (fetch)
Response behavior
By default, the response body is the raw rendered HTML of the page. Withformat=markdown, the body is Markdown. With format=json, the body is a JSON object:
200-> success, body contains the page in the requested format400-> bad request, for exampleurlis missing; body:{"success":false,"error":"Request failed"}401-> theapikeyheader is missing; body:{"message":"Missing API key in request"}
Retry guidance
Retry with exponential backoff for:- network errors
408,429,500,502,503,504
Official Node.js SDK
Install:SDK quick start
Constructor options
Core SDK methods
scrape(url)-> normalized response objectscrapeRaw(url)-> nativeResponsebuildScrapeUrl(url)-> full request URL
SDK-side derived methods (from returned HTML)
These are not separate backend endpoints; they are derived from API HTML in the SDK. The SDK sends only theurl parameter, not format, so this output can differ from the API’s own format=markdown or format=json response:
scrapeText(url)-> plain textscrapeMarkdown(url)-> markdownscrapeJSON(url)-> structured metadata (title,description,canonical,meta,headings,links)batchScrape(urls, { concurrency })-> helper for multiple scrape calls
Typed errors
WebUnlockerErrorAuthenticationErrorRateLimitErrorAPIErrorTimeoutErrorNetworkError
401/403->AuthenticationError429->RateLimitError500+and other non-2xx statuses (for example400) ->APIError- timeout/abort ->
TimeoutError - fetch/network failure ->
NetworkError
CLI
scrape(raw HTML/text)text(derived text)markdown(derived markdown)json(derived metadata)
Typical scraping use cases
- price and catalog monitoring
- lead and directory enrichment
- market intelligence pipelines
- content aggregation and indexing
- LLM ingestion and extraction workflows
Gologin Web Access CLI (unified)
For a more powerful CLI that combines Web Unlocker with Cloud Browser in a single command surface, usegologin-web-access: