Backlinks API

List of backlinks

The method allows to get a list of a website’s backlinks.

Request format

 GET /backlinks/{site_id}?limit=100&offset=100

Request parameters

Name	Required	Description
limit	No	Total number of links. Max number of links – 1000
offset	No	Offset value

Result

If successful, the server returns a list of the specified website’s backlinks.

Example

[

{

“anchor”: “SE Ranking”,

“category”: “”,

“charge_period”: null,

“charge_start”: null,

“date_added”: “2018-06-11”,

“date_lost”: “2021-10-10”,

“date_placement”: “2018-10-11”,

“domain”: “highpoweredseo.com”,

“duration”: “”,

“fb_likes”: “2”,

“from_domainid”: “4630”,

“from_url”: “http://highpoweredseo.com/how-to-become-a-better”,

“gin_index”: “11”,

“gin_index_check_date”: “2018-10-05”,

“http_status”: “1”,

“id”: “53”,

“is_blocked_meta”: “1”,

“is_blocked_robotstxt”: “1”,

“is_disavow”: “0”,

“is_forced_status”: “0”,

“is_image”: “1”,

“is_link_not_found”: “1”,

“is_nofollow”: “1”,

“is_redir”: “1”,

“is_sponsored”: “0”,

“last_crawler_visit”: “2018-10-05”,

“link_manager”: “”,

“link_type”: “”,

“mozda”: null,

“notes”: “ghjg”,

“num_links”: 10,

“price”: null,

“source”: null,

“src_domain_country”: “USA”,

“src_domain_inlink_rank”: null,

“src_domain_ip”: “184.168.221.40”,

“src_domain_mozda_date”: null,

“src_domain_region_id”: null,

“src_domain_yandex_x”: null,

“src_domain_yandex_x_date”: null,

“title”: “Title”,

“to_url”: “http://tourl.ru/”,

“total_ext_links”: “2”,

“ugc”: null,

“yin_index”: “12”,

“yin_index_check_date”: “2018-10-05”

},

…

]

Response parameters

Name	Description
anchor	Backlink anchor text
id	Link ID
category	Target backlink category
charge_period	Charging period (onetime, monthly, quarterly, 6months, year)
charge_start	Payment start date
date_added	Date when the backlink was added
date_lost	Date when the backlink was lost
date_placement	Date when the backlink was placed
domain	Domain of the page that links back to your site
duration	Backlink placement duration according to the agreement with the donor
fb_likes	Total number of people who shared a given page on Facebook
from_domainid	Backlink domain ID
from_url	URL of the page that links back to your site
gin_index	Has the page containing the backlink been indexed by Google
gin_index_check_date	Date of check
http_status	HTTP status of the page containing the backlink
is_blocked_meta	Page is blocked via a meta header
is_forced_status	Status was changed manually
is_disavow	Backlink is disavowed
is_blocked_robotstxt	Page is blocked via robots.txt
is_image	Link in the image
is_link_not_found	Page backlink not found
is_nofollow	Link will not be indexed
is_redir	Page redirects to another page
is_sponsored	Backlink is sponsored
last_crawler_visit	Last crawling date
link_manager	Responsible individual
link_type	Type of backlink anchor text
notes	Note
num_links	Number of backlinks
price	Cost of backlink placement
source	Source
src_domain_ country	Country
src_domain_inlink_rank	Domain rank
src_domain_ ip	Referring IPs
src_domain_mozda_date	Date of check
src_domain_region_id	Region id
src_domain_ yandex_x	Yandex X (ИКС)
src_domain_ x_date	Date of check
title	Page title
to_url	Page that is referred to
total_ext_links	The number of external links found on the page with a reverse link
ugc	UGC (user generated content)
yin_index	Has the page containing the backlink been indexed by Yandex
yin_index_check_date	Date of check

Errors

HTTP code	Error message
403	Access denied (wrong site_id)

Adding a backlink

POST /backlinks/{site_id}

{

    “url”: “http://backlink.test/”,

    “price”: 1,

    “charge_period”: “onetime”,

    “charge_start”: “2018-01-01”

}

Request parameters

Name	Required	Description
url	Yes	Backlink URL
price	No	Backlink price
currency	No	Currency code ISO 4217 (USD, CAD, AUD, etc.)
charge_period	No	Payment (one-time, monthly)
charge_start	No	Payment start date

Result

If successful, the server returns the ID of the added backlink.

Example

{

    “id”: 1

}

Errors

HTTP code	Error message
400	Invalid URL
400	Backlinks limit exceeded
400	Backlink already exist
403	Access denied (wrong site_id)

List of backlinks import

The method allows to import a list of a website’s backlinks.

Request format

 POST /backlinks/{site_id}/list

{

    “group_id”: 1,

    “price”: 100,

    “currency”: “USD”,

    “manager”: “manager”,

    “charge_period”: “onetime”,

    “charge_start”: “2021-10-10”,

    “list”: [

        “https://google.com”,

        “https://yandex.ru”

    ]

}

Request parameters

Name	Required	Description
site_id	Yes	Website ID
list	Yes	Array of backlinks
price	No	Price
currency	No	Currency code ISO 4217 (USD, CAD, AUD, etc.)
charge_period	No	Charging period (onetime, monthly, quarterly, 6months, year)
charge_start	No	Payment start date (Y-m-d)
group_id	No	Group of backlink IDs
manager	No	Manager

Result

If successful, the server returns the number of added backlinks, number of duplicates and total number of backlinks.

Response example

 {

    “added”: 2,

    “duplicates”: 0,

    “total”: 2

}

Response parameters

Name	Description
added	Number of added backlinks
duplicates	Number of backlink duplicates
total	Total number of backlinks

Updating settings for running backlink import

The method allows to update settings for automatic backlink import from Google Search Console.

Request format

 PUT /backlinks/{site_id}/settings

{

    “gsc_autoimport”: true,

}

Request parameters

Name	Required	Description
site_id	Yes	Website ID
gsc_autoimport	Yes	true or false, enable or disable auto import from GSC

Result

If successful, the server returns the 204 HTTP code.

Errors

HTTP code	Error message
403	Access denied (wrong site_id)

Running a backlink import from Google Search Console

The method allows to run a backlink import from Google Search Console.

Request format

POST /backlinks/{site_id}/import-gsc

Request parameters

Name	Required	Description
site_id	Yes	Website ID

Result

If successful, the server returns the import task status and import task token that can be used to check its status in the future.

Response example

{

    “status”: “queued”,

    “token”: “1c84d0375d44725521647919c17f1cb9”

}

Response parameters

Name	Description
status	Import task status
token	Import task token

Errors

HTTP code	Error message
403	Access denied (wrong site_id)

Getting a backlink import status from Google Search Console

The method allows to get a backlink import status from Google Search Console.

Request format

GET /backlinks/{site_id}/import-status

Request parameters

Name	Required	Description
site_id	Yes	Website ID
token	Yes	Import task token obtained in the Running of backlink import method

Result

If successful, the server returns the import task status and the time in the timestamp format.

Response example

{

    “time”: 1635417036150,

    “status”: “queued”

}

Response parameters

Name	Description
status	Import task status
time	Time in timestamp format

Errors

HTTP code	Error message
403	Access denied (wrong site_id)

Deleting a backlink list

The method allows to delete a website’s backlink list.

Request format

POST /backlinks/{site_id}/delete

{

    “backlink_ids”: [

        1,

        2,

        3

    ]

}

Request parameters

Name	Required	Description
site_id	Yes	Website ID
backlink_ids	Yes	Array of backlink IDs

Result

If successful, the server returns the 204 HTTP code.

Errors

HTTP code	Error message
403	Access denied (wrong site_id)
400	Invalid ids

Running a backlink index/status check

The method allows to run an index or status check for a backlink list.

Request format

POST /backlinks/{site_id}/recheck

{

    “backlink_ids”: [

        1,

        2

    ],

    “recheck_type”:”index”

}

Request parameters

Name	Required	Description
site_id	Yes	Website ID
backlink_ids	Yes	Array of backlink IDs
recheck_type	No	Check type, possible values: status, index. If you do not pass the parameter, recheck_type=status will be used by default

Result

If successful, the server returns the 204 HTTP code.

Errors

HTTP code	Error message
403	Access denied (wrong site_id)
400	Invalid IDs

Backlink statistics

Request format

 GET /backlinks/{site_id}/stat

Request parameters

Name	Required	Description
site_id	Yes	Website ID

Response example

{

“total”: 9,

“anchors”: 1,

“ip”: 8,

“domains”: 9,

“dofollow”: 0,

“nofollow”: 1,

“limit”: 988

}

Response parameters

Name	Description
total	Total number of backlinks
anchors	Total number of unique anchor texts
ip	Total number of unique IP addresses
domains	Total number of unique domains
dofollow	Total number of dofollow links
nofollow	Total number of nofollow links
limit	Limit on adding links. Available for adding today

Errors

HTTP code	Error message
403	Access denied (wrong site_id)

List of disavowed backlinks

The method allows to get a list and number of disavowed backlinks.

Request format

GET /backlink-disavow/{site_id}?limit=100&offset=0

Request parameters

Name	Required	Description
site_id	Yes	Website ID
limit	No	Number of disavowed backlinks
offset	No	Offset

Result

If successful, the server returns a list and number of disavowed backlinks.

Response example

{

    “total_disavow_links”: 2,

    “disavow_links”: [

        {

            “id”: 3,

            “url”: “https://yandex.ru”,

            “type”: “url”,

            “exported”: 0,

            “yandex_x”: null,

            “domain_inlink_rank”: 96

        },

        {

            “id”: 4,

            “url”: “https://google.com”,

            “type”: “url”,

            “exported”: 0,

            “yandex_x”: null,

            “domain_inlink_rank”: 100

        }

    ]

}

Response parameters

Name	Description
total_disavow_links	Total number of disavowed backlinks
disavow_links	Array of disavowed backlinks
id	Disavowed backlink ID
url	Disavowed backlink URL
type	Backlink type
exported	Whether the backlink is exported
yandex_x	Yandex X rating value
domain_inlink_rank	Domain rank

Errors

HTTP code	Error message
403	Access denied (wrong site_id)

Adding a disavowed backlink list

The method allows to add a list of disavowed backlinks.

Request format

POST /backlink-disavow/{site_id}

{

    “list”: [

        “https://google.com”,

        “https://yandex.ru”

    ]

}

Request parameters

Name	Required	Description
site_id	Yes	Website ID
list	Yes	Array of backlinks

Result

If successful, the server returns the number of added disavowed backlinks.

Response example

{

    “added”: 2

}

Response parameters

Name	Description
added	Number of added disavowed backlinks

Errors

HTTP code	Error message
403	Access denied (wrong site_id)
400	Invalid list

Deleting a disavowed backlink

The method allows to delete a disavowed backlink from the list of disavowed backlinks.

Request format

DELETE /backlink-disavow/{site_id}?id={disavow_link_id}

Request parameters

Name	Required	Description
site_id	Yes	Website ID
disavow_link_id	Yes	Disavowed backlink ID

Errors

HTTP code	Error message
403	Access denied (wrong site_id)
400	Invalid disawov link ID
400	Disawov link does not exist

Result

If successful, the server returns the 204 HTTP code.

Table of content

Backlinks API

List of backlinks

Request format

Request parameters

Result

Example

Response parameters

Errors

Adding a backlink

Request parameters

Result

Example

Errors

List of backlinks import

Request format

Request parameters

Result

Response example

Response parameters

Updating settings for running backlink import

Request format

Request parameters

Result

Errors

Running a backlink import from Google Search Console

Request format

Request parameters

Result

Response example

Response parameters

Errors

Getting a backlink import status from Google Search Console

Request format

Request parameters

Result

Response example

Response parameters

Errors

Deleting a backlink list

Request format

Request parameters

Result

Errors

Running a backlink index/status check

Request format

Request parameters

Result

Errors

Backlink statistics

Request format

Request parameters

Response example

Response parameters

Errors

List of disavowed backlinks

Request format

Request parameters

Result

Response example

Response parameters

Errors

Adding a disavowed backlink list

Request format

Request parameters

Result

Response example

Response parameters

Errors

Deleting a disavowed backlink

Request format

Request parameters

Errors

Result