Get access to 30+ marketing and SEO tools. analyze competitors, keywords, and backlinks for free..
Sign in Sign Up

We use cookies to make Serpstat better. By clicking "Accept cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. Learn more

Anchors (getAnchors)

The getAnchors  method gives you a list of keywords used as anchors for backlinks of a site you analyze. The data set is similar to the Anchors report. 

General request parameters and instructions for using Serpstat API

Request parameters
Parameter Description Default
id required A request id: the response contains the same id. Enter any number (number) or text (string) value
method required API method name: SerpstatBacklinksProcedure.getAnchors
params required The object with parameters {...}, it lists all the following parameters and arrays [...]
query required A domain of the analyzed site. Specify the domain without HTTP, HTTPS, and "/"
searchType required Search type:
* domain - only domain (site.com)
* domain_with_subdomains - domain with subdomains (subdomain.site.com)
* URL - the specific URL (site.com/path/)
part_url - URL starts with (site.com/path/*)
anchor optional An anchor of the analyzed link
count optional A number of words in the anchor 1
page optional A page number (number value) 1
size optional A number of results (number value) 100
sort optional Sorting:
* total - the total number of anchors
* refDomains - number of referring domains
* nofollow - anchor attributes
* anchor - the anchor of the incoming link
* lastupdate - date of the first detection
lastupdate
order optional Order:
asc - in the ascending order
desc - in the descending order
desc
complexFilter optional Data filtering, entered as arrays [...] with the following parameters:
1) field - filter parameter; available filtering:
* total - the total number of anchors
* refDomains - number of referring domains
* nofollow - anchor attributes
* anchor - the anchor of the incoming link
* lastupdate - link detection date. Value format: DD.MM.YYYY (01.01.2001)

2) compareType - filter parameter:
* gt - greater than (number value)
* lt - less than (number value)
* gte - greater than or equal (number value)
* lte - less than or equal (number value)
* eq - exact match (number or text value)
* neq - does not meet the requirement (number or text value)
* between - between (number value)
* contains - contains (text value)
* notContains - does not contain (text value)
* startsWith - starts with (text value)
* endsWith - ends with (text value)

3) value - filter value

Quick filters:
additional_filters - the following parameters are currently available:
* no_subdomains - without links from subdomains of the analyzed domain

The first square brackets list the "OR" conditions. The second ones within the first are the "AND" conditions.

Response parameters
Parameter Description
id Response id corresponds the request id
result Contains the answer
data Array with data
anchor The anchor text
refDomains The number of referring domains with this anchor
total The number of backlinks with this anchor
noFollow Link attributes. Options: follow, nofollow, UGC, sponsored
summary_info Object with data
page Page number
total Number of results for the request
count Number of results in this answer
left_lines Left credits of lines for your pricing plan
sort What data are sorted by
order Data sorted:
* asc - in the ascending order
* desc - in the descending order

API credits are spent at 1 credit per line. Part of the API response for which you spend 1 credit:

{
     "anchor": "«Serpstat»",
     "refDomains": 3,
     "total": 3,
     "noFollow": 3
}

Example
Request data:
{
 "id": 1,
 "method": "SerpstatBacklinksProcedure.getAnchors",
 "params": {
     "query": "serpstat.com",
     "searchType": "domain_with_subdomains",
     "anchor": "serpstat",
     "count": "1",
     "sort": "anchor",
     "order": "desc",
     "page": 1,
     "size": 2,
     "complexFilter": [
           [
                {
                    "field": "anchor",
                    "compareType": "contains",
                    "value": [
                        "serpstat"
                    ]
                },
                {
                    "field": "total",
                    "compareType": "gt",
                    "value": [
                        "1"
                    ]
                },
                {
                    "field": "noFollow",
                    "compareType": "gte",
                    "value": [
                        "1"
                    ]
                },
                 {
                    "additional_filters": "no_subdomains"
                }
            ]
        ]
  }
}
Response data:
{
    "id": "1",
    "result": {
        "data": [
            {
                "anchor": "加入Serpstat会员计划››",
                "refDomains": 1,
                "total": 2,
                "noFollow": 2
            },
            {
                "anchor": "«Serpstat»",
                "refDomains": 3,
                "total": 3,
                "noFollow": 1
            }
        ],
        "summary_info": {
            "left_lines": 999816,
            "page": 1,
            "count": 2,
            "total": 78,
            "sort": "anchor",
            "order": "DESC"
        }
    }
}