SEO PowerSuite Backlinks API v1.0
Reference Guide
Introduction
This document describes SEO PowerSuite Backlinks API v1.0. The API lets you obtain a wide range of backlink data from our backlink index, which you
can use for your research and analysis or make available to others through your interface according to the agreement.

Table of contents
Introduction ........................................................................................................................................................................................1
Table of contents ................................................................................................................................................................................1
Glossary ..............................................................................................................................................................................................2
Available Data ....................................................................................................................................................................................2
Authentication ....................................................................................................................................................................................3
Command overview ...........................................................................................................................................................................3
1.

get-summary ..........................................................................................................................................................................32.

get-metrics .............................................................................................................................................................................63.

get-inlink-rank .......................................................................................................................................................................84.

get-backlinks ..........................................................................................................................................................................95.

get-refdomains .....................................................................................................................................................................116.

get-anchors ...........................................................................................................................................................................127.

get-pages ..............................................................................................................................................................................148.

get-ips...................................................................................................................................................................................16

9.

download-all-backlinks........................................................................................................................................................18

10.

get-raw-backlinks ................................................................................................................................................................1911.

get-new-lost-backlinks .........................................................................................................................................................2212.

get-new-lost-refdomains ......................................................................................................................................................25

13.

get-new-lost-backlinks-count ..............................................................................................................................................27

14.

get-new-lost-refdomains-count ............................................................................................................................................29

15.

get-backlinks-count..............................................................................................................................................................31

16.

get-refdomains-count ...........................................................................................................................................................32

17.

get-subnets-count .................................................................................................................................................................33

18.

get-ips-count ........................................................................................................................................................................35

19.

get-page-inlink-rank ............................................................................................................................................................36

20.

get-domain-inlink-rank ........................................................................................................................................................37

21.

get-subscription-info ............................................................................................................................................................38

Error Handling ..................................................................................................................................................................................39

GlossaryTerm

Deﬁnition

Backlink (Link)

A reference to the target URL in the form of a link, redirect, redirect chain, or canonical link that comes from a different
domain than the target.

DomainA network domain is an administrative grouping of multiple private computer networks or hosts within the same
infrastructure under one domain name, e.g. domain.com. Optionally, a domain may have subdomains.

Subdomain

A subdomain is a domain that is a part of another domain, e.g.:• sub.domain.com is a subdomain of domain.com• example.sub.domain.com is a subdomain of sub.domain.com• example.sub.domain.com is a subdomain of domain.com

Host

A host is a domain name that is completely speciﬁed with all labels in the hierarchy of the DNS, having no parts omitted, e.g.:• in the URL https://www.example.sub.domain.com/path, the host name will be www.example.sub.domain.com

Page (URL)

A reference to a web resource that speciﬁes its location on a computer network and a mechanism for retrieving it.

Referring Page (URL)

A page which sends users to your website via links or redirects.

Destination Page
(URL)

A page a link or a redirect points to.

Referring domain

A host name of the Referring Page (URL).

TargetAn entity for which you are retrieving backlinks. Can be determined at an exact URL, domain, or subdomain.

Anchor Text

Anchor text is the clickable text in a hyperlink.

Nofollow

Nofollow is a value that can be assigned to the rel attribute in the <a> tag or robots meta tag. It is one of Google’s
recommended methods for ﬂagging spam, advertising-related or sponsored links. More details here.
Nofollow links do not normally pass SEO weight (or pass less SEO weight) to the destination URL, and hence are unlikely tohave an effect on its rankings.

InLink Rank

InLink Rank is the indicator of a page's authority. It is based off the same algorithm as the original Google PageRank and isdetermined by the number and weight of incoming links to a page. InLink Rank is scored using a 0 to 100 logarithmic scale.
The higher is the number, the higher the page's authority.

Domain InLink Rank

Domain InLink Rank is the indicator of a domain's authority. Like InLink Rank, Domain InLink Rank can be used to assessdomains that links come from.

Available Data
This API provides access to the following set of data:
•
•
•
•
•
•
•

•

Number of backlinks linking to a domain/host/URL
Number of unique hosts linking to a domain/host/URL
Number of .edu hosts linking to a domain/host/URL
Number of .gov hosts linking to a domain/host/URL
InLink Rank (Page Authority) of a URL
Domain InLink Rank (Domain Authority) of a domain/host/URL
List of top links pointing to a domain/host/URL (sorted by InLink Rank, descending) that includes the following information:o Referring Page's URL
o Referring Page's Titleo Target URL
o Anchor Text
o Dofollow/Nofollow
o Referring Page's InLink Ranko Referring Page's Domain InLink Rank
List of the latest links pointing to a domain/host/URL (sorted by found date, descending) that includes the following information:o Referring Page's URL
o Referring Page Titleo Target URL
o Anchor Text
o Dofollow/Nofollow
o Referring Page's InLink Ranko Referring Page's Domain InLink Rank

•

•

•

•

List of anchor texts that backlinks that point to a domain/host/url possess (sorted by backlinks number or refdomains number, descending) that
includes the following information:o Anchor Texto Backlinks numbero Refdomains number
List of unique page URLs that belong to a domain/host (sorted by backlinks number or refdomains number, descending) that includes thefollowing information:o URL
o Backlinks numbero Refdomains number
Historical record of all backlinks and referring domains that have been seen by our crawlers as "live” but are not necessary live today. This data
includes:o the number of new and lost backlinks and/or referring domains for each domain/host/URL and any given period of time, with the ability toﬁlter the data based on the backlinks' properties (new/lost, dofollow/nofollow, href-links/redirects, image/text links, etc.)o the list of new and lost backlinks and/or referring domains for each domain/host/URL and any given period of time, with the ability toﬁlter the data based on the backlinks' properties (new/lost, dofollow/nofollow, href-links/redirects, image/text links, etc.)
and many other backlink metrics.

Authentication
Access to the service requires a unique API key, which will be issued and provided to you once you become our partner.
To make calls to SEO PowerSuite Backlinks API, you must pass your API key in the apikey GET parameter with every request.

Command overview
Below is a list of commands available via SEO PowerSuite Backlinks API along with a brief overview of their functionality.

1. get-summary
This command returns the extended statistics for the target such as: number of backlinks to the target, number of referring domains, subnets, IPs, top
anchors, top TLDs etc.
This command supports batching multiple targets into a single request. If you need to make a batch request and get metrics for multiple targets (100max), you can pass multiple targets as GET parameters (separated by '&') or use a POST request.

GET Request
To receive information about a single target
GET: https://api.seopowersuite.com/backlinks/v1.0/get-summary?apikey=XXX&target=https://www.seopowersuite.com&mode=url&output=json

To receive information about multiple targets
GET: https://api.seopowersuite.com/backlinks/v1.0/get-summary?apikey=XXX&target=https://www.seopowersuite.com&target=https://www.link-assistant.com&mode=url&output=json

POST Request
To receive information about multiple targets
POST: https://api.seopowersuite.com/backlinks/v1.0/get-summary?apikey=XXX&output=json{"target": ["https://www.seopowersite.com/","https://www.link-assistant.com/"],"mode": "host"}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-summary
Parameter DataType

Mandatory

Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), or URL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••outputstringnojsondomain (*.example.com/*) - analysis will be done for all
URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done for
all URLs that belong to this host (subdomains will not
be included).
url (http://www.example.com/) - analysis will be done
for the particular URL only.

Output format••

json - get response in JSON format.
xml - get response in XML format.

hostdomain

json

json

xml

Response Parameters: get-summary
Parameter

Data
Type

Description

ExampletargetstringAim of the request: root domain, host, or URL

seopowersuite.com

backlinks

int

Total number of live backlinks

10000

refdomains

int

Number of unique domains linking to a target

1000

subnets

int

Number of unique subnets / C-blocks linking to a target

50

ips

int

Number of unique IPs linking to a target

80

nofollow_backlinks

intNumber of backlinks marked as nofollow with a rel="nofollow"
attribute in the <a> tag or robots meta tag

100

dofollow_backlinks

intNumber of backlinks NOT marked as nofollow with arel="nofollow" attribute in the <a> tag or robots meta tag

900

from_home_page_backlinks

intNumber of backlinks coming from a home page of the referring
domain40dofollow_from_home_page_backlinks

intNumber of 'dofollow' backlinks, which come from a home pageof the referring domain

40

text_backlinks

intNumber of backlinks that use text as an anchor

750

edu_backlinks

intNumber of backlinks coming from .edu domains0

gov_backlinks

intNumber of backlinks coming from .gov domains

1

inlink_rank

int

InLink Rank (Page Authority) of the target URL

21

domain_inlink_rank

intDomain InLink Rank (Domain Authority) of the target's root
domain68

dofollow_refdomains

int

Number of referring domains with at least one 'dofollow' linkpointing to the target40

from_home_page_refdomains

int

Number of referring domains with at least backlink coming froma home page of the domain40

edu_refdomains

int

Number of .edu referring domains

40

gov_refdomains

int

Number of .gov referring domains

40anchors

int

Total number of unique anchor texts being used within all
backlinks pointing to the target

50

dofollow_anchorsint

Total number of unique anchor texts being used within 'dofollow'
backlinks pointing to the target40

pages_with_backlinks

int

Total number of linked pages belonging to the target

500

top_anchors_by_backlinks

array

Array of the top anchor text and the number of backlinks
with this anchor

top_anchors_by_backlinks › anchor

stringAnchor text used in backlinks"SEO PowerSuite"

top_anchors_by_backlinks › backlinks

stringNumber of backlinks found that are using the anchor

40

top_anchors_by_refdomains

array

Array of the top anchor text and the number of referring domains
with this anchor

top_anchors_by_refdomains › anchor

stringAnchor text used in backlinks"SEO PowerSuite"

top_anchors_by_refdomains ›refdomains

stringNumber of referring domains with at least one backlink using theanchor40

top_pages_by_backlinks

array

Array of the top linked pages belonging to the target and thenumber of backlinks pointing to this page

top_pages_by_backlinks › url

string

URL of the pagehttps://target.com/page.html

top_pages_by_backlinks › backlinks

intNumber of backlinks pointing to this page24

top_pages_by_refdomains

array

Array of the top linked pages belonging to the target URLs andthe number of unique referring domains pointing to this page

top_pages_by_refdomains › refdomains

int

Number of referring domains pointing to this page20

top_pages_by_refdomains › url

string

URL of the pagehttps://target.com/page.html

top_tlds

array

Array of the top TLDs which have backlinks pointing to the target

top_tlds › tld

stringTLD (top-level domain).com

top_tlds › count

int

Number of backlinks from the TLD pointing to the target

700

top_countries

array

Array of the top countries which have backlinks pointing to thetargettop_countries › country

stringCountry codeUs

top_countries › count

int

Number of backlinks from the speciﬁed country pointing to thetarget600

Sample Request: get-summary
GET: https://api.seopowersuite.com/backlinks/v1.0/getsummary?apikey=XXX&target=seopowersuite.com&mode=domain&output=json

Sample Response: get-summary{"summary": [{"target": "seopowersuite.com","backlinks": 22407,"refdomains": 2329,"subnets": 1403,"ips": 1961,"nofollow_backlinks": 3718,"dofollow_backlinks": 18689,"edu_backlinks": 40,"gov_backlinks": 0,"inlink_rank": 24,"domain_inlink_rank": 68,"from_home_page_backlinks": 88,"dofollow_from_home_page_backlinks": 60,"text_backlinks": 21427,"dofollow_refdomains": 1291,"from_home_page_refdomains": 64,

"edu_refdomains": 6,"gov_refdomains": 0,"anchors": 720,
"dofollow_anchors": 522,
"pages_with_backlinks": 87,"top_anchors_by_backlinks": [{"anchor": "SEO PowerSuite","backlinks": 1853},{"anchor": "social listening","backlinks": 1542},{"anchor": "SEOPOWERSUITE.COM","backlinks": 1209},{"anchor": "Buy SEO PowerSuite tools - place secure order online","backlinks": 1157},{"anchor": "Search Engine Optimization","backlinks": 890},{"anchor": "the website","backlinks": 872},{"anchor": "SEO","backlinks": 864},{"anchor": "search bar (I’ve","backlinks": 849},{"anchor": "the site","backlinks": 836},{"anchor": "search bar (I have actually","backlinks": 831}],
"top_anchors_by_refdomains": [{"anchor": "SEO PowerSuite","refdomains": 454},{"anchor": "seopowersuite.com","refdomains": 192},{"anchor": "SEO Powersuite","refdomains": 155},{"anchor": "https://www.seopowersuite.com/","refdomains": 116},{"anchor": "SEO Power Suite","refdomains": 111},{"anchor": "seopowersuite","refdomains": 106},{"anchor": "SEO software tools for results-driven site owners.","refdomains": 66},{"anchor": "","refdomains": 64},{"anchor": "SEO software tools for results-driven site owners","refdomains": 56},{"anchor": "Go Now","refdomains": 44}],"top_pages_by_backlinks": [{"url": "https://www.seopowersuite.com/","backlinks": 16724},{"url": "http://seopowersuite.com/","backlinks": 1932},{"url": "https://www.seopowersuite.com/buy.html","backlinks": 1188},{"url": "http://www.seopowersuite.com/","backlinks": 900},{"url": "https://www.seopowersuite.com/rank-tracker/","backlinks": 356}],
"top_pages_by_refdomains": [{"url": "https://www.seopowersuite.com/","refdomains": 1235},{"url": "http://www.seopowersuite.com/","refdomains": 236},{"url": "http://seopowersuite.com/","refdomains": 221},{"url": "https://www.seopowersuite.com/rank-tracker/","refdomains": 172},{"url": "https://www.seopowersuite.com/seo-spyglass/","refdomains": 88}],"top_tlds": [{"tld": "com","count": 1183},{"tld": "pw","count": 112},{"tld": "net","count": 96},{"tld": "org","count": 65},{"tld": "it","count": 63}],"top_countries": [{"country": "us","count": 1140},{"country": "co","count": 166},{"country": "sg","count": 124},{"country": "de","count": 87},{"country": "gb","count": 84}]}]}

2. get-metrics
This command returns key statistics for the target such as: number of backlinks to the target, number of referring domains, etc.
This command supports batching multiple targets into a single request. If you need to make a batch request and get metrics for a number of targets (100max), you can pass multiple targets as GET parameters (separated by '&') or use a POST request.

GET Request
To receive information about a single target
GET: https://api.seopowersuite.com/backlinks/v1.0/get-metrics?apikey=XXX&target=https://www.seopowersuite.com&mode=url&output=json

To receive information about multiple targets
GET: https://api.seopowersuite.com/backlinks/v1.0/get-metrics?apikey=XXX&target=https://www.seopowersuite.com&target=https://www.link-assistant.com&mode=url&output=json

POST Request
To receive information about multiple targets
POST: https://api.seopowersuite.com/backlinks/v1.0/get-metrics?apikey=XXX&output=json{"target": ["https://www.seopowersite.com/","https://www.link-assistant.com/"],"mode": "url"}Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-metrics
Parameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••outputstringnojsondomain (*.example.com/*) - analysis will be done for
all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done for
all URLs that belong to this host (subdomains will not
be included).
url (http://www.example.com/) - analysis will be done
for the particular URL only.

Output format••

json - get response in JSON format.
xml - get response in XML format.

hostdomain

json

json

xml

Response Parameters: get-metrics
Parameter

Data
Type

Description

ExampletargetstringAim of the request: root domain, host, or URL

seopowersuite.com

backlinks

int

Total number of live backlinks

10000

refdomains

int

Number of unique domains linking to a target

1000

ips

int

Number of unique IPs linking to a target

80

subnets

int

Number of unique subnets / C-blocks linking to a target

50

nofollow_backlinks int

Number of backlinks marked as nofollow with a rel="nofollow" attribute in the <a> tag or
robots meta tag

100

dofollow_backlinks int

Number of backlinks NOT marked as nofollow with a rel="nofollow" attribute in the <a> tag or
robots meta tag

900

gov_backlinks

intNumber of backlinks coming from .gov domains

1

edu_backlinks

intNumber of backlinks coming from .edu domains

0Sample Request: get-metrics
GET: https://api.seopowersuite.com/backlinks/v1.0/getmetrics?apikey=XXX&target=seopowersuite.com&mode=host&output=json

Sample Response: get-metrics{"metrics": [{"target": "seopowersuite.com","backlinks": 22402,"refdomains": 2325,"subnets": 1399,"ips": 1957,"nofollow_backlinks": 3717,"dofollow_backlinks": 18685,"edu_backlinks": 40,"gov_backlinks": 0}]}

3. get-inlink-rankThis command returns information about the InLink Rank (Page Authority) and Domain InLink Rank (Domain Authority) for a target URL.
This command supports batching multiple targets into a single request. If you need to make a batch request and get metrics for a number of targets (100max), you can pass multiple targets as GET parameters (separated by '&') or use a POST request.

GET Request
To receive information about a single target
GET: https://api.seopowersuite.com/backlinks/v1.0/get-inlinkrank?apikey=XXX&target=https://www.seopowersuite.com&output=json

POST Request
To receive information about multiple targets
POST: https://api.seopowersuite.com/backlinks/v1.0/get-inlink-rank?apikey=XXX&output=json{"target":["https://www.seopowersite.com/","https://www.link-assistant.com/rank-tracker/"]}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-inlink-rank
Parameter DataType

Mandatory Default Value (if not
speciﬁed in request)

Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host(subdomain), or URL-

seopowersuite.com

outputstringnojson

Output format

json

json

•
•

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-inlink-rank
Parameter

Data Type

Description

Exampleurl

string

URL of a page that belongs to speciﬁed in request target and mode.

https://www.seopowersuite.com/

inlink_rank

int

InLink Rank (Page Authority) of the target URL

21

domain_inlink_rank

intDomain InLink Rank (Domain Authority) of the target's root domain

68

Sample Request: get-inlink-rank
https://api.seopowersuite.com/backlinks/v1.0/get-inlinkrank?apikey=XXX&target=https://www.seopowersuite.com&output=json

Sample Response:{"pages": [{"url": "https://www.seopowersuite.com","inlink_rank": 40,"domain_inlink_rank": 68}]}

4. get-backlinks
This command returns information about the backlinks pointing to a target.
The command supports both GET and POST requests, but doesn’t allow making batch requests, and only takes a single target input parameter.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-backlinks?apikey=XXX&target=
seopowersuite.com&mode=domain&limit=100&order_by=inlink_rank&per_domain=1&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-backlinks?apikey=XXX&output=json{"target": "https://www.seopowersuite.com/","order_by": "date_found","mode": "domain","limit": 10,"per_domain": 1}Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-backlinks
Parameter

Data
Type

Mandatory Default Value (ifnot speciﬁed inrequest)Description

Acceptable values

Exampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host(subdomain), or URL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•domain (*.example.com/*) - analysis will bedone for all URLs that belong to this domain,
including its subdomains.

hostdomain

•

•
limit

host (www.example.com/*) - analysis will bedone for all URLs that belong to this host(subdomains will not be included).
url (http://www.example.com/) - analysis will
be done for the particular URL only.

int

no

100

Maximum number of results to return.

Should be within [1;10,000]10

per_domain int

no-Number of backlinks per referring domain to beprovided in the response.

[1; 100]

1

json

json

Passing an empty parameter will return all
backlinks (even if there are more than 100).
outputstringnojson

Output format••

order_bystringnodate_foundjson - get response in JSON format.
xml - get response in XML format.

xml

The ﬁeld by which the results will be sorted in the date_foundresponse:domain_inlink_rank• date_found - returns the most recent (new)inlink_rank
backlinks ﬁrst.
• domain_inlink_rank - returns backlinks withthe highest Domain InLink Rank ﬁrst.
• inlink_rank - returns backlinks with thehighest InLink Rank ﬁrst.

date_foundResponse Parameters: get-backlinks
Parameter

Data
Type

Description

Exampleurl_from

stringReferring page's URL

http://seo.jouwlinkhier.nl/

url_tostringDestination page's URL

https://www.seopowersuite.com/

title

stringReferring page's title

informatie over seo

anchorstring

Link anchor text for text links.

Rank Tracker

Image alt text for image links.
altstringDeprecated, not used""nofollow_backlinks

booleanIs set to true if the link has a rel="nofollow" attribute in the <a> tag or robots
meta tag

false

image

booleanIs set to true if the html <a> tag from which the link was extracted includes an
image

false

image_source

string

The source URL of the image (for image links)

https://podnova.com/img/sps.jpg

inlink_rank

int

InLink Rank (Page Authority) of the referring page's URL

21

domain_inlink_rank int

Domain InLink Rank (Domain Authority) of the referring page's root domain

68

ﬁrst_seendate

The date when the backlink was discovered and added to the index

2016-10-26

last_visiteddate

The date when our crawlers last visited the referring page

2019-01-08

Sample Request: get-backlinks
https://api.seopowersuite.com/backlinks/v1.0/getbacklinks?apikey=XXX&target=https://seopowersuite.com&mode=domain&limit=100&order_by=inlink_rank&per_domain=1&out
put=json

Sample Response: get-backlinks{"backlinks": [{"url_from": " https://zoekmachine-optimalisatie-seo.beginthier.nl/","url_to": " https://www.seopowersuite.com/","title": "Zoekmachine Optimalisatie (SEO)","anchor": "SEO software tools","alt": "","nofollow": false,"image": false,"image_source": "","inlink_rank": 67,"domain_inlink_rank": 77,"first_seen": "2021-11-05","last_visited": "2023-06-01"},{"url_from": " https://zoekmachine-optimalisatie.verzamelgids.nl/","url_to": " https://www.seopowersuite.com/","title": "Zoekmachine Optimalisatie (SEO)","anchor": "SEO software tools","alt": "","nofollow": false,"image": false,"image_source": "","inlink_rank": 66,"domain_inlink_rank": 75,"first_seen": "2021-11-12","last_visited": "2023-06-01"}]}

5. get-refdomains
This command returns information about the referring domains pointing to a target.
The command supports both GET and POST requests, but doesn’t allow making batch requests, and only takes a single target input parameter.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/getrefdomains?apikey=XXX&target=seopowersuite.com&mode=domain&limit=100&order_by=inlink_rank&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-refdomains?apikey=XXX&output=json{"target":"seopowersuite.com","mode":"domain","limit":2}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-refdomains
Parameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

Acceptable values

Exampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host(subdomain), or URL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•domain (*.example.com/*) - analysis will bedone for all URLs that belong to this domain,
including its subdomains.

hostdomain••order_bystringnodate_foundhost (www.example.com/*) - analysis will bedone for all URLs that belong to this host(subdomains will not be included).
url (http://www.example.com/) - analysis will
be done for the particular URL only.

The ﬁeld by which the results will be sorted in the
response:

date_founddate_found - returns most recent (new)referring domains/hosts ﬁrst.
domain_inlink_rank returns domains/hosts with the highest
Domain InLink Rank ﬁrst.
inlink_rank - returns domains/hosts with thehighest InLink Rank of its home page ﬁrst.

inlink_rank•••

date_founddomain_inlink_rank

limit

int

no

100

Maximum number of results to return.

Should be within [1;10,000]10

outputstringnojson

Output format

json

json

•
•

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-refdomains
Parameter

Data
Type

Description

Examplerefdomain

string

The name of the referring domainfrashmi.net

backlinks

int

Total number of backlinks pointing to the target from this domain

68

dofollow_backlinks

intNumber of backlinks from this domain that are NOT marked as nofollow with a rel="nofollow" attributein the <a> tag or robots meta tag

900

ﬁrst_seendate

The date when the oldest live backlink coming from this domain was found2016-10-26

Domain InLink Rank (Domain Authority) of the referring domain

68

domain_inlink_rank int

Sample Request: get-refdomains
GET: https://api.seopowersuite.com/backlinks/v1.0/getrefdomains?apikey=XXX&target=seopowersuite.com&mode=domain&limit=2&order_by=inlink_rank&output=json

Sample Response: get-refdomains{"refdomains": [{"refdomain": "daveyandkrista.com","backlinks": 1,"dofollow_backlinks": 1,"first_seen": "2022-06-30","domain_inlink_rank": 73},{"refdomain": "isearch.avg.com","backlinks": 72,"dofollow_backlinks": 72,"first_seen": "2019-02-22","domain_inlink_rank": 90}]}

6. get-anchors
This command returns information about the anchor texts of backlinks that point to a target.

The command supports both GET and POST requests, but doesn’t allow making batch requests, and only takes a single target input parameter.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/getanchors?apikey=XXX&target=https://seopowersuite.com&mode=domain&limit=2&order_by=backlinks&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-anchors?apikey=XXX&output=json{"target": "https://www.seopowersuite.com/","order_by": "backlinks","mode": "domain","limit": 2}Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-anchors
Parameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••order_bystringnobacklinks

domain (*.example.com/*) - analysis will be done
for all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done
for all URLs that belong to this host (subdomains
will not be included).
url (http://www.example.com/) - analysis will bedone for the particular URL only.

The ﬁeld by which the results will be descending sorted
by in the response:
•
•

host
domainbacklinks

backlinks

refdomains

backlinks - total number of backlinks that are using
an anchor text.
refdomains - total number of referring domains thatare using an anchor text.

limit

int

no

100

Maximum number of results to return.

Should bewithin [1;10,000]10

outputstringnojson

Output format

json

json

•
•

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-anchors
Parameter

Data
Type

Description

ExampleanchorstringText of an anchor. May be empty. Case sensitive.

SEO
PowerSuitebacklinks

int

A total number of backlinks that are using anchor text.

10000

Always greater than zero.
refdomains

int

Total number of referring domains that are using an anchor text. Always greater than zero.

50

nofollow_backlinks int

Number of backlinks marked as nofollow with a rel="nofollow" attribute in the <a> tag or robots
meta tag100

dofollow_backlinks int

Number of backlinks NOT marked as nofollow with a rel="nofollow" attribute in the <a> tag or
robots meta tag

900

ﬁrst_seendate

The date of the earliest backlink with the anchor pointing to the target in the index.

2016-10-26

last_visiteddate

The last date when the backlink with the anchor pointing to the target was seen.

2019-01-08

Sample Request: get-anchors
https://api.seopowersuite.com/backlinks/v1.0/getanchors?apikey=XXX&target=https://seopowersuite.com&mode=domain&limit=2&order_by=backlinks&output=json

Sample Response: get-anchors{"anchors": [{"anchor": "SEO PowerSuite","backlinks": 1844,"refdomains": 445,
"dofollow_backlinks": 1595,"nofollow_backlinks": 249,
"first_seen": "2016-12-07","last_visited": "2023-10-19"},{"anchor": "social listening","backlinks": 1542,"refdomains": 7,"dofollow_backlinks": 1542,"nofollow_backlinks": 0,"first_seen": "2020-04-30","last_visited": "2022-04-01"}]}

7. get-pages
This command returns information about site pages that belong to a target. Target parameter can take only a single parameter.
If at least one backlink references some page that belongs to target, then this page will be returned in response. If no more backlinks reference some
page that previously was referenced, then this page is excluded from returned list. Returned list does not contain duplicated pages. Difference inprotocols is taken into account - otherwise same pages are treated as non-duplicates.

The command supports both GET and POST requests, but doesn’t allow making batch requests, and only takes a single target input parameter.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/getpages?apikey=XXX&target=https://seopowersuite.com&mode=domain&limit=100&order_by=backlinks&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-pages?apikey=XXX&output=json{"target": "https://www.seopowersuite.com/","order_by": "backlinks","mode": "domain","limit": 2}Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-pages
Parameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••order_bystringnobacklinks

domain (*.example.com/*) - analysis will be done
for all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done
for all URLs that belong to this host (subdomains
will not be included).
url (http://www.example.com/) - analysis will bedone for the particular URL only.

The ﬁeld by which the results will be descending sorted
by in the response:
•
•

host
domainbacklinks

backlinks

refdomains

backlinks - total number of backlinks that are using
an anchor text.
refdomains - total number of referring domains thatare using an anchor text.

limit

int

no

100

Maximum number of results to return.

Should bewithin [1;10,000]10

outputstringnojson

Output format

json

json

•
•

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-pages
Parameter

Data
Type

Description

Exampleurl

string

URL of a page that belongs to speciﬁed in request target and mode.

http://linkassistant.com/landing1

backlinks

int

Total number of backlinks that point to the URL. Always greater than zero.

68

refdomains

int

Total number of referring domains that point to the URL. Always greater than zero.

25

nofollow_backlinks int

Number of backlinks marked as nofollow with a rel="nofollow" attribute in the <a>tag or robots meta tag.

100

dofollow_backlinks int

Number of backlinks NOT marked as nofollow with a rel="nofollow" attribute in the<a> tag or robots meta tag.

900

ﬁrst_seendate

The date of the earliest backlink pointing to the URL in the index.

2016-10-26

last_visiteddate

The date of the latest backlink pointing to the URL in the index.

2019-01-08

Sample Request: get-pages
https://api.seopowersuite.com/backlinks/v1.0/getpages?apikey=XXX&target=https://seopowersuite.com&mode=domain&limit=2&order_by=backlinks&output=json

Sample Response: get-pages{"pages": [{"url": "https://www.seopowersuite.com/","backlinks": 16696,"refdomains": 1227,"dofollow_backlinks": 14708,"nofollow_backlinks": 1978,"first_seen": "2017-01-03","last_visited": "2023-10-23"},{"url": "http://seopowersuite.com/","backlinks": 1926,"refdomains": 220,
"dofollow_backlinks": 1254,"nofollow_backlinks": 671,
"first_seen": "2017-09-15","last_visited": "2023-10-21"}]}

8. get-ips
This command returns information about IPv4 that belong to backlinks that point to a target. Information about IPv6 is not served.
The command supports both GET and POST requests, but doesn’t allow making batch requests, and only takes a single target input parameter.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/getips?apikey=XXX&target=https://seopowersuite.com&mode=domain&limit=100&order_by=backlinks&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-ips?apikey=XXX&output=json{"target": "https://www.seopowersuite.com/","order_by": "backlinks","mode": "domain","limit": 2}Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-ips
Parameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain••domain (*.example.com/*) - analysis will be done
for all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done
for all URLs that belong to this host (subdomains
will not be included).

hostdomain•order_bystringnobacklinks

url (http://www.example.com/) - analysis will bedone for the particular URL only.

The ﬁeld by which the results will be descending sorted
by in the response:••

backlinks

backlinks

refdomains

backlinks - total number of backlinks that are using
an anchor text.
refdomains - total number of referring domains thatare using an anchor text.

limit

int

no

100

Maximum number of results to return.

Should bewithin [1;10,000]10

outputstringnojson

Output format

json

json

•
•

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-ips
Parameter

Data
Type

Description

Exampleip

string

IPv4 address that serves at least one page that links to a target

123.23.25.42

backlinks

int

Total number of backlinks that point to the target and are served from the IP address. Always greaterthan zero.

68

refdomains

int

Total number of referring domains that point to the target and have at least one page served from theIP address. Always greater than zero.

25

nofollow_backlinks int

Number of backlinks marked as nofollow with a rel="nofollow" attribute in the <a> tag or robots meta
tag

100

dofollow_backlinks int

Number of backlinks NOT marked as nofollow with a rel="nofollow" attribute in the <a> tag or robots
meta tag

900

ﬁrst_seendate

The date of the earliest backlink that points to the target and is served from the IP address.

2016-10-26

last_visiteddate

The date of the latest backlink that points to the target and is served from the IP address.

2019-01-08

Sample Request: get-ips
https://api.seopowersuite.com/backlinks/v1.0/getips?apikey=XXX&target=https://seopowersuite.com&mode=domain&limit=2&order_by=backlinks&output=json

Sample Response: get-ips{"ips": [{"ip": "123.234.23.43","backlinks": 188,
"refdomains": 144,"first_seen": "2020-10-19","last_visited": "2022-03-15"},{"ip": "32.114.53.3","backlinks": 68,"refdomains": 60,"first_seen": "2019-04-24","last_visited": "2022-02-21"}]}

9. download-all-backlinks
This command allows for large-scale backlinks retrieval and returns information about all backlinks pointing to a target. Due to the high volume of data toprocess, this command will always work asynchronously with results being made available as a downloadable .GZ compressed CSV ﬁle.

Please note that this command supports GET requests only (POST is not supported for this command).

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/download-allbacklinks?apikey=XXX&target=https://seopowersuite.com&mode=domain&output=json

Request Parameters: download-all-backlinks
Parameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••outputstringnojsondomain (*.example.com/*) - analysis will be done for
all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done for
all URLs that belong to this host (subdomains will not
be included).
url (http://www.example.com/) - analysis will be done
for the particular URL only.

Output format
•
•

host
domain

json

json

xml

json - get response in JSON format.
xml - get response in XML format.

Response Parameters: download-all-backlinks
Parameter

Data
Type

Description

Exampletask_status

stringStatus of the CSV ﬁle preparation task. One ofqueued_for_processing

•
•
•
•

•

task_idstringdownload_ﬁle string

queued_for_processing - the task successfully started preparing therequested data.
processing - the task is running.
complete - the task successfully prepared the data, you can start
downloading the CSV ﬁle.
rejected - the task cannot be started due to the fact that the previous
task is being still processed by the system and hasn't been ﬁnishedyet. Please wait for the previous task to complete.
task id is unknown or deleted - the task with the requested ID is
unknown or you don't have access to it. You should only ask for the
status of those tasks which have been previously queued forprocessing.

The id of the CSV ﬁle preparation task

602c775d-760d-46ba-bfaf-005a6b37ac4e

The location of the CSV ﬁle with the requested data, ready for download

https://api.seopowersuite.com/export/c/seo
powersuite.com-1572280448369.csv.gz

Sample Flow
Step 1
Formulate the request for downloading a list of all backlinks for the target and put it into an execution queue:Sample Request: download-all-backlinks
https://api.seopowersuite.com/backlinks/v1.0/download-allbacklinks?apikey=XXX&target=http://seopowersuite.com&mode=domain&output=json

Sample Response: download-all-backlinks{"task_status": "queued_for_processing","task_id": "d1d2bb44-6c66-4791-a634-26103551e2da"}

Step 2Check if the data you've requested is ready. Use the task_id that was returned in Step 1.

Sample Request: download-all-backlinks-status
GET: https://api.seopowersuite.com/backlinks/v1.0/download-all-backlinks-status?apikey=XXX&task_id=d1d2bb44-6c664791-a634-26103551e2da&output=json

Sample Response: download-all-backlinks-status{"task_status": "complete","task_id": "d1d2bb44-6c66-4791-a634-26103551e2da","download_file": "http://116.202.112.205/export/b/seopowersuite.com-1695672292259.csv.gz"}

Step 3
Fetch your CSV ﬁle with the data requested by simply accessing it at the location returned in the download_ﬁle parameter:
GET: https://api.seopowersuite.com/export/c/seopowersuite.com-1572280448369.csv.gz

10. get-raw-backlinks
This command returns information about all backlinks pointing to a target in batches using a cursor-based pagination approach. This method supports
pagination but doesn't offer any ordering or ﬁltering possibilities.

Unlike the get-backlinks method (which supports sorting/ordering and is most commonly used to quickly get top backlinks by InLink Rank or to get mostrecent backlinks), this method is aimed to fetch backlinks in batches - one batch after another. It uses an approach called "cursor-based pagination",
which is the most efficient method of paging. A cursor refers to a random string of characters which marks a speciﬁc item in a list of data. Unless thisitem is deleted, the cursor always points to the same part of the list but is invalidated if an item is removed. Therefore, you may assume that they will bevalid within the next 24 hours, even if new items are added to the list in-between requests.
This cursor-paginated method supports the next parameter which is being used as a cursor that will return the next page of data.
Note: The next parameter must not be included in the request when asking for the ﬁrst page of data (you'll get an error if it is). If the next parameter is notincluded in the response, this is the last page of data. Stop paging when the next cursor no longer appears.

Please note that this command supports GET requests only (POST is not supported for this command).

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-rawbacklinks?apiKey=XXX&target=seopowersuite.com&mode=domain&limit=50000&output=json&next=YYY

Request Parameters: get-raw-backlinks
Parameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:•••

domain (*.example.com/*) - analysis will be done for
all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done
for all URLs that belong to this host (subdomains
will not be included).
url (http://www.example.com/) - analysis will bedone for the particular URL only.

urldomainhostdomain

limit

int

no

10,000Maximum number of results to return on one page.

Should bewithin [1;100,000]

10

next

stringno-

The cursor that points to the end of the page of data thathas been returned.

-

uaputGo_eWXvS
EWZCpBxgAW- Must NOT be present among the request parameters if
the request to get backlinks to a new target is being
made for the ﬁrst time.
- Will NOT be returned in response for the last page ofdata (if no more backlinks to the target exist).
outputstringnojson

Output format••

json - get response in JSON format.
xml - get response in XML format.

json

json

xml

Response Parameters: get-raw-backlinks
Parameter

Data
Type

Description

Exampleurl_from

stringReferring page's URL

http://seo.jouwlinkhier.nl/

url_tostringDestination page's URL

https:// seopowersuite.com/ranktracker/

title

stringReferring page's title

informatie over seo

anchorstring

Link anchor text for text links.

Rank Tracker

Image alt text for image links.
altstringnot used""

nofollow_backlinks

booleanIs set to true if the link has a rel="nofollow" attribute in the <a> tag or robots
meta tag

false

image

booleanIs set to true if the html <a> tag from which the link was extracted includes an
image

false

image_source

string

The source URL of the image (for image links)

https:// podnova.com/img/sps.jpg

inlink_rank

int

InLink Rank (Page Authority) of the referring page's URL

21

domain_inlink_rank int

Domain InLink Rank (Domain Authority) of the referring page's root domain

68

ﬁrst_seendate

The date when the backlink was discovered and added to the index

2016-10-26

last_visiteddate

The date when our crawlers last visited the referring page

2019-01-08

next

string

The cursor that points to the end of the page of data that has been returned.

a8RMaGJNHWemdJkYq

Must NOT be present among the request parameters if the request to getbacklinks to a new target is being made for the ﬁrst time.
Will NOT be returned in response for the last page of data (if no more backlinks
to the target exist).

Sample Flow
Step 1
Send a request to get the very ﬁrst page of data for the target (the example below will return the ﬁrst 1,000 backlinks to the domain seopowersuite.com):

Sample Request: get-raw-backlinks
GET: https://api.seopowersuite.com/backlinks/v1.0/get-rawbacklinks?apiKey=XXX&target=seopowersuite.com&mode=domain&limit=2&output=json

Important: do NOT send the next parameter when making a request for the ﬁrst batch of data - if you do, an error will be returned.

Sample Response: get-raw-backlinks{"backlinks": [{"url_from": "https://www.pbmug.org/seo-spyglass-pro-6-40-8-download-latest-qaissaeed-com.html","url_to": "https://seopowersuite.com/seo-spyglass.html","title": "Seo Spyglass Pro - Download ","anchor": "","alt": "","nofollow": false,"image": false,"image_source": "","inlink_rank": 16,"domain_inlink_rank": 45,"first_seen": "2021-05-06","last_visited": "2021-05-06"},{"url_from": "https://www.pbmug.org/seo-spyglass-pro-6-40-8.html","url_to": "https:// seopowersuite.com/themes/standard/images/index-scr-3-big.png","title": "Seo Spyglass Pro 6 40 8 With Crack Download Latest Qaissaeed Com - Pbmug.org","anchor": "","alt": "","nofollow": false,"image": false,"image_source": "","inlink_rank": 15,"domain_inlink_rank": 45,"first_seen": "2021-05-06","last_visited": "2021-05-06"}],"next": "ezDLWp6Peqx6tE77/mV9XtWGP92lrdwTI3ZZ2b24ZPMXA/NpRCJm45biWgPerwN_0uqT9iHmZTYjeS2VRiNL7ySiFgV0KFGv9O9Y="}

Step 2
Get the next page of data. Use the next parameter that was returned in Step 1.

Sample Request: get-raw-backlinks
GET: https://api.seopowersuite.com/backlinks/v1.0/get-rawbacklinks?apiKey=XXX&target=seopowersuite.com&mode=domain&limit=2&output=json&next=ezDLWp6Peqx6tE77/mV9XtWGP92lrd
wTI3ZZ2b24ZPMXA/NpRCJm45biWgPerwN_0uqT9iHmZTYjeS2VRiNL7ySiFgV0KFGv9O9Y=

Sample Response: get-raw-backlinks{"backlinks": [{"url_from": "https://fity.club/lists/1/seo-software-tools-for-resultsdriven-site-owners/","url_to": "https://cdn.seopowersuite.com/themes/standard/images/works-on.png","title": "Seo Software Tools For Resultsdriven Site Owners","anchor": "seopowersuite.com","alt": "","nofollow": true,"image": false,"image_source": "","inlink_rank": 9,"domain_inlink_rank": 13,"first_seen": "2023-08-07","last_visited": "2023-08-07"},{

"url_from": "https://www.bjskqx.com/11043.html","url_to": "https://cn.seopowersuite.com/link-assistant.html","title": "seo外链发布有用吗，seo外链发布平台有哪些-帮发锚文本外链网","anchor": "Link Assistant","alt": "","nofollow": false,"image": false,"image_source": "","inlink_rank": 15,"domain_inlink_rank": 38,"first_seen": "2023-07-08","last_visited": "2023-07-08"}],"next": "sPpKCdfMEKN5zO3RsuyEZIMp7wHaJF5wuT/1tebFkazXfosEFuotIQYeHxV/beypHQ3a9DHFgCkNnh_f0cP9EoHBtcyYFuGA=="}

Step 3Iterate until no next parameter is returned – it means this is the last page of data.

11. get-new-lost-backlinks
This command returns a list of backlinks (newly) found or lost within the speciﬁed date range for the speciﬁed target.
The command supports both GET and POST requests, but doesn’t allow making batch requests, and only takes a single target input parameter.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-new-lostbacklinks?apikey=XXX&target=https://www.seopowersuite.com&mode=domain&new_lost_type=new&date_from=2019-0114&date_to=2019-08-28&link_type=href&anchor_type=text&dofollow=dofollow&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-new-lost-backlinks?apikey=XXX&output=json{"target": "https://www.seopowersite.com","mode": "domain","date_from": "2023-01-15","date_to": "2023-01-15"}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-new-lost-backlinks
Parameter

Data
Type

Mandatory Default Value (ifnot speciﬁed inrequest)Description

Acceptable values

Exampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host(subdomain), or URL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••domain (*.example.com/*) - analysis will bedone for all URLs that belong to this domain,
including its subdomains.
host (www.example.com/*) - analysis will bedone for all URLs that belong to this host(subdomains will not be included).
url (http://www.example.com/) - analysis
will be done for the particular URL only.

host
domainnew_lost_type stringno""

Indicates whether the backlink is new or lost:new

new - returns fresh backlinks that were
tagged as new.
lost - returns backlinks that were tagged as
lost.

lost

•
•

new

""

Passing an empty parameter will return both
new and lost backlinks.
date_from

date

no

yesterday

Start date in "YYYY-MM-DD" format (inclusive
range).

Date value in "YYYYMM-DD" format

2019-03-01

date_todatenocurrent day(today)End date in "YYYY-MM-DD" format (inclusive
range).

Date value in "YYYYMM-DD" format

2019-04-01

link_typestringno""Type of the backlink. One of

href

href

•
•

href
redirect

redirect""

Passing an empty parameter will return all typesof backlinks.
anchor_type

stringno""

Identiﬁes whether the backlink is a text or image
link. One of:
•
•
•
•

text
image
undeﬁned
""

new

text

lost
""

Note: If anchor text consists of both text and an
image, the backlink's anchor type will be set to"image".
Passing an empty parameter will returnbacklinks with any anchor type.
dofollow

stringno""

Identiﬁes whether the backlink is dofollow or
nofollow. One of•••dofollow
nofollow
undeﬁned

dofollow

dofollow

nofollow
undeﬁned""

Passing an empty parameter will return all typesof backlinks.
url_from

stringno""

Allows to get a list of backlinks with Referring
Page URLs that belong to this domain, including
its subdomains.

-

text

Passing an empty parameter will returnbacklinks from all domains/subdomains.
Example: http://seo.jouwlinkhier.nl/path will
return backlinks pointing from*seo.jouwlinkhier.nl/*
limit

int

no

100

Maximum number of results to return.

Should be within [1;10,000]10order_bystringnonew_lost_date

The ﬁeld by which the results will be sorted in
the response:

new_lost_date

new_lost_date•••
outputstringnojson

new_lost_date - returns new/lost backlinks
in order of being found or lost (starting fromthe most recent ones).
domain_inlink_rank - returns backlinks withthe highest Domain InLink Rank ﬁrst.
inlink_rank - returns backlinks with thehighest InLink Rank ﬁrst.

Output format•

json - get response in JSON format.

domain_inlink_rank
inlink_rank

json
xml

json

•

xml - get response in XML format.

Response Parameters: get-new-lost-backlinks
Parameter

Data
Type

Description

Examplenew_lost_datedate

The date when the link was found or lost

2022-10-26

new_lost_type

stringIndicates whether the backlink is new or lost:new

new - returns fresh backlinks that were tagged as newlost - returns backlinks that were tagged as lost
url_from

stringReferring page's URL

http://seo.jouwlinkhier.nl/

url_tostringDestination page's URL

https:// seopowersuite.com/ranktracker/

title

stringReferring page's title

informatie over seo

anchorstring

Link anchor text for text links.

Rank Tracker

Image alt text for image links.
altstringDeprecated. Not used.

""

link_typestringType of backlink.

href

•
•

href - the link was parsed from the href attribute within the page.
redirect - a link derived from a redirect HTTP header.

nofollow_backlinks

booleanIs set to true if the link has a rel="nofollow" attribute in the <a> tag or robots
meta tag

false

image

booleanIs set to true if the html <a> tag from which the link was extracted includes
an image

false

image_source

string

The source URL of the image (for image links)

https://podnova.com/img/sps.jpg

reason-loststring

The reason why the backlink's status was changed from live to lost. One of:page_not_found

•
•
•
•
•
•
•
•
•
inlink_rank

int

page_not_found - the referring page returned a 404 status code during
the re-crawl.
crawl_error - a fetching error occurred during the re-crawl of the referring
page (this is different from a 404 code).
page_dropped - the referring page was removed (dropped) from our index
for some reason (e.g., we consider it untrustworthy and/or poorly rated).
redirect - the referring page returned a 3XX status code during the recrawl.
not_canonical - the canonical link on the referring page now sends the
crawler to another page.
noindex - the referring page has included a noindex meta tag in its HTMLcode or returned a noindex HTTP response header.
link_removed - the crawler didn’t ﬁnd the backlink on the referring page;or the redirect which we considered to be a backlink no longer exists.
broken_redirect - the crawler failed to identify the type of redirect.
other - any other reason not covered by the cases above (e.g., noncategorized internal errors).

InLink Rank (Page Authority) of the referring page's URL

21

domain_inlink_rank int

Domain InLink Rank (Domain Authority) of the referring page's root domain

68

ﬁrst_seen

The date when the backlink was discovered and added to the index

2016-10-26

date

Sample Request: get-new-lost-backlinks
GET: https://api.seopowersuite.com/backlinks/v1.0/get-new-lostbacklinks?apikey=XXX&target=https://www.seopowersuite.com&mode=domain&new_lost_type=new&date_from=2023-0115&date_to=2023-01-15&link_type=href&anchor_type=text&dofollow=dofollow&output=json

Sample Response: get-new-lost-backlinks{"new_lost_backlinks": [{"new_lost_date": "2023-01-15","new_lost_type": "new","url_from": "https://agenciatgx.com.br/blog/melhores-ferramentas-de-seo-para-otimizar/","url_to": "http://www.seopowersuite.com/","title": "Melhores Ferramentas de SEO Para Otimizar o Desempenho do Seu Site - Agência TGX","anchor": "SEO Power Suite","alt": null,"link_type": "href","nofollow": false,"image": false,"image_source": null,"redirect_chain": false,"redirect_chain_urls": [],"reason_lost": null,"inlink_rank": 1,"domain_inlink_rank": 18,"first_seen": "2023-01-15"},{"new_lost_date": "2023-01-15","new_lost_type": "lost","url_from": "http://technicalproducts.org/category/seoandperformance","url_to": "https://www.seopowersuite.com/","title": "SEO & Performance – Technical Products","anchor": "SEO PowerSuite","alt": null,"link_type": "href","nofollow": false,"image": false,"image_source": null,"redirect_chain": false,"redirect_chain_urls": [],"reason_lost": "link_removed","inlink_rank": 1,"domain_inlink_rank": 1,"first_seen": "2023-01-15"}]}

12. get-new-lost-refdomains
This command returns a list of referring domains, at least one backlink from which was (newly) found or lost in the speciﬁed date range for the speciﬁedtarget.
The command supports both GET and POST requests, but doesn’t allow making batch requests, and only takes a single target input parameter.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-new-lostrefdomains?apikey=XXX&target=https://www.seopowersuite.com&mode=domain&new_lost_type=new&date_from=2023-0115&date_to=2023-01-16&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-new-lost-refdomains?apikey=XXX&output=json{"target": "https://www.seopowersite.com","mode": "domain","new_lost_type": "new","date_from": "2023-01-15","date_to": "2023-01-16"}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-new-lost-refdomains
Parameter

Data
Type

Mandatory Default Value (ifnot speciﬁed inrequest)Description

Acceptable values

Exampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host(subdomain), or URL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••new_lost_type stringno""domain (*.example.com/*) - analysis will
be done for all URLs that belong to thisdomain, including its subdomains.
host (www.example.com/*) - analysis
will be done for all URLs that belong tothis host (subdomains will not be
included).
url (http://www.example.com/) analysis will be done for the particular
URL only.

Indicates whether the refdomain is new or
lost:
•

•

new - returns referring domains, at least
one backlink from which was newly
found.
lost - returns referring domains, at least
one backlink from which was tagged as
lost.

host
domain

new

new

lost
""

Passing an empty parameter will return both
new and lost refdomains.
date_from

date

no

yesterday

Start date in "YYYY-MM-DD"
format (inclusive range).

Date value in "YYYYMM-DD" format

2019-03-01

date_todatenocurrent day(today)End date in "YYYY-MM-DD" format (inclusive
range).

Date value in "YYYYMM-DD" format

2019-04-01

order_bystringnonew_lost_date

The ﬁeld by which the results will be sorted
in the response:

new_lost_date

new_lost_date

•

•

•

new_lost_date - returns new/lost
refdomains in order of being found or
lost (starting from the most recentones).
domain_inlink_rank - returns backlinks
with the highest Domain InLink Rank
ﬁrst.
inlink_rank - returns backlinks with thehighest InLink Rank ﬁrst.

domain_inlink_rank
inlink_rank

limit

int

no

100

Maximum number of results to return.

Should be within[1;10,000]10

outputstringnojson

Output format

json

json

•
•

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-new-lost-refdomains
Parameter

Data
Type

Description

Examplenew_lost_datedate

The date when the oldest live backlink coming from this domain was found or the last backlink fromthis domain was lost.

2022-10-26

new_lost_type

stringIndicates whether the refdomain is new or lost:
•
•

new

new - returns referring domains, at least one backlink from which was newly found.
lost - returns referring domains, at least one backlink from which was tagged as lost.

refdomain

string

The name of the referring domainfrashmi.net

backlinks

int

Total number of backlinks pointing to the target from this domain

68

dofollow_backlinks

intNumber of backlinks from this domain that are NOT marked as nofollow with a rel="nofollow" attributein the <a> tag or robots meta tag

900

ﬁrst_seendate

The date when the oldest live backlink coming from this domain was found2016-10-26

Domain InLink Rank (Domain Authority) of the referring domain

68

domain_inlink_rank int

Sample Request: get-new-lost-refdomains
GET: https://api.seopowersuite.com/backlinks/v1.0/get-new-lostrefdomains?apikey=XXX&target=https://www.seopowersuite.com&mode=domain&new_lost_type=new&date_from=2023-0115&date_to=2023-01-16&output=json

Sample Response: get-new-lost-refdomains{"new_lost_refdomains": [{"new_lost_date": "2023-01-16","new_lost_type": "new","refdomain": "agenzia-seo.it","backlinks": 1,"dofollow_backlinks": 1,"first_seen": "2023-01-16","domain_inlink_rank": 32},{"new_lost_date": "2023-01-15","new_lost_type": "lost","refdomain": "doso.com.au","backlinks": 1,"dofollow_backlinks": 1,"first_seen": "2023-01-15","domain_inlink_rank": 25}]}

13. get-new-lost-backlinks-countThis command returns a number of (newly) found or lost backlinks for every day within the speciﬁed date range for the speciﬁed target.
The command supports both GET and POST requests, but doesn’t allow making batch requests, and only takes a single target input parameter.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-new-lost-backlinkscount?apikey=XXX&target=https://www.seopowersuite.com&mode=domain&new_lost_type=new&date_from=2019-0114&date_to=2019-01-16&link_type=href&anchor_type=text&dofollow=dofollow&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-new-lost-backlinks-count?apikey=XXX&output=json{"target": "https://www.seopowersuite.com","mode": "domain","date_from": "2023-01-15","date_to": "2023-01-15"}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-new-lost-backlinks-countParameter

Data
Type

Mandatory Default Value(if not
speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••new_lost_type stringno""domain (*.example.com/*) - analysis will be done
for all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done
for all URLs that belong to this host (subdomains
will not be included).
url (http://www.example.com/) - analysis will bedone for the particular URL only.

host
domainIndicates whether the count for new or lost backlinks
should be returned:

new

new - returns the number of fresh backlinks thatwere tagged as new.
lost - returns the number of backlinks that were
tagged as lost.

""

•
•

new

lost

Passing an empty parameter will return the number ofboth new and lost backlinks.
date_from

date

no

yesterday

Start date in "YYYY-MM-DD" format (inclusive range).

Date format"YYYY-MMDD" format

2019-03-01

date_todatenocurrent day(today)End date in "YYYY-MM-DD" format (inclusive range).

Date format"YYYY-MMDD" format

2019-04-01

link_typestringno""Type of backlinks to be counted. One of:

href

href

•
•

href
redirect

redirect""

Passing an empty parameter will count backlinks of all
types.
anchor_type

stringno""

Identiﬁes whether text or image backlinks must be
counted. One of:
•
•
•
•

text
image
undeﬁned
""

text

text

image
""

Note: if anchor text consists of both text and an image,the backlink's anchor type will be set to "image".
Passing an empty parameter will count backlinks withany anchor type.
dofollow

stringno""

Identiﬁes whether dofollow, nofollow, or undeﬁned
backlinks must be counted. One of•••dofollow
nofollow
undeﬁned

Passing an empty parameter will count all types ofbacklinks.

dofollow
nofollow
undeﬁned""

dofollowurl_fromstringno""

Allows to get a number of backlinks with Referring Page
URLs that belong to this domain, including its
subdomains.

-

text

json

json

Passing an empty parameter will return the number ofbacklinks from all domains/subdomains.
Example: http://seo.jouwlinkhier.nl/path will return thenumber of backlinks pointing from*seo.jouwlinkhier.nl/*
outputstringnojson

Output format••

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-new-lost-backlinks-countParameter

Data Type

Description

Example

date

date

The particular date for which new or lost backlinks have been counted.

2022-10-26

new

int

Number of new backlinks that were found at that date and match the ﬁlters speciﬁed in the request parameters

25

lost

int

Number of backlinks that were lost at that date and match the ﬁlters speciﬁed in the request parameters25

Sample Request: get-new-lost-backlinks-count
GET: https://api.seopowersuite.com/backlinks/v1.0/get-new-lost-backlinkscount?apikey=XXX&target=https://www.seopowersuite.com&mode=domain&new_lost_type=new&date_from=2019-0114&date_to=2019-01-16&link_type=href&anchor_type=text&dofollow=dofollow&output=json

Sample Response: get-new-lost-backlinks-count{"new_lost_backlinks_count": [{"date": "2023-01-16","new": 5,"lost": 0},{"date": "2023-01-15","new": 5,"lost": 0}]}

14. get-new-lost-refdomains-countThis command returns the number of referring domains, at least one backlink from which was newly found or lost in the speciﬁed date range for the
speciﬁed target. The data is broken down by day.
The command supports both GET and POST requests, but doesn’t allow making batch requests, and only takes a single target input parameter.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-new-lost-refdomainscount?apikey=XXX&target=https://www.seopowersuite.com&mode=domain&new_lost_type=new&date_from=2023-0115&date_to=2023-01-16&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-new-lost-refdomains-count?apikey=XXX&output=json{"target": "https://www.seopowersuite.com","mode": "domain","new_lost_type": "new","date_from": "2023-01-15",

"date_to": "2023-01-16"}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-new-lost-refdomains-countParameter

Data
Type

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain),or URL-seopowersuite.com

mode

stringnohostMode of operation:urldomain•••new_lost_type stringno""domain (*.example.com/*) - analysis will bedone for all URLs that belong to this domain,
including its subdomains.
host (www.example.com/*) - analysis will bedone for all URLs that belong to this host(subdomains will not be included).
url (http://www.example.com/) - analysis will
be done for the particular URL only.

Indicates whether the count of new or lost
refdomain should be returned:••

new - returns the count of referring domains, atleast one backlink from which was newly
found.
lost - returns the count of referring domains, atleast one backlink from which was tagged as
lost.

host
domain

new

new

lost
""

Passing an empty parameter will return the countof both new and lost refdomains.
date_from

date

no

yesterday

Start date in "YYYY-MM-DD" format (inclusive
range).

Date value in“YYYY-MM-DD"
format2019-03-01

date_todatenocurrent day(today)End date in "YYYY-MM-DD" format (inclusive
range).

Date value in"YYYY-MM-DD"
format2019-04-01

outputstringnojson

Output format

json

json

•
•

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-new-lost-refdomains-countParameter DataType

Description

Example

date

date

The particular date for which new or lost refdomains have been counted.

2022-1026

new

int

Number of new referring domains that were found at that date and match the ﬁlters speciﬁed in the request
parameters

25

lost

int

Number of referring domains that were lost at that date and match the ﬁlters speciﬁed in the request parameters

25

Sample Request: get-new-lost-refdomains-count
GET: https://api.seopowersuite.com/backlinks/v1.0/get-new-lost-refdomainscount?apikey=XXX&target=https://www.seopowersuite.com&mode=domain&new_lost_type=new&date_from=2023-0115&date_to=2023-01-16&output=json

Sample Response: get-new-lost-refdomains-count{"new_lost_refdomains_count": [{"date": "2023-01-16","new": 4,"lost": 0},{"date": "2023-01-15","new": 3,"lost": 0}]}15. get-backlinks-countThis command returns the number of backlinks for the target.
This command supports batching multiple targets into a single request. If you need to make a batch request and get metrics for a number of targets (100max), you can pass multiple targets as GET parameters (separated by '&'), or use a POST request.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-backlinkscount?apikey=XXX&target=https://www.seopowersuite.com&target=https://www.link-assistant.com&mode=url&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-backlinks-count?apikey=XXX&output=json{"target": ["https://www.seopowersite.com/","https://www.link-assistant.com/"],"mode": "host"}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-backlinks-countParameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain••domain (*.example.com/*) - analysis will be done for
all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done for
all URLs that belong to this host (subdomains will not
be included).

hostdomain•
outputstringnojsonurl (http://www.example.com/) - analysis will be done
for the particular URL only.

Output format••

json - get response in JSON format.
xml - get response in XML format.

json

json

xml

Response Parameters: get-backlinks-countParameter

Data Type

Description

ExampletargetstringAim of the request: root domain, host, or URL

seopowersuite.com

backlinks

int

Total number of live backlinks

10000

Sample Request: get-backlinks-count
GET: https://api.seopowersuite.com/backlinks/v1.0/get-backlinks-count?apikey=a9c5a917-d645-470a-96b08f2436ed2078&target=seopowersuite.com&target=link-assistant.commode=host&output=json

Sample Response: get-backlinks-count{"metrics": [{"target": "seopowersuite.com","backlinks": 22402},{"target": "link-assistant.com","backlinks": 341415}]}

16. get-refdomains-countThis command returns the number of unique domains linking to a target.
This command supports batching multiple targets into a single request. If you need to make a batch request and get metrics for a number of targets (100max), you can pass multiple targets as GET parameters (separated by '&'), or use a POST request.

GET Request
To receive information about a single target
GET: https://api.seopowersuite.com/backlinks/v1.0/get-refdomainscount?apikey=XXX&target=https://www.seopowersuite.com&target=https://www.link-assistant.com&mode=url&output=json

POST Request
To receive information about multiple targets
POST: https://api.seopowersuite.com/backlinks/v1.0/get-refdomainss-count?apikey=XXX&output=json{"target": ["https://www.seopowersuite.com/","https://www.link-assistant.com/"],"mode": "domain"}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-refdomains-countParameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••outputstringnojsondomain (*.example.com/*) - analysis will be done for
all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done for
all URLs that belong to this host (subdomains will not
be included).
url (http://www.example.com/) - analysis will be done
for the particular URL only.

Output format••

json - get response in JSON format.
xml - get response in XML format.

hostdomain

json

json

xml

Response Parameters: get-refdomains-countParameter

Data Type

Description

ExampletargetstringAim of the request: root domain, host, or URL

seopowersuite.com

refdomains

int

Number of unique domains linking to a target

1000

Sample Request: get-refdomains-count
GET: https://api.seopowersuite.com/backlinks/v1.0/get-refdomainscount?apikey=XXX&target=seopowersuite.com&target=link-assistant.com&mode=domain&output=json

Sample Response: get-refdomains-count{"metrics": [{"target": "seopowersuite.com","refdomains": 2329},{
"target": "link-assistant.com","refdomains": 19474}]}

17. get-subnets-countThis command returns the number of unique subnets / C-blocks linking to a target.
This command supports batching multiple targets into a single request. If you need to make a batch request and get metrics for a number of targets (100max), you can pass multiple targets as GET parameters (separated by '&'), or use a POST request.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-subnetscount?apikey=XXX&target=https://www.seopowersuite.com&target=https://www.link-assistant.com&mode=url&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-subnets-count?apikey=XXX&output=json{"target": ["https://www.seopowersite.com/","https://www.link-assistant.com/"],"mode": "host"}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST).
POST data that comes in the request body should be in JSON format.

Request Parameters: get-subnets-countParameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••outputstringnojsondomain (*.example.com/*) - analysis will be done for
all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done for
all URLs that belong to this host (subdomains will not
be included).
url (http://www.example.com/) - analysis will be done
for the particular URL only.

Output format••

json - get response in JSON format.
xml - get response in XML format.

hostdomain

json

json

xml

Response Parameters: get-subnets-countParameter

Data Type

Description

ExampletargetstringAim of the request: root domain, host, or URL

seopowersuite.com

subnets

int

Number of unique subnets / C-blocks linking to a target

50

Sample Request: get-subnets-count
GET: https://api.seopowersuite.com/backlinks/v1.0/get-subnetscount?apikey=XXX&target=seopowersuite.com&target=link-assistant.com&mode=host&output=json

Sample Response: get-subnets-count{"metrics": [{"target": "seopowersuite.com","subnets": 1399},{
"target": "link-assistant.com","subnets": 7690}]}

18. get-ips-countThis command returns the number of unique IPs linking to a target.
This command supports batching multiple targets into a single request. If you need to make a batch request and get metrics for a number of targets (100max), you can pass multiple targets as GET parameters (separated by '&'), or use a POST request.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-ipscount?apikey=XXX&target=https://www.seopowersuite.com&target=https://www.link-assistant.com&mode=url&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-ips-count?apikey=XXX&output=json{"target": ["https://www.seopowersite.com/","https://www.link-assistant.com/"],"mode": "host"}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-ips-countParameter DataType

Mandatory Default Value (ifnot speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host (subdomain), orURL-

seopowersuite.com

mode

stringnohostMode of operation:urldomain•••outputstringnojsondomain (*.example.com/*) - analysis will be done for
all URLs that belong to this domain, including its
subdomains.
host (www.example.com/*) - analysis will be done for
all URLs that belong to this host (subdomains will not
be included).
url (http://www.example.com/) - analysis will be done
for the particular URL only.

Output format••

json - get response in JSON format.
xml - get response in XML format.

hostdomain

json

json

xml

Response Parameters: get-ips-countParameter

Data Type

Description

ExampletargetstringAim of the request: root domain, host, or URL

seopowersuite.com

ips

int

Number of unique IPs linking to a target

80

Sample Request: get-ips-count
GET: https://api.seopowersuite.com/backlinks/v1.0/get-ipscount?apikey=XXX&target=https://seopowersuite.com&target=https://www.link-assistant.com&mode=url&output=json

Sample Response: get-ips-count{"metrics": [{"target": "https://seopowersuite.com","ips": 75},{"target": "https://www.link-assistant.com","ips": 2493}]}

19. get-page-inlink-rankThis command returns information about the InLink Rank for a target URL.
This command supports batching multiple targets into a single request. If you need to make a batch request and get metrics for a number of targets (100max), you can pass multiple targets as GET parameters (separated by '&'), or use a POST request.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-page-inlinkrank?apikey=XXX&target=https://seopowersuite.com&target=https://www.link-assistant.com&mode=url&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-page-inlink-rank?apikey=XXX&output=json{"target": ["https://www.seopowersuite.com/","https://www.link-assistant.com/rank-tracker/"]}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-page-inlink-rank
Parameter DataType

Mandatory Default Value (if not
speciﬁed in request)

Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host(subdomain), or URL-

seopowersuite.com

outputstringnojson

Output format

json

json

•
•

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-page-inlink-rank
Parameter

Data Type

Description

Exampleurl

string

URL of a page that belongs to speciﬁed in request target and mode.

seopowersuite.com

inlink_rank

int

InLink Rank (Page Authority) of the target URL

21

Sample Request: get-page-inlink-rank
GET: https://api.seopowersuite.com/backlinks/v1.0/get-page-inlinkrank?apikey=XXX&target=https://seopowersuite.com&target=https://www.link-assistant.com&mode=url&output=json

Sample Response: get-page-inlink-rank{"pages": [{"url": "https://seopowersuite.com","inlink_rank": 19},{"url": "https://www.link-assistant.com","inlink_rank": 49}]}

20. get-domain-inlink-rankThis command returns information about the domain InLink Rank (Domain Authority) of the target page's root domain
This command supports batching multiple targets into a single request. If you need to make a batch request and get metrics for a number of targets (100max), you can pass multiple targets as GET parameters (separated by '&'), or use a POST request.

GET Request
GET: https://api.seopowersuite.com/backlinks/v1.0/get-domain-inlinkrank?apikey=XXX&target=https://seopowersuite.com&target=https://www.link-assistant.com&output=json

POST Request
POST: https://api.seopowersuite.com/backlinks/v1.0/get-domain-inlink-rank?apikey=XXX&output=json{"target": ["https://seopowersuite.com/","https://www.link-assistant.com/rank-tracker/"]}

Please note that the apikey (mandatory) and output (optional) parameters must always come as GET parameters (even if the rest of the parameters comethrough POST). POST data that comes in the request body should be in JSON format.

Request Parameters: get-domain-inlink-rank
Parameter DataType

Mandatory Default Value (if not
speciﬁed in request)

Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

targetstringyes-

Aim of the request: root domain, host(subdomain), or URL-

seopowersuite.com

outputstringnojson

Output format

json

json

•
•

json - get response in JSON format.
xml - get response in XML format.

xml

Response Parameters: get-domain-inlink-rank
Parameter

Data Type

Description

Exampleurl

string

URL of a page that belongs to speciﬁed in request target and mode.

seopowersuite.com

domain_inlink_rank

intDomain InLink Rank (Domain Authority) of the target's root domain

68Sample Request: get-domain-inlink-rank
GET: https://api.seopowersuite.com/backlinks/v1.0/get-domain-inlinkrank?apikey=XXX&target=https://seopowersuite.com&target=https://www.link-assistant.com&output=json

Sample Response: get-domain-inlink-rank{"pages": [{"url": "https://seopowersuite.com","domain_inlink_rank": 68},{"url": "https://www.link-assistant.com","domain_inlink_rank": 87}]}

21. get-subscription-infoThis command returns information on existing subscriptions with the current API balance for a given API key.
Please note that this command supports GET requests only (POST is not supported for this command).

GET Request
To receive information about the subscription
GET: https://api.seopowersuite.com/backlinks/v1.0/get-subscription-info?apikey=XXX&output=json

Request Parameters: get-subscription-infoParameter DataType

Mandatory Default Value (if not speciﬁed inrequest)Description

AcceptablevaluesExampleapikeystringyes-

API key for authentication--

outputstringnojson

Output format

json

json

•
•

json - get response in JSON
format.
xml - get response in XML format.

xml

Response Parameters: get-subscription-infoParameter

Data Type

Description

ExamplestatusstringCurrent status of the API subscription plan.

activeOne of:••••activeinactive
expireddisabled

start_date

datetime

Subscription start date in "YYYY-MM-DD HH:MM:SS" format.

2019-01-08 01:02:03

expiration_date

datetime

Subscription expiration date in "YYYY-MM-DD HH:MM:SS" format.

2019-02-08 01:02:03

units_limit

long

Quota (total number of API units) for this subscription

50000000

units_left

longCurrent API balance, i.e. number of API units left.

123546

Sample Request: get-subscription-info
GET: https://api.seopowersuite.com/backlinks/v1.0/get-subscription-info?apikey=XXX&output=json

Sample Response: get-subscription-info{"subscription_info": {"status": "active","start_date": "2024-01-18 14:20:02","expiraton_date": "2024-02-18 14:20:02","units_limit": 5000000,"units_left": 4975033}}

Error HandlingIf a request to the API fails, the HTTP response will return an error, including the error code and a detailed description of the error in the response's body.
Below are the details of common errors you may experience while working with the SEO PowerSuite Backlinks API.

Code

Error Text

Solution

200 (OK)

Returned value for a parameter is a negative digit

This situation is totally OK, and might happen if a special value
must be returned - for example, InLink Rank = -1 must betreated as Unknown (unlike the situation where InLink Rank is
known and equal to 0).

200 (OK)

Returned value for a parameter is zero.

This situation is totally OK, and might happen if there's no data
for the target - for example, no referring backlinks or domains
for an URL.

244 (Results for huge
websites like google.com or
twitter.com are unavailable
via API so far)Results for huge websites like google.com or
twitter.com are unavailable via API so far.

The command does not support your target so far due to thehuge amount of data it requires to process.

405 (Method Not Allowed)

Method Not Allowed.

Please ensure you are using a method, which is supported at aresource.

406 (Not Acceptable)

Unsupported 'output' format. Supported output
formats are 'json' (default) and 'xml'.

The server cannot produce a response matching the desired
output format. Supported output formats are "json" (default)
and "xml".

429 (Too Many Requests)

Call rate limit reached.

You are making too many requests per time period andexceeding the call rate limit for your API key.

500 Internal Server Error

Unexpected error. Please try again later.

An unexpected error occurred (e.g.: a search engine parser isbroken).

503 Service unavailable

System is busy. Please try again later.

The system is busy and can't handle the request at the
moment.

400 (Bad Request)

Invalid target

Please ensure all values you have passed as a target are valid. A
detailed list of all valid values for different parameters can befound in a speciﬁc command's documentation.

400 (Bad Request)

YYYY=XXXX is not within required bounds!

Please ensure all values you have passed as parameters arevalid. Range of acceptable values can be found on a speciﬁc
command's documentation.

400 (Bad Request)

Insufficient funds, API key is temporarily disabled.
Please make a payment to enable you API key orcontact us at api@seopowersuite.com.

Please ensure you have sufficient balance. The request cannot
be processed until you make a payment to re-enable your API
key.

400 (Bad Request)

Unsupported 'XXXXX' format. Supported 'YYYYY'
formats are 'AAAAA' (default), 'BBBBBB', etc.

Unsupported format of the XXXXX parameter. Supported
XXXXXX formats might be different for different commands,
a detailed list of all valid values can be found on a speciﬁc
command's documentation.

400 (Bad Request)

The requested resource could not be found.

Please ensure you are requesting a valid resource.

400 (Bad Request)

Authentication failed. Please ensure you have avalid, enabled API key. To get an API key, pleasecontact us at api@seopowersuite.com.

The access is forbidden. Please contact us at
api@seopowersuite.com to ﬁnd out the reason and re-enable
your API key.

400 (Bad Request)

Authentication failed. Please make sure your API
key is valid and active. To get an API key, pleasecontact us at api@seopowersuite.com.

Please ensure you have a valid, active API key.

400 (Bad Request)

Parameter YYY is invalid.

Please ensure all values you have passed as parameters arevalid. A detailed list of all valid values for different parameters
can be found on a speciﬁc command's documentation.

400 (Bad Request)

Unsupported 'order_by' format. Supported'order_by' formats are 'backlinks' (default),'refdomains'.

Unsupported order_by format. Supported order_by formats
might be different for different commands, a detailed list of all
valid values can be found on a speciﬁc command's
documentation.

400 (Bad Request)

Unsupported 'mode' format. Supported 'mode'
formats are 'host' (default), 'domain', 'url'.

The server cannot produce a response matching the desiredmode format. Supported output formats are "domain", "host"(default) or "url".

400 (Bad Request)

Parameter YYY is missing.

Please ensure you have passed all mandatory parameters.