API Description

Backlink Checker

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

Request format

Title of the code block
Copy
GET /backlinks/{site_id}?limit=100&offset=100

Request parameters

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

Title of the code block
Copy
[
{
"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_alexa": null,
"src_domain_alexa_date": 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,
"title": "Title",
"to_url": "http://tourl.ru/",
"total_ext_links": "2",
"ugc": null,
}
]

Response parameters

NameDescription
anchorBacklink anchor text
idLink ID
categoryTarget backlink category
charge_periodCharging period(onetime, monthly, quarterly, 6months, year)
charge_startPayment start date
date_addedDate when the backlink was added
date_lostDate when the backlink was lost
date_placementDate when the backlink was placed
domainDomain of the page that links back to your site
durationBacklink placement duration according to the agreement with the donor
fb_likesTotal number of people who shared a given page on Facebook
from_domainidBacklink domain ID
from_urlURL of the page that links back to your site
gin_indexHas the page containing the backlink been indexed by Google
gin_index_check_dateDate of check
http_statusHTTP status of the page containing the backlink
is_blocked_metaPage is blocked via a meta header
is_blocked_robotstxtPage is blocked via robots.txt
is_disavowBacklink is disavowed
is_forced_statusStatus was changed manually
is_imageLink in the image
is_link_not_foundPage backlink not found
is_nofollowLink will not be indexed
is_redirPage redirects to another page
is_sponsoredBacklink is sponsored
last_crawler_visitLast crawling date
link_managerResponsible individual
link_typeType of backlink anchor text
mozdaMoz Domain Authority
notesNote
num_linksNumber of backlinks
priceCost of backlink placement
sourceSource
src_domain_alexaBacklink domain Alexa rank
src_domain_alexa_dateDate of Alexa check
src_domain_countryCountry
src_domain_inlink_rankDomain rank
src_domain_ipReferring IPs
src_domain_mozda_dateDate of check
src_domain_region_idRegion id 
titlePage title
to_urlPage that is referred to
total_ext_linksTotal number of external links found on the page containing the backlink
ugcUGC (user generated content)
group_idBacklink group ID

Errors

HTTP code Error message
403Access denied (wrong site_id)
Title of the code block
Copy
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

Title of the code block
Copy
{"id": 1}

Errors

HTTP code Error message
400Invalid URL
400Backlinks limit exceeded
400Backlink already exists
400The currency provided is not valid
403Access denied (wrong site_id)

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

Request format

Title of the code block
Copy
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"]
}

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

Title of the code block
Copy
{"id": 1}

Response parameters

NameDescription
addedNumber of added backlinks
duplicatesNumber of backlink duplicates
totalTotal number of backlinks

Errors

HTTP code Error message
403Access denied (wrong site_id)
400The currency provided is not valid

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

Request format

Title of the code block
Copy
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 code Error message
403Access denied (wrong site_id)

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

Request format

Title of the code block
Copy
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

Title of the code block
Copy
{
"status": "queued",
"token": "1c84d0375d44725521647919c17f1cb9"
}

Response parameters

NameDescription
statusImport task status
tokenImport task token

Errors

HTTP code Error message
403Access denied (wrong site_id)

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


Request format

Title of the code block
Copy
{
"status": "queued",
"token": "1c84d0375d44725521647919c17f1cb9"
}

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

Title of the code block
Copy
{
"time": 1635417036150,
"status": "queued"
}

Response parameters

NameDescription
statusImport task status
timeTime in timestamp format

Errors

HTTP code Error message
403Access denied (wrong site_id)


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

Request format

Title of the code block
Copy
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 code Error message
403Access denied (wrong site_id)
400Invalid ids

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

Request format

Title of the code block
Copy
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 code Error message
403Access denied (wrong site_id)
400Invalid IDs

Request format

Title of the code block
Copy
GET /backlinks/{site_id}/stat

Request parameters

NameRequiredDescription
backlink_idYesBacklink ID

Response example

Title of the code block
Copy
{
"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 code Error message
403Access denied (wrong site_id)

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


Request format

Title of the code block
Copy
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

Title of the code block
Copy
{
"total_disavow_links": 2,
"disavow_links": [
{ "id": 3, "url": "https://google.com", "type": "url", "exported": 0, "alexa": null, "domain_inlink_rank": 96 },
{ "id": 4, "url": "https://google.com", "type": "url", "exported": 0, "alexa": 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
alexaAlexa rank value
domain_inlink_rankDomain rank

Errors

HTTP code Error message
403Access denied (wrong site_id)

The method allows to add a list of disavowed backlinks.

Request format

Title of the code block
Copy
POST /backlink-disavow/{site_id}
{
"list": [
"https://google.com",
"https://google.com"
]
}


Request parameters

NameRequiredDescription
site_idYesWebsite ID
listYesArray of backlinks


Result

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

Response example

Title of the code block
Copy
{ "added": 2 }



Response parameters

NameDescription
addedNumber of added disavowed backlinks

Errors

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


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


Request format

Title of the code block
Copy
DELETE /backlink-disavow/{site_id}?id={disavow_link_id}


Request parameters

NameRequiredDescription
site_idYesWebsite ID
disavow_link_idYesDisavowed backlink ID


Result

If successful, the server returns the 204 HTTP code.

Errors

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



The method allows to get a list and number of backlink groups.

Request format

Title of the code block
Copy
GET /backlink-groups/{site_id}


Request parameters

NameRequiredDescription
site_idYesWebsite ID


Result

If successful, the server returns the list and number of backlink groups.

Response example

Title of the code block
Copy
{
"total_groups": 2,
"groups": [
{ "id": 1, "name": "General", "count": 5 },
{ "id": 2, "name": "Second group", "count": 1 }
]
}


Response parameters

NameDescription
total_groupsTotal number of groups
groupsArray of groups
idGroup ID
nameGroup name
countNumber of backlinks in group

Errors

HTTP code Error message
403Access denied (wrong site_id)



The method allows to create a group of website backlinks.

Request format

Title of the code block
Copy
POST /backlink-groups/{site_id}
{ "name": "Group name" }


Request parameters

NameRequiredDescription
site_idYesWebsite ID
nameYesGroup name


Result

If successful, the server returns a backlink group ID.

Response example

Title of the code block
Copy
{ "group_id": 2 }

Response parameters

NameDescription
group_idBacklink group ID

Errors

HTTP code Error message
403Access denied (wrong site_id)
400Invalid name
400Group already exists


The method allows to delete a group of a website’s backlinks.

Request format

Title of the code block
Copy
DELETE /backlink-groups/{site_id}?id={id}


Request parameters

NameRequiredDescription
site_idYesWebsite ID
idYesBacklink group ID


Result

If successful, the server returns the 204 HTTP code.

Errors

HTTP code Error message
403Access denied (wrong site_id)
400Invalid group ID
400Group does not exist



The method allows to change the name of a backlink group.

Request format

Title of the code block
Copy
PUT /backlink-groups/{site_id}
{ "id": 2, "name": "New group name" }


Request parameters

NameRequiredDescription
site_idYesWebsite ID
idYesBacklink group ID 
nameYesNew backlink group name


Result

If successful, the server returns the 204 HTTP code.

Errors

HTTP code Error message
403Access denied (wrong site_id)
400Invalid name
400Group already exists


The method allows to move backlinks from one group to another.

Request format

Title of the code block
Copy
POST /backlink-groups/{site_id}/move
{ "id": 1, "backlink_ids": [1], "group_ids": [2] }


Request parameters

NameRequiredDescription
site_idYesWebsite ID
idYesBacklink group ID to move to 
backlink_idsNoArray of IDs of backlinks to be moved
group_idsNoArray of IDs of backlink groups to be moved


Result

If successful, the server returns the 204 HTTP code.

Errors

HTTP code Error message
403Access denied (wrong site_id)
400Invalid group IDs
400Backlink group IDs
400IDs of groups or backlinks are required