How You Can Help Ukrainians Today (SE Ranking Team Included)Learn here

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

NameRequiredDescription
limitNo Total number of links. Max number of links – 1000
offsetNoOffset 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

NameDescription
anchorBacklink anchor text
idLink ID
categoryTarget backlink category
charge_period Charging period (onetime, monthly, quarterly, 6months, year)
charge_startPayment start date
date_added Date when the backlink was added
date_lostDate 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_domainidBacklink 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_dateDate 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_disavowBacklink is disavowed
is_blocked_robotstxt Page is blocked via robots.txt
is_imageLink in the image
is_link_not_foundPage backlink not found
is_nofollowLink will not be indexed
is_redir
Page redirects to another page
is_sponsoredBacklink is sponsored
last_crawler_visitLast crawling date
link_managerResponsible individual
link_type
Type of backlink anchor text
notesNote
num_linksNumber of backlinks
price
Cost of backlink placement
sourceSource

src_domain_ country
Country
src_domain_inlink_rankDomain rank

src_domain_ ip
Referring IPs
src_domain_mozda_dateDate of check
src_domain_region_idRegion id

src_domain_ yandex_x
Yandex X (ИКС)

src_domain_ x_date
Date of check
titlePage title
to_urlPage that is referred to
total_ext_linksThe number of external links found on the page with a reverse link
ugcUGC (user generated content)
yin_index
Has the page containing the backlink been indexed by Yandex

yin_index_check_date
Date of check

Errors

HTTP codeError message
 403Access 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

NameRequiredDescription
urlYesBacklink URL
priceNoBacklink price
currencyNoCurrency code ISO 4217 (USD, CAD, AUD, etc.)
charge_periodNoPayment (one-time, monthly)
charge_startNoPayment start date

Result

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

Example

{
“id”: 1
}

Errors

HTTP codeError message
400Invalid URL
400Backlinks limit exceeded
400Backlink already exist
403Access 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

NameRequiredDescription
site_idYesWebsite ID
listYesArray of backlinks
priceNoPrice
currencyNoCurrency code ISO 4217 (USD, CAD, AUD, etc.)
charge_periodNoCharging period (onetime, monthly, quarterly, 6months, year)
charge_startNoPayment start date (Y-m-d)
group_idNoGroup of backlink IDs
managerNoManager

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

NameDescription
addedNumber of added backlinks
duplicatesNumber of backlink duplicates
totalTotal 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

NameRequiredDescription
site_idYesWebsite ID
gsc_autoimportYestrue or false, enable or disable auto import from GSC

Result

If successful, the server returns the 204 HTTP code.

Errors

HTTP codeError message
403Access 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

NameRequiredDescription
site_idYesWebsite 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

NameDescription
statusImport task status
tokenImport task token

Errors

HTTP codeError message
403Access 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

NameRequiredDescription
site_idYesWebsite ID
tokenYesImport 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

NameDescription
statusImport task status
timeTime in timestamp format

Errors

HTTP codeError message
403Access 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

NameRequiredDescription
site_idYesWebsite ID
backlink_idsYesArray of backlink IDs

Result

If successful, the server returns the 204 HTTP code.

Errors

HTTP codeError message
403Access denied (wrong site_id)
400Invalid 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

NameRequiredDescription
site_idYesWebsite ID
backlink_idsYesArray of backlink IDs
recheck_typeNoCheck 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 codeError message
403Access denied (wrong site_id)
400Invalid IDs

Backlink statistics

Request format

 GET /backlinks/{site_id}/stat 

Request parameters

NameRequiredDescription
site_idYesWebsite ID

Response example

{
“total”: 9,
“anchors”: 1,
“ip”: 8,
“domains”: 9,
“dofollow”: 0,
“nofollow”: 1,
“limit”: 988
}

Response parameters

NameDescription
totalTotal number of backlinks
anchorsTotal number of unique anchor texts
ipTotal number of unique IP addresses
domainsTotal number of unique domains
dofollowTotal number of dofollow links
nofollowTotal number of nofollow links
limitLimit on adding links. Available for adding today

Errors

HTTP codeError message
403Access 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

NameRequiredDescription
site_idYesWebsite ID
limitNoNumber of disavowed backlinks
offsetNoOffset

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

NameDescription
total_disavow_linksTotal number of disavowed backlinks
disavow_linksArray of disavowed backlinks
idDisavowed backlink ID
urlDisavowed backlink URL
typeBacklink type
exportedWhether the backlink is exported
yandex_xYandex X rating value
domain_inlink_rankDomain rank

Errors

HTTP codeError message
403Access 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

NameRequiredDescription
site_idYesWebsite ID
listYesArray of backlinks

Result

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

Response example

{
“added”: 2
}

Response parameters

NameDescription
addedNumber of added disavowed backlinks

Errors

HTTP codeError message
403Access denied (wrong site_id)
400Invalid 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

NameRequiredDescription
site_idYesWebsite ID
disavow_link_idYesDisavowed backlink ID

Errors

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

Result

If successful, the server returns the 204 HTTP code.