Extract all links from a page with metadata.
Request body
| Field | Type | Description |
|---|
url | string | Required. The URL to process. |
options | object | Optional configuration (see below). |
Options
| Option | Type | Description |
|---|
filter | "internal" | "external" | null | Filter links by type. Default: all links. |
unique | boolean | Deduplicate by href. Default: true. |
waitUntil | string | "networkidle0", "networkidle2", "load", "domcontentloaded". Default: "networkidle0". |
curl -X POST https://crawlapi.dev/api/links \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-d '{"url":"https://example.com","options":{"filter":"external"}}'
{
"success": true,
"data": {
"url": "https://example.com",
"total": 1,
"links": [
{
"href": "https://www.iana.org/domains/example",
"text": "More information...",
"isExternal": true
}
]
},
"credits_used": 1,
"credits_remaining": 499
}
Error codes
| Status | Meaning |
|---|
400 | Missing or invalid URL / bad options |
401 | Missing or invalid API key |
403 | Insufficient credits |
405 | Wrong HTTP method (use POST) |
429 | Rate limit exceeded (60/min) |
500 | Server error |