{ "openapi": "3.0.3", "info": { "title": "Web Scraping Browser API — JS Rendering, Markdown, Screenshots & Unblock", "version": "3.1.0", "description": "Web scraping browser API with Markdown extraction for LLM/RAG, JavaScript rendering, and protected site scraping. Returns clean Markdown, HTML, text, or screenshots with a typed JSON status.", "x-long-description": "## Web Scraping Browser API with Markdown Extraction, JS Rendering, Screenshots & Unblock\n\nScrape any public website — static HTML, JavaScript-rendered SPAs, or heavily protected targets — and get clean Markdown, HTML, text, or screenshots through three GET endpoints priced per request. Every response includes a typed `status` field (`ok`, `blocked`, or `timeout` on the render endpoints) so your retry logic branches on structured JSON instead of parsing HTML for error strings.\n\n## Three scraping endpoints\n\n| Path | Use case |\n|---|---|\n| `GET /scrape` | Fast HTTP fetch for static HTML. Minimal latency. |\n| `GET /scrape-jsrender` | Full JavaScript rendering for SPAs and client-rendered apps. |\n| `GET /scrape-unblock` | Advanced scraping with enhanced techniques and managed IP pool. |\n\nPer-request cost for each endpoint is shown in the endpoint summary on the Endpoints tab. Monthly plan quotas are on the Pricing tab.\n\n## Markdown extraction for LLM & RAG pipelines\n\nSet `returnType=markdown` on `/scrape-jsrender` or `/scrape-unblock` to get clean, LLM-ready Markdown. The engine extracts the main article content — stripping navigation, ads, sidebars, and footers — then converts the result to structured Markdown with headings, links, lists, code blocks, and tables preserved. Feed the output directly into your RAG pipeline, vector database, or LLM context window.\n\n- Article title extracted as `# Heading`\n- Boilerplate removed (nav, ads, cookie banners, footers)\n- Clean Markdown with structural formatting preserved\n- Works on JavaScript-rendered pages and protected sites\n\n## Use cases\n\n- **LLM & RAG data ingestion** — clean Markdown from any website, ready for embeddings or context\n- **AI agent web search** — structured content extraction for function-calling agents\n- Price monitoring & e-commerce scraping\n- SEO audits & fully-rendered HTML crawling\n- Open Graph image generation & social thumbnails\n- Visual regression testing\n- Site change detection & monitoring\n\n## JavaScript rendering for SPAs\n\nRender React, Vue, Angular, Svelte, and any other client-rendered site after full JavaScript execution.\n\n## Website screenshots\n\nSet `returnType=screenshot` on `/scrape-jsrender` or `/scrape-unblock` for a base64-encoded PNG. Ideal for OG images, social thumbnails, visual regression.\n\n## Authenticated scraping with cookies\n\nPass `cookies` as a URL-encoded JSON array on `/scrape-jsrender` or `/scrape-unblock` to scrape pages behind a login. Session tokens, consent cookies, and auth cookies are all supported.\n\n## Proxy options\n\n- **Bring your own** (`/scrape-jsrender`) — pass your proxy as a URL-encoded JSON object in the `proxy` query parameter (HTTP, HTTPS, SOCKS4, SOCKS5). Credentials never stored, never echoed.\n- **Managed IP pool** (`/scrape-unblock` — automatic) — no field to set. Routes through a managed pool for higher success on protected targets.\n\n## Why this scraping API\n\n- **Markdown extraction** — clean, structured content from any web page. No boilerplate, no noise.\n- **Typed JSON status** in every response — `status: \"blocked\"` is a first-class field; no HTML parsing.\n- **Transparent per-endpoint pricing** — each endpoint has its own rate, called out in the endpoint summary on the Endpoints tab.\n- **Every feature on every plan** — no tier-gating.\n- **`blocked` and `timeout` return HTTP 200** — you paid for the attempt, you get the body. Only infrastructure failures return 5xx.\n\n## For AI agents & LLMs\n\nBuilt for function-calling and RAG pipelines. The typed `status` JSON contract was designed so Claude tool use, GPT function calling, and MCP-style frameworks can branch on structured output. `returnType=markdown` yields clean Markdown for RAG pipelines and LLM context windows. `returnType=text` yields plain text for simpler ingestion.\n\n## Limits\n\n- `/scrape` timeout: fixed 30 s; follows up to 5 redirects. Response cap: 5 MiB.\n- `/scrape-jsrender` and `/scrape-unblock` navigation timeout: up to 60 s (default 30 s). Response cap: 10 MiB (HTML/text/markdown) or 5 MiB (screenshot).\n- Cookies: max 50 per request.\n- No retry credits on `blocked` or `timeout` — each attempt is billed.\n- Respect target ToS and `robots.txt`. Abuse reports: abuse@apiburst.com.", "contact": { "name": "ApiBurst Support", "url": "https://apiburst.com/support", "email": "support@apiburst.com" }, "termsOfService": "https://apiburst.com/terms", "x-category": "Data", "x-public": true }, "servers": [ { "url": "https://api.apiburst.com/v1/browser" } ], "tags": [ { "name": "Browser", "description": "Three endpoints for web rendering with typed block status" }, { "name": "System", "description": "Service health" } ], "paths": { "/health": { "get": { "summary": "Health check", "description": "Lightweight liveness probe. No auth required.", "operationId": "getHealth", "tags": ["System"], "responses": { "200": { "description": "Service is healthy", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" }, "api": { "type": "string", "example": "browser" } } } } } } } } }, "/scrape": { "get": { "summary": "Basic Scrape (HTTP) — 1 unit", "description": "Fast HTTP fetch for static HTML targets. No JavaScript execution. Follows up to 5 redirects with a 30 s timeout and a 5 MiB response cap. Returns HTML, text, or clean Markdown. When the target returns a challenge page, the response includes a short `message` pointing at `/scrape-unblock`.\n\nSet `returnType=markdown` to extract the main article content as clean, LLM-ready Markdown (navigation, ads, and boilerplate stripped). For JavaScript rendering, screenshots, cookies, or proxy support, use `/scrape-jsrender` or `/scrape-unblock`.", "operationId": "basicScrape", "tags": ["Browser"], "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Target URL (HTTP or HTTPS).", "schema": { "type": "string", "format": "uri" }, "example": "https://example.com" }, { "name": "returnType", "in": "query", "required": true, "description": "Return format. Use `markdown` for clean, LLM-ready content with boilerplate removed. Use `html` for raw HTML or `text` for plain text. For screenshots, use JS Render Scrape or Unblock Scrape.", "schema": { "type": "string", "enum": ["markdown", "html", "text"], "default": "html" } } ], "responses": { "200": { "description": "Returned content (or block page with upsell message)", "headers": { "X-RapidAPI-Billing": { "description": "Units billed for this request. Always `Requests=1` on /scrape (basic, flat rate). Emitted on 200 only — 4xx/5xx are non-billable.", "schema": { "type": "string", "example": "Requests=1" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasicScrapeResult" }, "examples": { "ok": { "summary": "Clean fetch", "value": { "status": "ok", "statusCode": 200, "loadTimeMs": 412, "content": { "type": "html", "body": "..." } } }, "blocked": { "summary": "Target returned a block page", "value": { "status": "blocked", "statusCode": 403, "loadTimeMs": 380, "content": { "type": "html", "body": "..." }, "message": "Target blocked. Try /scrape-unblock for protected sites." } }, "jsRequired": { "summary": "Target requires JavaScript", "value": { "status": "blocked", "statusCode": 200, "loadTimeMs": 120, "content": { "type": "html", "body": "" }, "message": "Target appears to require JavaScript. Try /scrape-jsrender." } } } } } }, "400": { "description": "Validation error (e.g. disallowed field for basic endpoint, or `returnType=screenshot`)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Account kill-switch or blocklist hit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not Allowed — only GET is accepted on this endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "414": { "description": "Request URL exceeds 16 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-code-samples": [ { "lang": "curl", "label": "Basic HTML fetch", "source": "curl 'https://api.apiburst.com/v1/browser/scrape?url=https%3A%2F%2Fexample.com'" } ] } }, "/scrape-jsrender": { "get": { "summary": "JS Render Scrape — 10 units (20 with cookies or blockResources)", "description": "Full JavaScript rendering for modern web apps, SPAs, and JS-heavy targets. Supports cookies for authenticated scraping and BYO proxy. For managed IP pool routing, use `/scrape-unblock` instead. (10 units)", "operationId": "jsrenderScrape", "tags": ["Browser"], "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Target URL (HTTP or HTTPS).", "schema": { "type": "string", "format": "uri" }, "example": "https://example.com" }, { "name": "returnType", "in": "query", "required": true, "description": "Return format. Use `markdown` for clean, LLM-ready content with boilerplate removed. Use `html` for raw HTML, `text` for plain text, or `screenshot` for a base64 PNG.", "schema": { "type": "string", "enum": ["markdown", "html", "text", "screenshot"], "default": "html" } }, { "name": "platform", "in": "query", "required": true, "description": "OS family hint for the rendering browser.", "schema": { "type": "string", "enum": ["windows", "mac", "random"], "default": "windows" } }, { "name": "proxy", "in": "query", "required": false, "description": "Your own egress proxy as URL-encoded JSON object. Supports HTTP, HTTPS, SOCKS4, SOCKS5. Credentials never stored or echoed.\n\nExample: {\"server\":\"socks5://proxy.example.com:8080\",\"username\":\"user\",\"password\":\"pass\"}", "schema": { "type": "string" } }, { "name": "cookies", "in": "query", "required": false, "description": "Cookies to set before navigation as URL-encoded JSON array. Max 50 entries. Bumps this endpoint to 20 units.\n\nExample: [{\"name\":\"sessionId\",\"value\":\"abc123\",\"domain\":\".example.com\"}]", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Rendered content with typed status", "headers": { "X-RapidAPI-Billing": { "description": "Units billed for this request. `Requests=10` for a bare jsrender; `Requests=20` when `cookies` is present. Emitted on 200 only.", "schema": { "type": "string", "example": "Requests=10" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderResult" }, "examples": { "minimal": { "summary": "Minimal render — html, default waitFor", "value": { "status": "ok", "finalUrl": "https://example.com/", "statusCode": 200, "loadTimeMs": 1840, "content": { "type": "html", "body": "..." } } }, "selectorWait": { "summary": "Wait for a selector before capture", "value": { "status": "ok", "finalUrl": "https://example.com/", "statusCode": 200, "loadTimeMs": 2410, "content": { "type": "html", "body": "..." } } }, "screenshot": { "summary": "Screenshot render (base64 PNG)", "value": { "status": "ok", "finalUrl": "https://example.com/", "statusCode": 200, "loadTimeMs": 2030, "content": { "type": "screenshot", "body": "iVBORw0KGgoAAAANS..." } } } } } } }, "400": { "description": "Validation error (e.g. invalid JSON in `proxy`/`cookies`)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Account kill-switch or blocklist hit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not Allowed — only GET is accepted on this endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "414": { "description": "Request URL exceeds 16 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Per-account concurrency cap reached", "headers": { "Retry-After": { "description": "Seconds to wait before retrying (bounded integer).", "schema": { "type": "integer", "minimum": 1, "example": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error (non-billable on structural failures)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporary backend unavailability (non-billable)", "headers": { "Retry-After": { "description": "Seconds to wait before retrying (clamped 1–60).", "schema": { "type": "integer", "minimum": 1, "maximum": 60, "example": 10 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-code-samples": [ { "lang": "curl", "label": "Render a JS-heavy page", "source": "curl 'https://api.apiburst.com/v1/browser/scrape-jsrender?url=https%3A%2F%2Fexample.com&returnType=html&platform=windows'" }, { "lang": "curl", "label": "Screenshot (mac)", "source": "curl 'https://api.apiburst.com/v1/browser/scrape-jsrender?url=https%3A%2F%2Fexample.com&returnType=screenshot&platform=mac'" }, { "lang": "curl", "label": "With cookies (20 units)", "source": "curl 'https://api.apiburst.com/v1/browser/scrape-jsrender?url=https%3A%2F%2Fexample.com&returnType=html&platform=windows&cookies=%5B%7B%22name%22%3A%22sessionId%22%2C%22value%22%3A%22abc123xyz%22%2C%22domain%22%3A%22.example.com%22%7D%5D'" }, { "lang": "curl", "label": "BYO proxy", "source": "curl 'https://api.apiburst.com/v1/browser/scrape-jsrender?url=https%3A%2F%2Fexample.com&returnType=html&platform=windows&proxy=%7B%22server%22%3A%22http%3A%2F%2Fproxy.example.com%3A8080%22%2C%22username%22%3A%22user%22%2C%22password%22%3A%22secret%22%7D'" } ] } }, "/scrape-unblock": { "get": { "summary": "Advanced Unblock Scrape — 30 units", "description": "Advanced scraping with enhanced techniques and managed IP pool. Highest success rate on protected and hard-to-scrape targets. All extras (cookies, etc.) are included at the 30-unit flat rate. (30 units).", "operationId": "unblockScrape", "tags": ["Browser"], "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Target URL (HTTP or HTTPS).", "schema": { "type": "string", "format": "uri" }, "example": "https://example.com" }, { "name": "returnType", "in": "query", "required": true, "description": "Return format. Use `markdown` for clean, LLM-ready content with boilerplate removed. Use `html` for raw HTML, `text` for plain text, or `screenshot` for a base64 PNG.", "schema": { "type": "string", "enum": ["markdown", "html", "text", "screenshot"], "default": "html" } }, { "name": "platform", "in": "query", "required": true, "description": "OS family hint for the rendering browser.", "schema": { "type": "string", "enum": ["windows", "mac", "random"], "default": "windows" } }, { "name": "proxy", "in": "query", "required": false, "description": "Your own egress proxy as URL-encoded JSON object. Overrides the managed pool (still 30 units). Supports HTTP, HTTPS, SOCKS4, SOCKS5. Credentials never stored or echoed.\n\nExample: {\"server\":\"socks5://proxy.example.com:8080\",\"username\":\"user\",\"password\":\"pass\"}", "schema": { "type": "string" } }, { "name": "cookies", "in": "query", "required": false, "description": "Cookies to set before navigation as URL-encoded JSON array. Max 50 entries. Included in the 30-unit flat rate.\n\nExample: [{\"name\":\"sessionId\",\"value\":\"abc123\",\"domain\":\".example.com\"}]", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Rendered content with typed status", "headers": { "X-RapidAPI-Billing": { "description": "Units billed for this request. Always `Requests=30` on /scrape-unblock (extras included in flat rate). Emitted on 200 only.", "schema": { "type": "string", "example": "Requests=30" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderResult" }, "examples": { "ok": { "summary": "Successfully rendered a protected target", "value": { "status": "ok", "finalUrl": "https://example.com/", "statusCode": 200, "loadTimeMs": 4210, "content": { "type": "html", "body": "..." } } }, "blocked": { "summary": "Advanced techniques insufficient on this target", "value": { "status": "blocked", "finalUrl": "https://example.com/", "statusCode": 200, "loadTimeMs": 9820, "content": { "type": "html", "body": "..." } } } } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Account kill-switch or blocklist hit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not Allowed — only GET is accepted on this endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "414": { "description": "Request URL exceeds 16 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Per-account concurrency cap reached", "headers": { "Retry-After": { "description": "Seconds to wait before retrying (bounded integer).", "schema": { "type": "integer", "minimum": 1, "example": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Upstream error (non-billable on structural failures)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Managed pool temporarily unavailable (non-billable)", "headers": { "Retry-After": { "description": "Seconds to wait before retrying (clamped 1–60).", "schema": { "type": "integer", "minimum": 1, "maximum": 60, "example": 5 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-code-samples": [ { "lang": "curl", "label": "Unblock a protected target", "source": "curl 'https://api.apiburst.com/v1/browser/scrape-unblock?url=https%3A%2F%2Fexample.com&returnType=html&platform=windows'" } ] } } }, "components": { "schemas": { "BasicScrapeResult": { "type": "object", "required": ["status", "statusCode", "loadTimeMs", "content"], "properties": { "status": { "type": "string", "enum": ["ok", "blocked"], "description": "Outcome. `blocked` fires when the target returned a challenge, unreachable, or appears to require JavaScript." }, "statusCode": { "type": "integer", "description": "HTTP status the target returned (0 when the request could not complete)." }, "loadTimeMs": { "type": "integer", "description": "Wall-clock fetch duration in milliseconds." }, "content": { "type": "object", "required": ["type", "body"], "properties": { "type": { "type": "string", "enum": ["html", "text"] }, "body": { "type": "string", "description": "Response body." } } }, "message": { "type": "string", "description": "Set only on blocked responses. Suggests which endpoint to retry with." } } }, "RenderResult": { "type": "object", "required": [ "status", "finalUrl", "statusCode", "loadTimeMs", "content" ], "properties": { "status": { "type": "string", "enum": ["ok", "blocked", "timeout"], "description": "Outcome of the render. All three are HTTP 200. Retry logic should branch on this value." }, "finalUrl": { "type": "string", "format": "uri", "description": "The URL the browser landed on after any redirects" }, "statusCode": { "type": "integer", "description": "HTTP status the target returned for the final navigation" }, "loadTimeMs": { "type": "integer", "description": "Wall-clock render duration in milliseconds" }, "content": { "type": "object", "required": ["type", "body"], "properties": { "type": { "type": "string", "enum": ["markdown", "html", "text", "screenshot"] }, "body": { "type": "string", "description": "Content body. For `screenshot`, a base64-encoded PNG." } } } } }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "BAD_REQUEST", "UNAUTHORIZED", "FORBIDDEN", "METHOD_NOT_ALLOWED", "RATE_LIMITED", "UPSTREAM_ERROR", "SERVICE_UNAVAILABLE", "URL_TOO_LONG", "FIELD_NOT_SUPPORTED_ON_BASIC", "FIELD_NOT_SUPPORTED_ON_JSRENDER" ] }, "message": { "type": "string" }, "status": { "type": "integer" }, "retryAfter": { "type": "integer", "description": "Seconds to wait before retry (429 / 503 only)" } } } } } } } }