NAVNavbar
Logo
cURL php NodeJS Python cSharp

Anchors

‌‌
This endpoint will provide you with a detailed overview of anchors used when linking to the specified website with relevant backlink data for each of them.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to get a result
$post_array[] = array(
   "target" => "forbes.com",
   "limit" => 4,
   "filters" => ["anchor","like","%news%"],
   "order_by" => ["backlinks,desc"]
);
try {
   // POST /v3/backlinks/anchors/live
   // the full list of possible parameters is available in documentation
   $result = $client->post('/v3/backlinks/anchors/live', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "n";
   print "HTTP code: {$e->getHttpCode()}n";
   print "Error code: {$e->getCode()}n";
   print "Message: {$e->getMessage()}n";
   print  $e->getTraceAsString();
   echo "n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20210907",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "5.3152 sec.",
  "cost": 0.02012,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "09101555-1535-0272-0000-3c2484fbd64f",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "5.2271 sec.",
      "cost": 0.02012,
      "result_count": 1,
      "path": [
        "v3",
        "backlinks",
        "anchors",
        "live"
      ],
      "data": {
        "api": "backlinks",
        "function": "anchors",
        "target": "forbes.com",
        "limit": 4,
        "order_by": [
          "backlinks,desc"
        ],
        "filters": [
          "anchor",
          "like",
          "%news%"
        ]
      },
      "result": [
        {
          "target": "forbes.com",
          "total_count": 6393,
          "items_count": 4,
          "items": [
            {
              "type": "backlinks_anchor",
              "anchor": "news",
              "rank": 244,
              "backlinks": 3144,
              "first_seen": "2019-01-15 23:52:17 +00:00",
              "lost_date": null,
              "broken_backlinks": 12,
              "broken_pages": 9,
              "referring_domains": 661,
              "referring_main_domains": 550,
              "referring_ips": 514,
              "referring_subnets": 454,
              "referring_pages": 3039,
              "referring_links_tld": {
                "com": 2409,
                "org": 339,
                "net": 51,
                "no": 42,
                "de": 36,
                "info": 24,
                "pt": 18,
                "com.au": 13,
                "ru": 10,
                "blogspot.com": 8
              },
              "referring_links_types": {
                "anchor": 3039
              },
              "referring_links_attributes": {
                "nofollow": 212,
                "noopener": 201,
                "noreferrer": 57,
                "ugc": 44,
                "external": 16
              },
              "referring_links_platform_types": {
                "blogs": 1854,
                "cms": 1786,
                "unknown": 1131,
                "message-boards": 24,
                "ecommerce": 13,
                "wikis": 7
              },
              "referring_links_semantic_locations": {
                "": 2016,
                "article": 882,
                "section": 111,
                "main": 18,
                "header": 7,
                "aside": 5
              }
            },
            {
              "type": "backlinks_anchor",
              "anchor": "Read news",
              "rank": 251,
              "backlinks": 1932,
              "first_seen": "2019-09-16 02:11:07 +00:00",
              "lost_date": null,
              "broken_backlinks": 1,
              "broken_pages": 1,
              "referring_domains": 2,
              "referring_main_domains": 2,
              "referring_ips": 2,
              "referring_subnets": 2,
              "referring_pages": 1932,
              "referring_links_tld": {
                "org": 1931,
                "com": 1
              },
              "referring_links_types": {
                "anchor": 1932
              },
              "referring_links_attributes": null,
              "referring_links_platform_types": {
                "unknown": 1932
              },
              "referring_links_semantic_locations": {
                "": 1931,
                "section": 1
              }
            },
            {
              "type": "backlinks_anchor",
              "anchor": "Forbes.com    RSS   Feeds    Latest   news",
              "rank": 104,
              "backlinks": 712,
              "first_seen": "2019-01-19 06:11:14 +00:00",
              "lost_date": null,
              "broken_backlinks": 0,
              "broken_pages": 0,
              "referring_domains": 1,
              "referring_main_domains": 1,
              "referring_ips": 2,
              "referring_subnets": 1,
              "referring_pages": 712,
              "referring_links_tld": {
                "com": 712
              },
              "referring_links_types": {
                "anchor": 712
              },
              "referring_links_attributes": null,
              "referring_links_platform_types": {
                "blogs": 712,
                "cms": 712
              },
              "referring_links_semantic_locations": {
                "section": 712
              }
            },
            {
              "type": "backlinks_anchor",
              "anchor": "and you can read my weekly digest of Android news here on Forbes",
              "rank": 160,
              "backlinks": 389,
              "first_seen": "2019-01-18 17:39:41 +00:00",
              "lost_date": null,
              "broken_backlinks": 0,
              "broken_pages": 0,
              "referring_domains": 45,
              "referring_main_domains": 45,
              "referring_ips": 48,
              "referring_subnets": 46,
              "referring_pages": 211,
              "referring_links_tld": {
                "net": 130,
                "com": 70,
                "co.uk": 4,
                "in": 4,
                "ca": 1,
                "ie": 1,
                "online": 1
              },
              "referring_links_types": {
                "anchor": 211
              },
              "referring_links_attributes": {
                "noopener": 170,
                "noreferrer": 156,
                "nofollow": 27
              },
              "referring_links_platform_types": {
                "unknown": 142,
                "blogs": 69,
                "cms": 69,
                "ecommerce": 6
              },
              "referring_links_semantic_locations": {
                "article": 177,
                "": 29,
                "main": 4,
                "section": 1
              }
            }
          ]
        }
      ]
    }
  ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array.

Description of the fields for setting a task:

Field name Type Description
target string domain, subdomain or webpage to get anchors for
required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)
limit integer the maximum number of returned anchors
optional field
default value: 100
maximum value: 1000
offset integer offset in the results array of returned anchors
optional field
default value: 0
if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors
internal_list_limit integer maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:
referring_links_tld
referring_links_types
referring_links_attributes
referring_links_platform_types
referring_links_semantic_locations

default value: 10
maximum value: 1000

backlinks_status_type string set what backlinks to return and count
optional field
you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
possible values:
all – all backlinks will be returned and counted;
live – backlinks found during the last check will be returned and counted;
lost – lost backlinks will be returned and counted;

default value: live

filters array 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:
=, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:
["referring_links_types.anchors",">","1"]

[["broken_pages",">","2"],
"and",
["backlinks",">","10"]]

[["first_seen",">","2017-10-23 11:31:45 +00:00"],
"and",
[["anchor","like","%seo%"],"or",["referring_domains",">","10"]]]

The full list of possible filters is available here.

order_by array results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:
asc – results will be sorted in the ascending order
desc – results will be sorted in the descending order
you should use a comma to set up a sorting type
example:
["backlinks,desc"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:
["backlinks,desc","rank,asc"]
backlinks_filters array filter the backlinks of your target
optional field
you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
you can filter the backlinks by all fields available in the response of this endpoint
using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
example:
"backlinks_filters": [["dofollow", "=", true]]
include_subdomains boolean indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true
exclude_internal_backlinks boolean indicates whether the backlinks from subdomains of the target are excluded
optional field
if set to false, the backlinks from subdomains of the target will be ommited and you won’t receive the same domain in the response;
default value: true
tag string 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

‌‌‌‌‌‌
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            target string target in the post array
            total_count integer total number of relevant items in the database
            items_count integer number of items in the results array
            items array items array
               type string type of element = ‘backlinks_anchor’
               anchor string anchor of the backlink
               rank integer acnhor rank
anchor rank across all anchors in the database
rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
               backlinks integer indicates the number of backlinks
               first_seen string date and time when our crawler found the backlink for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00
               lost_date string date and time when the last backlink with this anchor was lost
indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2017-01-24 13:20:59 +00:00
               broken_backlinks integer number of broken backlinks
number of broken backlinks pointing to the target
               broken_pages integer number of broken pages
number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to
               referring_domains integer indicates the number of referring domains
               referring_main_domains integer indicates the number of referring main domains
               referring ips integer number of referring IP addresses
number of IP addresses pointing to this page
               referring subnets integer number of referring subnetworks
               referring_pages integer indicates the number of pages pointing to target with this anchor
               referring_links_tld object top-level domains of the referring links
contains top level domains and referring link count per each
               referring_links_types object types of referring links
indicates the types of the referring links and link count per each type
possible values:
anchor, image, link, meta, canonical, alternate, redirect
               referring_links_attributes object link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute
               referring_links_platform_types object types of referring platforms
indicates referring platform types and and link count per each platform
               referring_links_semantic_locations object semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and link count per each semantic location

you can get the full list of semantic elements here
examples:
article, section, summary

‌‌