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. Outdates metrics are not removed from the method to maintain backward compatibility.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Value	Description
id	any number or string	Request id
method	SerpstatBacklinksProcedure.getAnchors	API method name
params	{...}	Array with parameters
query	domain	Domain of analyzed site
searchType	domain_with_subdomains \| url	Search type — domain with subdomains or url
(optional) page	number	Page number. Default: 1
(optional) size	number	Number of results. Default: 20
(optional) anchor	anchor text	Anchor text to filter on it. Default: not filtered
(optional) count	number	Number of words in anchor to filter. Default: not filtered
(optional) order	desc \| asc	Sorting. Default: descending
(optional) sort	total \| refDomains \| noFollow	Selects a data column to sort. Default: refDomains

Response parameters
Parameter	Description
id	Request id
result	Contains the answer
data	Array with data
anchor	Anchor content
url_from	Linking page
url_to	Target page
refDomains	Number of referring domains with an anchor
total	Number of backlinks with an anchor
noFollow	Number of nofollow backlinks with an anchor
summary_info	Array with data
page	Page number
total	Number of results for request
count	Number of results in this answer
left_lines	Left limit of lines for your pricing plan
sort	What data is sorted by
order	Data sorted in ascending / descending order

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

{
     "anchor": "Офіційна інформація",
     "refDomains": 27,
     "total": 4642,
     "noFollow": 0
}

Example

Request data:

{
    "id": 1,
    "method": "SerpstatBacklinksProcedure.getAnchors",
    "params": {
        "query": {{domain}},
        (optional) "searchType": {{"domain_with_subdomains" | "url"}},
        (optional) "anchor": {{anchor text}},
        (optional) "count": {{words in anchor}},
        (optional) "page": {{page}},
        (optional) "size": {{size}},
        (optional) "order": {{"asc" | "desc"}},
        (optional) "sort": {{"total" | "refDomains" | "noFollow"}}
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "anchor": "Офіційна інформація",
                "refDomains": 27,
                "total": 4642,
                "noFollow": 0
            },
            {
                "anchor": "Детальна інформація.",
                "refDomains": 1,
                "total": 4,
                "noFollow": 0
            }
        ],
        "summary_info": {
            "total": 2,
            "page": 1,
            "sort": "refDomains",
            "order": "DESC",
            "count": 2,
            "left_lines": 9988460
        }
    }
}