About this endpoint
What it does
Extracts all hyperlinks from the web page at the provided URL and returns them as absolute URLs. If the URL is identified as malicious when secure_mode is enabled, the response returns a malicious-URL payload instead of extracted links.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The URL of the page to extract links from. Protocol is optional — http:// is prepended if absent. |
| user_agent | String | No | Custom User-Agent header sent when fetching the URL. |
| secure_mode | Boolean | No | When true, the URL is checked against the malicious-URL database before fetching. Default: true. |
| accept_language | String | No | Custom Accept-Language header sent when fetching the URL. |
Response
Returns a JSON object with a required data field. The data value is an object that can either contain extracted links in a links array of strings, or malicious-URL details with url, threat, and reported_malicious fields.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | Yes | Response payload. Either an object with extracted links, or an object describing a malicious URL. |
| data.links | String Array | No | Absolute URLs of all hyperlinks found on the page. |
| data.url | String | No | The detected malicious URL. |
| data.threat | String | No | The reported threat label. |
| data.reported_malicious | Boolean | No | Indicates whether the URL was reported as malicious. |