Crawl links
dataforseo.x.on-page-linksThis endpoint will provide you with a list of internal and external links detected on a target website.
- Price
- freeAt list price
- Success rate
- —No success-rate data yetNo success-rate data yet
- Latency p50
- ——
- Last verified
- —Not verified yet
POSThttps://toolswitch.dev/v1/tools/dataforseo.x.on-page-linksBeta- Uses platform quota
- Synchronous response
- Reads public data
Parameters
the POST body is a JSON array holding exactly one task object with these fields
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Request body (JSON) | ||||
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” | 07281559-0695-0216-0000-c269be8b7592 |
tag | string | Optional | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response | |
limit | integer | Optional | the maximum number of returned links optional field default value: 100 maximum value: 1000 | 10 |
offset | integer | Optional | offset in the results array of returned links optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten links in the results array will be omitted and the data will be provided for the successive links | |
filters | array | Optional | array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in, not_in, like, not_like you can use the % operator with lik | [["dofollow","=",true],"and",["direction","=","external"]] |
page_to | string | Optional | relative page URL optional field if you use this field, the API response will contain only internal links pointing to the specified page note that in this field you can specify relative URLs only | |
page_from | string | Optional | relative page URL optional field if you use this field, the API response will contain only links from the specified page note that in this field you can specify relative URLs only | /apis/google-trends-api |
search_after_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by specifying the unique search_after_token value from the response array, you will get t | |
- Request body (JSON)
idstringOptionalID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04”
Example:
07281559-0695-0216-0000-c269be8b7592tagstringOptionaluser-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response
limitintegerOptionalthe maximum number of returned links optional field default value: 100 maximum value: 1000
Example:
10offsetintegerOptionaloffset in the results array of returned links optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten links in the results array will be omitted and the data will be provided for the successive links
filtersarrayOptionalarray of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in, not_in, like, not_like you can use the % operator with lik
Example:
[["dofollow","=",true],"and",["direction","=","external"]]page_tostringOptionalrelative page URL optional field if you use this field, the API response will contain only internal links pointing to the specified page note that in this field you can specify relative URLs only
page_fromstringOptionalrelative page URL optional field if you use this field, the API response will contain only links from the specified page note that in this field you can specify relative URLs only
Example:
/apis/google-trends-apisearch_after_tokenstringOptionaltoken for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by specifying the unique search_after_token value from the response array, you will get t
Code samples
Replace $TOOLSWITCH_KEY with the key you created in the console.
curl -X POST 'https://toolswitch.dev/v1/tools/dataforseo.x.on-page-links' \
-H "X-Toolswitch-Key: $TOOLSWITCH_KEY"import os
import requests
response = requests.request(
"POST",
"https://toolswitch.dev/v1/tools/dataforseo.x.on-page-links",
headers={"X-Toolswitch-Key": os.environ["TOOLSWITCH_KEY"]},
)
response.raise_for_status()
print(response.text)const response = await fetch("https://toolswitch.dev/v1/tools/dataforseo.x.on-page-links", {
method: "POST",
headers: {
"X-Toolswitch-Key": process.env.TOOLSWITCH_KEY ?? "",
},
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.text());This gateway API is in beta; its URL and authentication may change. The example parameters are sample data. Calls are billed at free, including the service fee.