Skip to main content

OmniScrape Documentation

OmniScrape is a web scraping API that returns clean data from any website — even ones protected by Cloudflare, DataDome, Akamai, or PerimeterX. You send a URL to one endpoint; we handle proxies, TLS fingerprints, headless browsers, and challenge solving on our side.

curl -X POST https://api.omniscrape.io/v1/scrape \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://example.com", "mode": "auto" }'

What you can do

  • Web Unlocker — fetch any page as HTML, Markdown, plain text, or structured JSON. Anti-bot pages are solved automatically.
  • Browser-as-a-Service — drive a real, remote browser for logins, clicks, infinite scroll, and multi-step flows.
  • Residential Proxies — route requests through residential IPs in 217 countries with HTTP, HTTPS, or SOCKS5. Direct credentials unlock with PAYG or a paid plan.

Three things to know first

  1. One endpoint. Almost everything happens through POST /v1/scrape. You change behavior with JSON fields, not new endpoints.
  2. One API key. The same X-API-Key works for Web Unlocker, BaaS, and proxies. Get it from the dashboard.
  3. Pay for success. Core unlock requests are billed only when they return data. Every response includes a billing block so you can track spend per call.

Free trial

Every new account gets free credit and a 7-day trial — no credit card required. During the trial you can use Web Unlocker and BaaS; residential proxy is applied automatically behind those products. Direct proxy URLs and credentials stay locked until you activate Pay-As-You-Go (minimum $5 top-up) or subscribe to a paid plan. See Pricing and Proxies.

Where to go next

If you want to…Go to
Make your first requestQuickstart
Understand authAuthentication
See every parameterParameters
Pick a scraping modeModes
Extract structured dataCSS extraction
Handle errorsErrors

:::tip Looking for tutorials? This site is the API reference. For long-form tutorials (scraping Amazon, bypassing Cloudflare, scraping with Python), see the OmniScrape Guides. :::