Docs · Unblock a page (partner browser)
Unblock a page (partner browser)
A partner's browser on its own IPs, for sites that refuse ours (DataDome and the like). 4 credits.
https://api.lurkapi.com/v1/web/unblockWhen to use this
Pass a url; a partner's browser visits it from its own IPs and returns the HTML the site sent, before JavaScript runs. It gets through walls that refuse our IPs, DataDome above all; it can't pick a country and doesn't report where redirects ended (url is the one you asked for). Usually 15–35 s. Always 4 credits, charged only when the page comes back; a call that's walled or can't reach the site fails with 502 upstream_error and costs nothing. For a page a site walls against this strategy, /v1/web/scrape (Auto) tries the others in turn, or /v1/web/custom chains the ones you pick. Pages over 2 MB are cut (truncated); use format=markdown for LLMs. The web scraping guide explains each strategy.
Parameters
All parameters go in the query string.
| Parameter | Description |
|---|---|
urlstringrequired | The page to fetch: a full http(s) URL on a public host (ports 80 and 443 only).
|
formatstringoptional | What content holds: the page's html, markdown (best for LLMs) or plain text. Non-HTML pages (JSON, XML, plain text) come back as they are.
|
Example request
Replace YOUR_API_KEY with your key, or set LURKAPI_KEY for the code. Get a free key.
curl "https://api.lurkapi.com/v1/web/unblock?url=https%3A%2F%2Fbooks.toscrape.com%2F&format=markdown" \
-H "x-api-key: YOUR_API_KEY"const params = new URLSearchParams({
url: "https://books.toscrape.com/",
format: "markdown",
});
const res = await fetch(`https://api.lurkapi.com/v1/web/unblock?${params}`, {
headers: { "x-api-key": process.env.LURKAPI_KEY },
});
const data = await res.json();
if (!data.success) throw new Error(`${data.code}: ${data.error}`);
console.log(data.content);import os
import requests
res = requests.get(
"https://api.lurkapi.com/v1/web/unblock",
params={
"url": "https://books.toscrape.com/",
"format": "markdown",
},
headers={"x-api-key": os.environ["LURKAPI_KEY"]},
timeout=95,
)
data = res.json()
if not data["success"]:
raise RuntimeError(f"{data['code']}: {data['error']}")
print(data["content"])Example response
A real response from this endpoint, captured from the live API and trimmed to a couple of items. Strings over 96 characters (mostly signed media URLs) are cut short and end in ….
Show the example response (1 KB)Hide
{
"success": true,
"credits_remaining": 9996,
"credits_charged": 4,
"status": 200,
"url": "https://books.toscrape.com/",
"content_type": "text/html",
"content": "[Books to Scrape](https://books.toscrape.com/index.html) We love being s…",
"truncated": false,
"via": "unblocker",
"captcha": null,
"attempts": [
{
"via": "unblocker",
"ms": 9260,
"status": 200,
"wall": null,
"error": null
}
],
"billing": {
"mode": "fixed",
"credits": 4,
"breakdown": {
"base": 4
},
"note": null
}
}Response fields
Every field of a successful response. [] marks a list: a[].b is the b of each item in a. nullable fields can be null; optional fields can be missing.
Show all 21 fieldsHide
| Field | Type | Description |
|---|---|---|
| success | true | Always true here; errors have success: false. |
| credits_remaining | number | Your balance after this call. On anonymous playground calls: free tries left today. |
| credits_charged | number | Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1). |
| status | integer | The page's HTTP status: 200, or the site's own 404, 410 and so on. |
| url | string | The page's URL after redirects; the URL you asked for when via is unblocker, which doesn't say. |
| content_type | stringnullable | The page's Content-Type, like text/html; charset=utf-8; null if the site sent none. |
| content | stringnullable | The page as format asks: HTML, markdown or plain text. Null for binary content (images, PDFs, archives). |
| truncated | boolean | The page was over 2 MB and was cut there. |
| via | string | The strategy that got the page: direct or static (plain requests), browser (our browser), unblocker (a partner's browser and IPs), residential (a residential IP) or browser_residential (both). |
| captcha | stringnullable | The captcha solved to get the page (turnstile, datadome or recaptcha; charged); null if none was. |
| attempts | object[] | Every strategy tried, in order; the last one delivered the page. |
| attempts[].via | string | The strategy tried. |
| attempts[].ms | integer | How long it took, in milliseconds. |
| attempts[].status | integernullable | The HTTP status it got; null if it got no answer. |
| attempts[].wall | stringnullable | What walled it, like cloudflare challenge or datadome block; null if nothing did. |
| attempts[].error | stringnullable | Why it failed without an answer; null if it got one. |
| billing | object | What this call costs and why. |
| billing.mode | string | fixed: this endpoint's price. auto and custom: the price of the strategy that got the page. |
| billing.credits | integer | What this call costs: the sum of breakdown. |
| billing.breakdown | object | Credits by what they paid for: base, and on Auto or Custom render (a browser), premium (a residential IP) or premium_render (a browser on one); captcha when one was solved. |
| billing.note | stringnullable | Why the price varies, on Auto and Custom; null on fixed-price endpoints. |
Caching and freshness
Not cached: every call is answered fresh.
Errors
Errors return { success: false, error, code, docs } with the HTTP status below. Validation errors, 401/402/429 rejections and 5xx failures are free; not_found is charged (how charging works). All error codes.
| Status | Code | Meaning |
|---|---|---|
| 401 | missing_api_key | No API key. Send it in the x-api-key header. |
| 401 | invalid_api_key | The key is unknown or was revoked. |
| 402 | insufficient_credits | Not enough credits for this call. Buy a pack or wait for tomorrow's top-up. |
| 403 | account_suspended | This account is suspended. Contact support@lurkapi.com. Never charged. |
| 405 | method_not_allowed | Endpoints take GET with query params. |
| 429 | rate_limited | Too many calls at once. Wait for the retry-after seconds, then retry. |
| 500 | internal_error | Something broke on our side. Retry; 5xx errors are free. |
| 502 | upstream_error | The platform didn't give a usable answer. Retry; 5xx errors are free. |
| 503 | upstream_busy | All our connections to the platform are busy. Retry in a few seconds; 5xx errors are free. |
| 504 | upstream_timeout | The platform took over 30 seconds to answer (90 for web pages). Retry; timeouts are free. |
Use it in Claude
Once LurkAPI is connected to Claude, this endpoint is the web_unblock tool. Ask in plain English, for example:
Use LurkAPI's web_unblock with url "https://books.toscrape.com/", format "markdown" and summarize what you find.Claude calls web_unblock with arguments like these, and each call costs 4 credits:
{
"url": "https://books.toscrape.com/",
"format": "markdown"
}Tool results skip nulls and empty lists to save tokens.