project.onpage.links

project.onpage.links

Returns all links found within the project, including both internal and external links, along with their most important informations. You can use the LIMIT parameter to control the number of links returned and the OFFSET parameter to set the starting point in the list of links.

Result

The results contain basic information about the crawled project, including the project hash (hash), the project name (name), and the total number of found links (count). Additionally, it provides a list of found links, with each link including details such as its origin (from), its target (to), its type (type), its status code (status_code), the link text (text), and the content type (content_type). Each link also indicates whether it is set as "follow" or "no follow" (follow), with 1 for "follow," 0 for "no follow," and -1 if the crawler could not determine the information.

GET-Parameters

Parameters (Mandatory)

api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
project
STRING
Specifies the unique hash used to identify a specific project. This hash can be obtained through the project.overview method.

Parameters (Optional)

limit
INTEGER
Specifies the number of reults for each page. Adjust this value to control the number of results returned on each page. By default, this parameter is set to 100.
page
INTEGER
Specifies which set of links to return. This allows you to choose a specific page of results, with the number of results for each page determined by the limit parameter.
format
STRING
Specifies whether the response will be returned in XML or JSON format. By default, the result will be in XML format.
To be able to use the API documentation with real data, you have to create an API key in your account.
EXAMPLE
$baseUrl = "https://api.sistrix.com/project.onpage.links";

$post = [



];

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $baseUrl);

curl_setopt($curl, CURLOPT_POSTFIELDS, $post);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($curl);

curl_close($curl);
import requests

baseUrl = 'https://api.sistrix.com/project.onpage.links'

post = {



}

response = requests.post(baseUrl, post)

data = response.text
curl https://api.sistrix.com/project.onpage.links \


let baseUrl = 'https://api.sistrix.com/project.onpage.links';

let form = new FormData();



fetch(baseUrl, {

    method: 'POST',

    body: form

}).then(function(response){

    return response.text();

}).then(function(data){

    //data contains the results of the request

})