Skip to main content

Quickstart

This page gets you from zero to a successful scrape in a few minutes.

1. Get your API key​

Sign up and log in at www.omniscrape.io, then copy your key from Dashboard → API Keys. It looks like:

osk_live_3f9a2c8d1e7b4a06...

Keep it secret. Send it in the X-API-Key header on every request, and store it in an environment variable rather than your source code.

:::info Free trial New accounts get free credit and a 7-day trial for Web Unlocker and BaaS — no credit card required. Direct proxy credentials unlock when you activate PAYG ($5 minimum top-up) or a paid plan. :::

export OMNISCRAPE_KEY="osk_live_..."

2. Send your first request​

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

3. Read the response​

{
  "success": true,
  "data": {
    "content": "<!DOCTYPE html>...",
    "status_code": 200,
    "final_url": "https://example.com"
  },
  "metadata": {
    "method_used": "fast",
    "elapsed_time": 0.42,
    "solver_used": false
  },
  "billing": {
    "charged": 0.0035,
    "balance_after": 49.93
  }
}

Check success and data.status_code before trusting data.content. See the full response reference for every field.

4. Try it in other languages​

Python
import os, requests

resp = requests.post(
    "https://api.omniscrape.io/v1/scrape",
    headers={"X-API-Key": os.environ["OMNISCRAPE_KEY"]},
    json={"url": "https://example.com", "mode": "auto"},
    timeout=120,
)
print(resp.json()["data"]["content"][:200])
Node.js
const res = await fetch("https://api.omniscrape.io/v1/scrape", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.OMNISCRAPE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com", mode: "auto" }),
});
const { data } = await res.json();
console.log(data.content.slice(0, 200));

Next steps​