API reference
Structured Data Extraction API
Deterministic structured extraction from a public page: meta/Open Graph/Twitter tags, parsed JSON-LD blocks, canonical URL, feeds, and heading outline — no AI involved. Fetch modes: direct by default; browser, enhanced and rendered are deployment-gated and off by default. Requested output shapes are unchanged. An unavailable non-direct mode returns 424 rather than silently ignoring the requested mode.
Endpoint
GET/v1/web/extractlive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
url | yes | Page URL to extract from (http/https, public hosts only) | https://example.com |
timeout | no | Fetch budget in milliseconds, clamped to 1000-15000 | 10000 |
fetch_mode | no | Fetch mode: direct (default) reads static HTML; browser explicitly runs JavaScript in an owned, isolated browser. Enhanced and rendered try direct first and permit configured fallbacks. Non-direct modes require deployment enablement, an approved target and applicable resource or spending limits; otherwise the request is refused. Output formats are unchanged. | direct |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/web/extract?url=https%3A%2F%2Fexample.com" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/web/extract?url=https%3A%2F%2Fexample.com",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/web/extract?url=https%3A%2F%2Fexample.com",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "web",
"endpoint": "/v1/web/extract",
"data": {
"url": "https://example.com/article",
"text": "Illustrative article text."
},
"credits_used": 1,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: reviewed response shaper. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
url | string | null | url |
final_url | string | null | final url |
title | string | null | title |
description | string | null | description |
text | string | null | text |
markdown | string | null | markdown |
content | object | null | Nested response fields; optional unless explicitly documented. |
publication | object | null | Nested response fields; optional unless explicitly documented. |
metadata | object | null | Nested response fields; optional unless explicitly documented. |
_warnings | array | Nested response fields; optional unless explicitly documented. |
Returns structurally extracted article content alongside metadata. Publisher access refusals return TARGET_ACCESS_DENIED (403); paywalls and access controls are not bypassed.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference