▣ SEO

Analyze Backlinks API

What it does

Backlinks Analyzer helps you inspect the backlink profile of a domain, host, or URL. Send a target and get counts, referring domains, referring IPs, anchor text breakdowns, authority scores, and backlink history back in JSON or XML.

Use it to measure link acquisition, audit backlink quality, or compare pages during SEO reviews. The service supports both single targets and batch requests on several endpoints, so you can pull summary metrics for a site, then drill into the exact backlinks, refdomains, anchors, and indexed pages that make up those totals.

You can also filter results by mode, limit, ordering, date range, dofollow or nofollow status, link type, anchor type, and URL patterns on the history and all-backlinks endpoints. For larger exports, the API returns a task ID and task status so you can poll for completion and download the generated .csv.gz file when it is ready.

Backlinks Analyzer is a fit for SEO dashboards, competitive analysis, link monitoring, and automated reporting where you need structured backlink data instead of manual exports.

▣ ENDPOINT 01 / 44

GET

Export Backlinks

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/export

QUICKSTART

GUIDE

Quickstart

Export backlink data for a target URL, domain, or host with the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/export?target=apyhub.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with optional task_id and task_status fields. task_id is a string for the created export task, and task_status is a string such as queued_for_processing, processing, complete, rejected, or unknown.

{
  "task_id": "task_12345",
  "task_status": "queued_for_processing"
}

TRY ITLIVE · 2000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Starts an asynchronous export of backlinks data for the specified target and returns a task identifier you can use to track processing. The request accepts query parameters to define the target scope and export mode, and the response reports the task status.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Scope of the export.<br>Allowed values: `domain`, `host`, `url`.<br>Default: `host`
output	ENUM	No	Output format.<br>Allowed values: `json`, `xml`.<br>Default: `json`
target	String	Yes	The target to export backlinks data for.

Response

Returns a JSON object with a task_id string field and a task_status string field. The task_status field indicates the export task’s current state.

Parameter	Type	Mandatory	Description
task_id	String	No	Identifier for the asynchronous export task.
task_status	ENUM	No	Current task state.<br>Allowed values: `queued_for_processing`, `processing`, `complete`, `rejected`, `unknown`

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 02 / 44

GET

Check Backlinks Export Status

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/export/status

QUICKSTART

GUIDE

Quickstart

Check the export task status by passing the required task_id as a query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/export/status?task_id=task-12345" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with optional top-level task_id, task_status, and download_file fields.

task_id is a string for the task being checked.
task_status is a string enum such as queued_for_processing, processing, complete, rejected, or unknown.
download_file is a string URL or path when available, or null.

{
  "task_id": "task-12345",
  "task_status": "complete",
  "download_file": "https://example.com/download.csv"
}

TRY ITLIVE · 500 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Checks the status of a backlink export task and returns the task identifier, current task status, and an optional download file reference when available.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Allowed values: `json`, `xml`.<br>Default: `json`.
task_id	String	Yes	The backlink export task identifier.

Response

Returns a JSON object with task_id, task_status, and download_file fields. task_status reports the export task state, and download_file is nullable.

Attribute	Type	Mandatory	Description
task_id	String	No	The backlink export task identifier.
task_status	ENUM	No	Allowed values: `queued_for_processing`, `processing`, `complete`, `rejected`, `unknown`.
download_file	String	No	Download file reference for the export result, or `null` when not available.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

task_idREQUIRED

string

—

▣ ENDPOINT 03 / 44

GET

List Referring IPs

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-ips

QUICKSTART

GUIDE

Quickstart

Fetch the referring IPs for a target host, domain, or URL with the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-ips?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a referring_ips array. Each item is an object with ip, backlinks, and refdomains fields.

{
  "referring_ips": [
    {
      "ip": "192.0.2.10",
      "backlinks": 42,
      "refdomains": 7
    }
  ]
}

TRY ITLIVE · 750 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns a JSON object containing a referring_ips array for the specified target. Each array item is an object with IP-related backlink metrics.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Allowed values: `domain`, `host`, `url`.<br>Default: `host`.
limit	Integer	No	Minimum: 1.<br>Maximum: 10000.<br>Default: 100.
output	ENUM	No	Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	The target to analyze.
order_by	ENUM	No	Allowed values: `backlinks`, `refdomains`.<br>Default: `backlinks`.

Response

Returns a JSON object with a referring_ips array field. Each array item is an object with ip string, backlinks integer, and refdomains integer fields.

Parameter	Type	Mandatory	Description
referring_ips	Object Array	No	Array of referring IP objects.
referring_ips[].ip	String	No	The IP address.
referring_ips[].backlinks	Integer	No	Number of backlinks associated with the IP.
referring_ips[].refdomains	Integer	No	Number of referring domains associated with the IP.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

limitOPTIONAL

integer

—

DEFAULT 100

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

order_byOPTIONAL

string

backlinks · refdomains

—

DEFAULT backlinks

▣ ENDPOINT 04 / 44

POST

Count Referring Subnets

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-ips

QUICKSTART

GUIDE

Quickstart

Look up the referring IPs for a target backlink profile.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-ips?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

What you'll get back

Returns a JSON object with a referring_ips array. Each item is an object with ip, backlinks, and refdomains fields.

{
  "referring_ips": [
    {
      "ip": "192.0.2.1",
      "backlinks": 42,
      "refdomains": 7
    }
  ]
}

TRY ITLIVE · 750 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Lists the referring IPs for a target passed in the request body. The response returns a JSON object containing a referring_ips array with per-IP backlink data.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format.<br>- `json`<br>- `xml`<br>Default: `json`

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Target interpretation mode.<br>- `domain`<br>- `host`<br>- `url`
limit	Integer	No	Maximum number of results to return.
target	String	Yes	The target to look up.
order_by	ENUM	No	Sort order for the returned referring IPs.<br>- `backlinks`<br>- `refdomains`

Response

Returns a JSON object with a referring_ips object array field. Each item in the array contains ip as a string, backlinks as an integer, and refdomains as an integer.

Parameter	Type	Mandatory	Description
referring_ips	Object Array	No	The list of referring IP records. Each item includes:<br>- `ip` string<br>- `backlinks` integer<br>- `refdomains` integer

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 05 / 44

GET

referring-subnets/count

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-subnets/count

QUICKSTART

GUIDE

Quickstart

Get the count of referring subnets for a target by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-subnets/count?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object with a target string and a referring_subnets integer.

{
  "metrics": [
    {
      "target": "example.com",
      "referring_subnets": 42
    }
  ]
}

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the total count of referring subnets (C-blocks) for a given target. The request takes query parameters to identify the target and optionally control the target interpretation mode and response format.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Target interpretation mode.<br>- `domain`<br>- `host`<br>- `url`<br>Default: `host`
output	ENUM	No	Response format.<br>- `json`<br>- `xml`<br>Default: `json`
target	String	Yes	The target to analyze.

Response

Returns a JSON object with a metrics array field. Each array item is an object containing a target string field and a referring_subnets integer field. This endpoint is documented by the output schema as an object wrapper with a single top-level metrics field.

Parameter	Type	Mandatory	Description
metrics	Object Array	No	Array of metric objects. Each object includes:<br>- `target` (String)<br>- `referring_subnets` (Integer)

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 06 / 44

POST

referring-subnets/count

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-subnets/count

QUICKSTART

GUIDE

Quickstart

Count referring subnets for a target domain, host, or URL using the default JSON output.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-subnets/count?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com","mode":"domain"}'

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object with target as a string and referring_subnets as an integer.

{
  "metrics": [
    {
      "target": "example.com",
      "referring_subnets": 42
    }
  ]
}

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Counts the total number of referring subnets for the submitted target(s) and returns the result in a JSON object with a metrics array. The request accepts a target plus an optional mode, and can also request an alternate output format via query parameter.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Scope of the target. Allowed values: `domain`, `host`, `url`.
target	String	Yes	The target to analyze. Can be a single string or an array of strings.

Response

Returns a JSON object with a metrics array field. Each item in metrics is an object with a target string and a referring_subnets integer.

Parameter	Type	Mandatory	Description
metrics	Object Array	No	Array of metric objects. Each item contains: `target` (String) and `referring_subnets` (Integer).

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 07 / 44

GET

Get Domain Authority

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/domain

QUICKSTART

GUIDE

Quickstart

Look up backlink authority for a domain by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/domain?target=apyhub.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with an authority array. Each item in the array is an object with a target string and a domain_inlink_rank integer.

{
  "authority": [
    {
      "target": "example.com",
      "domain_inlink_rank": 42
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Retrieves the domain authority data for the specified target domain and returns it as a JSON object containing an authority array.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format.<br>Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	The target domain to look up.

Response

Returns a JSON object with an authority array field. Each item in the array is an object with a target string field and a domain_inlink_rank integer field.

Attribute	Type	Mandatory	Description
authority	Object Array	No	Array of authority records. Each item contains `target` and `domain_inlink_rank`.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 08 / 44

POST

Get Domain Authority

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/domain

QUICKSTART

GUIDE

Quickstart

Look up backlink authority for one target domain.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/domain?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":["apyhub.com"]}'

What you'll get back

Returns a JSON object with an authority array. Each item is an object with target as a string and domain_inlink_rank as an integer.

{
  "authority": [
    {
      "target": "example.com",
      "domain_inlink_rank": 42
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Calculates domain authority for the target domain(s) you submit in the request body. The endpoint returns a JSON object containing an authority array with the authority data for each target.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
target	String Array	Yes	Target domain(s) to evaluate. Accepts a single string or an array of strings.

Response

Returns a JSON object with an authority array field. Each item in the array is an object containing a target string and a domain_inlink_rank integer.

Parameter	Type	Mandatory	Description
authority	Object Array	No	Array of authority results. Each item includes `target` and `domain_inlink_rank`.
authority[].target	String	No	Target domain associated with the result.
authority[].domain_inlink_rank	Integer	No	Domain inlink rank for the target.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 09 / 44

GET

Get New/Lost Referring Domains — Daily Counts

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/history/count

QUICKSTART

GUIDE

Quickstart

Check backlink referring domain history count for a target, using the required query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/history/count?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a new_lost_refdomains_count array. Each item in the array is an object that can include new and lost integers plus a date string in date format.

{
  "new_lost_refdomains_count": [
    {
      "new": 12,
      "date": "2024-01-01",
      "lost": 3
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Retrieves the daily count of new and lost referring domains for a target, using query parameters to define the target and optional date range and output preferences. The response is a JSON object containing an array of daily count objects.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Allowed values: `domain`, `host`, `url`.<br>Default: `host`.
output	ENUM	No	Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	The target to analyze.
date_to	String	No	Date in `date` format.
date_from	String	No	Date in `date` format.
new_lost_type	ENUM	No	Allowed values: `new`, `lost`.

Response

Returns a JSON object with a new_lost_refdomains_count array field. Each item in the array is an object with new integer, date string in date format, and lost integer fields.

Attribute	Type	Mandatory	Description
new_lost_refdomains_count	Object Array	No	Array of daily referring-domain count objects.
new_lost_refdomains_count[].new	Integer	No	Count of new referring domains for the day.
new_lost_refdomains_count[].date	String	No	Date in `date` format.
new_lost_refdomains_count[].lost	Integer	No	Count of lost referring domains for the day.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

date_toOPTIONAL

string

—

date_fromOPTIONAL

string

—

new_lost_typeOPTIONAL

string

new · lost

—

▣ ENDPOINT 10 / 44

POST

Get New/Lost Referring Domains — Daily Counts

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/history/count

QUICKSTART

GUIDE

Quickstart

Fetch a count history for a single target domain or URL. output is sent as a query parameter, and the required target goes in the JSON body.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/history/count?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

What you'll get back

Returns a JSON object with a new_lost_refdomains_count array. Each array item is an object with new and lost integer counts and a date string in date format.

{
  "new_lost_refdomains_count": [
    {
      "new": 12,
      "date": "2024-01-01",
      "lost": 3
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the daily count of new and lost referring domains for a target. You send the target and optional filters in the request body, and the response returns a JSON object containing a new_lost_refdomains_count array of dated count records.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Target type. Allowed values: `domain`, `host`, `url`.
target	String	Yes	The target to analyze.
date_to	String	No	End date filter. Format: `date`.
date_from	String	No	Start date filter. Format: `date`.
new_lost_type	ENUM	No	Referring-domain type to count. Allowed values: `new`, `lost`.

Response

Returns a JSON object with a new_lost_refdomains_count array field. Each array item is an object with new integer, date string, and lost integer fields.

Parameter	Type	Mandatory	Description
new_lost_refdomains_count	Object Array	No	Array of daily referring-domain count records. Each item contains `new`, `date`, and `lost` fields.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 11 / 44

GET

List Indexed Pages by Backlinks

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/indexed-pages

QUICKSTART

GUIDE

Quickstart

Fetch indexed pages for a target site by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/indexed-pages?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a pages array. Each item in pages is an object that may include url as a string, backlinks as an integer, and refdomains as an integer.

{
  "pages": [
    {
      "url": "https://example.com/page-one",
      "backlinks": 42,
      "refdomains": 8
    }
  ]
}

TRY ITLIVE · 1000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns a JSON object containing a pages array of indexed pages related to the supplied target, along with backlink metrics for each page. The endpoint accepts query parameters to control the target scope, result limit, output format, and ordering.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Scope used to match the target. Allowed values: `domain`, `host`, `url`. Default: `host`.
limit	Integer	No	Maximum number of results to return. Default: `100`.
output	ENUM	No	Response format. Allowed values: `json`, `xml`. Default: `json`.
target	String	Yes	Target value to look up.
order_by	String	No	Sort key for the returned pages. Default: `backlinks`.

Response

Returns a JSON object with a pages array field. Each item in pages is an object with url as a string, backlinks as an integer, and refdomains as an integer.

Parameter	Type	Mandatory	Description
pages	Object Array	No	List of pages returned by the endpoint. Each item contains `url`, `backlinks`, and `refdomains`.
pages[].url	String	No	Page URL.
pages[].backlinks	Integer	No	Number of backlinks for the page.
pages[].refdomains	Integer	No	Number of referring domains for the page.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

limitOPTIONAL

integer

—

DEFAULT 100

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

order_byOPTIONAL

string

—

DEFAULT backlinks

▣ ENDPOINT 12 / 44

POST

List Indexed Pages by Backlinks

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/indexed-pages

QUICKSTART

GUIDE

Quickstart

Fetch indexed pages for a target site by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/indexed-pages?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a pages array. Each item in pages is an object that may include url as a string, backlinks as an integer, and refdomains as an integer.

{
  "pages": [
    {
      "url": "https://example.com/page-one",
      "backlinks": 42,
      "refdomains": 8
    }
  ]
}

TRY ITLIVE · 1000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Scope used to match the target. Allowed values: `domain`, `host`, `url`. Default: `host`.
limit	Integer	No	Maximum number of results to return. Default: `100`.
output	ENUM	No	Response format. Allowed values: `json`, `xml`. Default: `json`.
target	String	Yes	Target value to look up.
order_by	String	No	Sort key for the returned pages. Default: `backlinks`.

Response

Returns a JSON object with a pages array field. Each item in pages is an object with url as a string, backlinks as an integer, and refdomains as an integer.

Parameter	Type	Mandatory	Description
pages	Object Array	No	List of pages returned by the endpoint. Each item contains `url`, `backlinks`, and `refdomains`.
pages[].url	String	No	Page URL.
pages[].backlinks	Integer	No	Number of backlinks for the page.
pages[].refdomains	Integer	No	Number of referring domains for the page.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

limitOPTIONAL

integer

—

DEFAULT 100

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

order_byOPTIONAL

string

—

DEFAULT backlinks

▣ ENDPOINT 13 / 44

GET

Get Domain Authority Distribution

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/domain/distribution

QUICKSTART

GUIDE

Quickstart

Get the backlink authority distribution for a target domain, host, or URL.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/domain/distribution?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a distribution array. Each item in distribution is an object with domains, range_from, and range_to integer fields.

{
  "distribution": [
    {
      "domains": 12,
      "range_from": 0,
      "range_to": 10
    }
  ]
}

TRY ITLIVE · 1000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the authority distribution for a target passed as a query parameter. The response is a JSON object containing a distribution array.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Scope used to interpret the target.<br>- Allowed values: `domain`, `host`, `url`<br>- Default: `host`
output	ENUM	No	Response format requested by the caller.<br>- Allowed values: `json`, `xml`<br>- Default: `json`
target	String	Yes	Target value to analyze.

Response

Returns a JSON object with a distribution object array field. Each item in distribution contains domains as an integer, range_to as an integer, and range_from as an integer.

Parameter	Type	Mandatory	Description
distribution	Object Array	No	Array of distribution buckets. Each item contains:<br>- `domains` (`Integer`): Number of domains in the bucket<br>- `range_to` (`Integer`): Upper bound of the authority range<br>- `range_from` (`Integer`): Lower bound of the authority range

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 14 / 44

GET

Count Referring Domains

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/count

QUICKSTART

GUIDE

Quickstart

Get the number of referring domains for a target by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/count?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object with a target string and a refdomains integer.

{
  "metrics": [
    {
      "target": "example.com",
      "refdomains": 42
    }
  ]
}

TRY ITLIVE · 500 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the total referring domains count for a specified target. You provide the target and can optionally control how the target is interpreted with mode, plus the response format with output.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	How to interpret the target value. Allowed values: `domain`, `host`, `url`. Default: `host`.
output	ENUM	No	Response format. Allowed values: `json`, `xml`. Default: `json`.
target	String	Yes	The target to analyze.

Response

Returns a JSON object with a metrics array field. Each item in metrics is an object containing a target string and a refdomains integer.

Parameter	Type	Mandatory	Description
metrics	Object Array	No	Array of metric objects. Each item includes `target` and `refdomains`.
metrics[].target	String	No	The target associated with the metric.
metrics[].refdomains	Integer	No	Total referring domains count for that target.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 15 / 44

POST

Count Referring Domains

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/count

QUICKSTART

GUIDE

Quickstart

Count referring domains for a target by sending the required target in the JSON body.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/count?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object with a target string and a refdomains integer.

{
  "metrics": [
    {
      "target": "example.com",
      "refdomains": 123
    }
  ]
}

TRY ITLIVE · 500 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the total referring domains count for the provided target in the request body. The request body accepts a required target value and an optional mode; the response returns a JSON object containing a metrics array with referring-domain counts for each returned target.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Target interpretation mode. Allowed values: `domain`, `host`, `url`.
target	String Array	Yes	Target to evaluate. The schema allows either a single string or an array of strings.

Response

Returns a JSON object with a metrics array field. Each item in metrics is an object with a target string field and a refdomains integer field.

Parameter	Type	Mandatory	Description
metrics	Object Array	No	Array of metric objects returned by the endpoint.
metrics[].target	String	No	Target associated with the metric entry.
metrics[].refdomains	Integer	No	Total referring domains count for the target.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 16 / 44

GET

Get Raw Backlinks (Cursor-Paginated)

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/raw

QUICKSTART

GUIDE

Quickstart

Fetch raw backlinks for a target URL or domain using the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/raw?target=example.com&mode=host" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a backlinks array and an optional next string cursor for pagination. Each item in backlinks is an object describing one backlink record.

{
  "next": "cursor-token",
  "backlinks": [
    {
      "url_from": "https://example.org/page",
      "url_to": "https://example.com/",
      "anchor": "Example site",
      "title": "Example Page",
      "nofollow": false,
      "first_seen": "2024-01-15",
      "last_visited": "2024-01-20",
      "inlink_rank": 42,
      "domain_inlink_rank": 18
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Fetches backlinks for a target in cursor-based batches. The request is sent as query parameters, and the response returns a JSON object containing the current batch of backlinks plus an optional cursor for the next page.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	String	No	Query mode.<br>Allowed values: `domain`, `host`, `url`.<br>Default: `host`.
next	String	No	Cursor for the next page.
limit	Integer	No	Maximum number of backlinks to return in one response.<br>Minimum: `1`.<br>Maximum: `100000`.<br>Default: `10000`.
output	String	No	Response format.<br>Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	Target to fetch backlinks for.
per_domain	Integer	No	Maximum number of backlinks to include per domain.<br>Minimum: `1`.<br>Maximum: `100`.

Response

Returns a JSON object with a nullable next string cursor field and a backlinks array field. Each item in backlinks is an object that can include backlink metadata such as URLs, anchor text, flags, ranks, and dates.

Parameter	Type	Mandatory	Description
next	String	No	Cursor for the next page. Absent on the last page.
backlinks	Object Array	No	Backlink records returned for the requested target. Each item may include the fields below.
backlinks[].alt	String	No	Alternative text associated with the backlink item.
backlinks[].image	Boolean	No	Indicates whether the backlink entry is an image backlink.
backlinks[].title	String	No	Title associated with the backlink item.
backlinks[].anchor	String	No	Anchor text for the backlink.
backlinks[].url_to	String	No	Destination URL.
backlinks[].nofollow	Boolean	No	Indicates whether the backlink is marked nofollow.
backlinks[].url_from	String	No	Source URL.
backlinks[].first_seen	String	No	Date the backlink was first seen. Format: `date`.
backlinks[].inlink_rank	Integer	No	Inlink rank value.
backlinks[].image_source	String	No	Image source URL or identifier.
backlinks[].last_visited	String	No	Date the backlink was last visited. Format: `date`.
backlinks[].domain_inlink_rank	Integer	No	Domain inlink rank value.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

nextOPTIONAL

string

—

limitOPTIONAL

integer

—

DEFAULT 10000

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

per_domainOPTIONAL

integer

—

▣ ENDPOINT 17 / 44

GET

List New/Lost Referring Domains

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/history

QUICKSTART

GUIDE

Quickstart

Fetch historical referring domains for a target by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/history?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a new_lost_refdomains array. Each item in the array is an object that may include backlinks, refdomain, first_seen, new_lost_date, new_lost_type, dofollow_backlinks, and domain_inlink_rank.

{
  "new_lost_refdomains": [
    {
      "backlinks": 12,
      "refdomain": "example.com",
      "first_seen": "2024-01-15",
      "new_lost_date": "2024-03-01",
      "new_lost_type": "new",
      "dofollow_backlinks": 10,
      "domain_inlink_rank": 42
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns a list of referring domains that are new or lost for the specified target, with optional filtering and sorting by date and rank-related fields.

Query Parameter(s)

Attribute	Type	Mandatory	Description
target	String	Yes	The target to analyze.
mode	ENUM	No	Allowed values: `domain`, `host`, `url`.<br>Default: `host`.
limit	Integer	No	Minimum: `1`.<br>Maximum: `10000`.<br>Default: `100`.
output	ENUM	No	Allowed values: `json`, `xml`.<br>Default: `json`.
date_to	String	No	Date format: `date`.
order_by	ENUM	No	Allowed values: `new_lost_date`, `domain_inlink_rank`, `inlink_rank`.<br>Default: `new_lost_date`.
date_from	String	No	Date format: `date`.
new_lost_type	ENUM	No	Allowed values: `new`, `lost`.

Response

Returns a JSON object with a new_lost_refdomains array field. Each array item is an object describing a referring domain entry with backlink counts, the refdomain name, date fields, the new/lost type, and domain inlink rank.

Attribute	Type	Mandatory	Description
new_lost_refdomains	Object Array	No	The list of referring domain records. Each item includes the fields below.
new_lost_refdomains[].backlinks	Integer	No	Number of backlinks.
new_lost_refdomains[].refdomain	String	No	The referring domain.
new_lost_refdomains[].first_seen	String	No	Date format: `date`.
new_lost_refdomains[].new_lost_date	String	No	Date format: `date`.
new_lost_refdomains[].new_lost_type	ENUM	No	Allowed values: `new`, `lost`.
new_lost_refdomains[].dofollow_backlinks	Integer	No	Number of dofollow backlinks.
new_lost_refdomains[].domain_inlink_rank	Integer	No	Domain inlink rank.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

limitOPTIONAL

integer

—

DEFAULT 100

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

date_toOPTIONAL

string

—

order_byOPTIONAL

string

new_lost_date · domain_inlink_rank · inlink_rank

—

DEFAULT new_lost_date

date_fromOPTIONAL

string

—

new_lost_typeOPTIONAL

string

new · lost

—

▣ ENDPOINT 18 / 44

POST

List New/Lost Referring Domains

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/history

QUICKSTART

GUIDE

Quickstart

Fetch the history of new or lost referring domains for a target, using the required target field and the default JSON output.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains/history?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "example.com"
  }'

What you'll get back

Returns a JSON object with a new_lost_refdomains array. Each item in the array is an object with fields like backlinks, refdomain, first_seen, new_lost_date, new_lost_type, dofollow_backlinks, and domain_inlink_rank.

{
  "new_lost_refdomains": [
    {
      "backlinks": 12,
      "refdomain": "refexample.com",
      "first_seen": "2024-01-10",
      "new_lost_date": "2024-01-15",
      "new_lost_type": "new",
      "dofollow_backlinks": 10,
      "domain_inlink_rank": 42
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns a list of referring domains that are new or lost for the specified target, filtered by the date range and type provided in the request body. The response is a JSON object containing a new_lost_refdomains array of result objects.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format.<br>Allowed values: `json`, `xml`.<br>Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Target scope.<br>Allowed values: `domain`, `host`, `url`.
target	String	Yes	The target to analyze.
date_to	String	No	End date for the history filter. Format: `date`.
date_from	String	No	Start date for the history filter. Format: `date`.
new_lost_type	ENUM	No	Referring domain change type to return.<br>Allowed values: `new`, `lost`.

Response

Returns a JSON object with a new_lost_refdomains array field. Each array item is an object containing backlink and domain history details for a referring domain: backlinks integer, refdomain string, first_seen date string, new_lost_date date string, new_lost_type enum, dofollow_backlinks integer, and domain_inlink_rank integer.

Parameter	Type	Mandatory	Description
new_lost_refdomains	Object Array	Yes	Array of referring-domain history records.
new_lost_refdomains[].backlinks	Integer	No	Number of backlinks associated with the refdomain.
new_lost_refdomains[].refdomain	String	No	Referring domain.
new_lost_refdomains[].first_seen	String	No	First seen date. Format: `date`.
new_lost_refdomains[].new_lost_date	String	No	Date when the domain was marked new or lost. Format: `date`.
new_lost_refdomains[].new_lost_type	ENUM	No	Change type for the refdomain.<br>Allowed values: `new`, `lost`.
new_lost_refdomains[].dofollow_backlinks	Integer	No	Number of dofollow backlinks associated with the refdomain.
new_lost_refdomains[].domain_inlink_rank	Integer	No	Domain inlink rank value.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 19 / 44

GET

Get Page Authority

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/page

QUICKSTART

GUIDE

Quickstart

Look up backlink authority for a target URL. The target is required, and output=json is the default query format.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/page?target=https://apyhub.com&output=json" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with an authority array. Each item in the array is an object with a target string and an inlink_rank integer.

{
  "authority": [
    {
      "target": "https://example.com/page",
      "inlink_rank": 42
    }
  ]
}

TRY ITLIVE · 500 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the page authority information for a target URL. The response contains an authority array of objects with the target and its inlink_rank.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Allowed values: `json`, `xml`<br>Default: `json`
target	String	Yes	Target URL to evaluate.

Response

Returns a JSON object with an authority array field. Each item in the array is an object with a target string field and an inlink_rank integer field.

Attribute	Type	Mandatory	Description
authority	Object Array	No	Array of authority records.
authority[].target	String	No	Target URL associated with the authority score.
authority[].inlink_rank	Integer	No	InLink Rank value for the target.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 20 / 44

POST

Get Page Authority

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/page

QUICKSTART

GUIDE

Quickstart

Look up authority data for a target backlink page and return it as JSON.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/page?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":["apyhub.com"]}'

What you'll get back

Returns a JSON object with an authority array. Each item in the array is an object with a target string and an inlink_rank integer.

{
  "authority": [
    {
      "target": "https://example.com/page",
      "inlink_rank": 42
    }
  ]
}

TRY ITLIVE · 500 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Calculates page authority for the target URL(s) provided in the request body and returns the result as a JSON object containing an authority array.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
target	String Array	Yes	Target URL or URLs to evaluate. Accepts a single string or an array of strings.

Response

Returns a JSON object with an authority array field. Each item in the array is an object with a target string field and an inlink_rank integer field.

Parameter	Type	Mandatory	Description
authority	Object Array	No	Array of page authority results. Each item contains:<br>- `target` (`String`)<br>- `inlink_rank` (`Integer`)

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 21 / 44

GET

Get Domain Authority History

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/domain/history

QUICKSTART

GUIDE

Quickstart

Fetch backlink authority history for a target domain with the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/domain/history?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a history array. Each item in history is an object with a date string and a domain_inlink_rank integer.

{
  "history": [
    {
      "date": "2024-01-01",
      "domain_inlink_rank": 42
    }
  ]
}

TRY ITLIVE · 250 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the domain authority history for a target domain as a JSON object containing a history array. Each history item includes a date and a domain_inlink_rank value.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format.<br>Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	The domain to retrieve authority history for.
date_to	String	No	End date for the history range.<br>Format: `date`.
date_from	String	No	Start date for the history range.<br>Format: `date`.
granularity	String	No	Granularity of the returned history.<br>Example: `by_day`.

Response

Returns a JSON object with a history array field. Each item in history is an object with a date string field and a domain_inlink_rank integer field.

Parameter	Type	Mandatory	Description
history	Object Array	No	Array of history entries.
history[].date	String	No	The date for the entry.<br>Format: `date`.
history[].domain_inlink_rank	Integer	No	The domain inlink rank for that date.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

date_toOPTIONAL

string

—

date_fromOPTIONAL

string

—

granularityOPTIONAL

string

—

▣ ENDPOINT 22 / 44

GET

List Referring Domains

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains

QUICKSTART

GUIDE

Quickstart

Fetch referring domains for a target using the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a refdomains array. Each item in the array can include backlinks (integer), refdomain (string), first_seen (date string), dofollow_backlinks (integer), and domain_inlink_rank (integer).

{
  "refdomains": [
    {
      "backlinks": 42,
      "refdomain": "example.com",
      "first_seen": "2024-01-15",
      "dofollow_backlinks": 40,
      "domain_inlink_rank": 87
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns a JSON object containing a refdomains array of referring-domain records for the specified target, using the requested mode, limit, output, and order_by query parameters.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Refers to the target matching mode.<br>Allowed values: `domain`, `host`, `url`.<br>Default: `host`.
limit	Integer	No	Maximum number of records to return.<br>Minimum: `1`.<br>Maximum: `10000`.<br>Default: `100`.
output	ENUM	No	Output format.<br>Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	The target to list referring domains for.
order_by	ENUM	No	Sort order for the results.<br>Allowed values: `new_lost_date`, `domain_inlink_rank`, `inlink_rank`.<br>Default: `new_lost_date`.

Response

Returns a JSON object with a refdomains array field. Each item in the array is an object containing backlinks (integer), refdomain (string), first_seen (string in date format), dofollow_backlinks (integer), and domain_inlink_rank (integer).

Parameter	Type	Mandatory	Description
refdomains	Object Array	No	Array of referring-domain objects. Each item includes `backlinks`, `refdomain`, `first_seen`, `dofollow_backlinks`, and `domain_inlink_rank`.
refdomains[].backlinks	Integer	No	Number of backlinks associated with the referring domain.
refdomains[].refdomain	String	No	Referring domain value.
refdomains[].first_seen	String	No	Date the referring domain was first seen. Format: `date`.
refdomains[].dofollow_backlinks	Integer	No	Number of dofollow backlinks associated with the referring domain.
refdomains[].domain_inlink_rank	Integer	No	Domain inlink rank.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

limitOPTIONAL

integer

—

DEFAULT 100

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

order_byOPTIONAL

string

new_lost_date · domain_inlink_rank · inlink_rank

—

DEFAULT new_lost_date

▣ ENDPOINT 23 / 44

POST

List Referring Domains

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains

QUICKSTART

GUIDE

Quickstart

Get referring domains for a target site with the default JSON output.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/refdomains?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "example.com"
  }'

What you'll get back

Returns a JSON object with a refdomains array. Each item is an object that can include backlinks, refdomain, first_seen, dofollow_backlinks, and domain_inlink_rank.

{
  "refdomains": [
    {
      "backlinks": 42,
      "refdomain": "example.org",
      "first_seen": "2024-01-15",
      "dofollow_backlinks": 38,
      "domain_inlink_rank": 7
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Lists referring domains for a target provided in the request body. The endpoint returns a JSON object containing a refdomains array, where each item describes one referring domain and its backlink-related fields.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format.<br>- `json`<br>- `xml`<br>Default: `json`

Request Body

Parameter	Type	Mandatory	Description
target	String	Yes	Target to look up.
mode	ENUM	No	Target interpretation mode.<br>- `domain`<br>- `host`<br>- `url`
limit	Integer	No	Maximum number of referring domains to return.

Response

Returns a JSON object with a refdomains array field. Each item in the array is an object with backlinks (integer), refdomain (string), first_seen (string, date format), dofollow_backlinks (integer), and domain_inlink_rank (integer) fields.

Parameter	Type	Mandatory	Description
refdomains	Object Array	No	List of referring domain objects.
refdomains[].backlinks	Integer	No	Number of backlinks for the referring domain.
refdomains[].refdomain	String	No	Referring domain name.
refdomains[].first_seen	String	No	Date when the refdomain was first seen. Format: date.
refdomains[].dofollow_backlinks	Integer	No	Number of dofollow backlinks for the referring domain.
refdomains[].domain_inlink_rank	Integer	No	Domain inlink rank value for the referring domain.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 24 / 44

GET

Get Page & Domain Authority (Combined)

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority

QUICKSTART

GUIDE

Quickstart

Get page and domain authority for a target URL by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority?target=https%3A%2F%2Fexample.com%2F" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with an authority array. Each item in the array is an object that can include target (string), inlink_rank (integer), and domain_inlink_rank (integer).

{
  "authority": [
    {
      "target": "https://example.com/",
      "inlink_rank": 42,
      "domain_inlink_rank": 58
    }
  ]
}

TRY ITLIVE · 250 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns page and domain authority metrics for the requested target. The request is sent as query parameters, and the response wraps an authority array with the authority data for each returned item.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format.<br>Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	The target to look up.

Response

Returns a JSON object with an authority array field. Each array item is an object containing target as a string, inlink_rank as an integer, and domain_inlink_rank as an integer.

Attribute	Type	Mandatory	Description
authority	Object Array	No	Array of authority results. Each item includes `target`, `inlink_rank`, and `domain_inlink_rank`.
authority[].target	String	No	The target associated with the authority metrics.
authority[].inlink_rank	Integer	No	Page authority value.
authority[].domain_inlink_rank	Integer	No	Domain authority value.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 25 / 44

POST

Get Page & Domain Authority (Combined)

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority

QUICKSTART

GUIDE

Quickstart

Get authority metrics for a target URL or domain.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"https://example.com"}'

What you'll get back

Returns a JSON object with an authority array. Each item in the array is an object with target as a string, inlink_rank as an integer, and domain_inlink_rank as an integer.

{
  "authority": [
    {
      "target": "https://example.com",
      "inlink_rank": 42,
      "domain_inlink_rank": 55
    }
  ]
}

TRY ITLIVE · 250 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns authority data for one or more target URLs submitted in the request body. The response contains an authority array with per-target page and domain authority values.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
target	String Array	Yes	Target URL or URLs to evaluate. Accepts a string or an array of strings.

Response

Returns a JSON object with an authority array field. Each item in the array is an object containing target as a string, inlink_rank as an integer, and domain_inlink_rank as an integer. Success status code is not declared in the schema.

Parameter	Type	Mandatory	Description
authority	Object Array	No	Array of authority results. Each object includes:<br>- `target` (String): The target URL.<br>- `inlink_rank` (Integer): Page authority value.<br>- `domain_inlink_rank` (Integer): Domain authority value.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 26 / 44

GET

Get Cumulative Backlinks Over Time

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history/cumulative

QUICKSTART

GUIDE

Quickstart

Fetch cumulative backlink history for a target domain or URL using the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history/cumulative?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a backlinks_count array. Each item in the array is an object with a date string and a backlinks integer.

{
  "backlinks_count": [
    {
      "date": "2024-01-01",
      "backlinks": 128
    }
  ]
}

TRY ITLIVE · 250 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Retrieves cumulative backlinks history for a target and returns the backlink count over time. The request takes query parameters to define the target, matching mode, date range, and response output format.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Matching mode for the target.<br>- `domain`<br>- `host` (default)<br>- `url`
output	ENUM	No	Response format.<br>- `json` (default)<br>- `xml`
target	String	Yes	Target to retrieve backlink history for.
date_to	String	No	End date for the history range. Format: `date`.
date_from	String	No	Start date for the history range. Format: `date`.

Response

Returns a JSON object with a backlinks_count array field. Each array item is an object with a date string field in date format and a backlinks integer field.

Parameter	Type	Mandatory	Description
backlinks_count	Object Array	No	Cumulative backlink history entries over time.
backlinks_count[].date	String	No	Date for the count entry. Format: `date`.
backlinks_count[].backlinks	Integer	No	Backlink count for that date.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

date_toOPTIONAL

string

—

date_fromOPTIONAL

string

—

▣ ENDPOINT 27 / 44

POST

Get Cumulative Backlinks Over Time

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history/cumulative

QUICKSTART

GUIDE

Quickstart

Get cumulative backlink history for a target URL, domain, or host.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history/cumulative?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

What you'll get back

Returns a JSON object with a backlinks_count array. Each item in the array is an object with a date string and a backlinks integer.

{
  "backlinks_count": [
    {
      "date": "2024-01-01",
      "backlinks": 1234
    }
  ]
}

TRY ITLIVE · 250 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns cumulative backlink counts over time for a specified target. You provide the target and optional date range in the request body, and the response contains time-series backlink data.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Target matching mode. Allowed values: `domain`, `host`, `url`.
target	String	Yes	The target to query backlinks for.
date_to	String	No	End date in `date` format.
date_from	String	No	Start date in `date` format.

Response

Returns a JSON object with a backlinks_count array field. Each item in the array is an object containing a date string field in date format and a backlinks integer field.

Parameter	Type	Mandatory	Description
backlinks_count	Object Array	No	Time-series backlink counts over time. Each item contains:<br>- `date` — String in `date` format<br>- `backlinks` — Integer

Notes

The output query parameter controls the response format and defaults to json if omitted.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 28 / 44

GET

List Backlink Anchor Texts

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/anchors

QUICKSTART

GUIDE

Quickstart

Fetch anchor text backlinks for a target URL or domain with the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/anchors?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with an anchors array. Each item in anchors is an object with fields like anchor, backlinks, first_seen, refdomains, last_visited, dofollow_backlinks, and nofollow_backlinks.

{
  "anchors": [
    {
      "anchor": "example anchor",
      "backlinks": 12,
      "first_seen": "2024-01-15",
      "refdomains": 5,
      "last_visited": "2024-06-01",
      "dofollow_backlinks": 9,
      "nofollow_backlinks": 3
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns backlink anchor text data for the specified target. The response contains an anchors array with anchor-level backlink metrics.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Target matching mode. Allowed values: `domain`, `host`, `url`.<br>Default: `host`.
limit	Integer	No	Maximum number of results to return.<br>Default: `100`.<br>Minimum: `1`.<br>Maximum: `10000`.
output	ENUM	No	Response format. Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	Target to retrieve backlink anchor texts for.
order_by	ENUM	No	Sort order for the returned anchors. Allowed values: `backlinks`, `refdomains`.<br>Default: `backlinks`.

Response

Returns a JSON object with an anchors array field. Each item in anchors is an object containing anchor text and backlink metrics such as counts and dates.

Parameter	Type	Mandatory	Description
anchors	Object Array	No	List of anchor records. Each item contains the fields below.
anchors[].anchor	String	No	Anchor text.
anchors[].backlinks	Integer	No	Number of backlinks for the anchor.
anchors[].first_seen	String	No	Date the anchor was first seen, in `date` format.
anchors[].refdomains	Integer	No	Number of referring domains for the anchor.
anchors[].last_visited	String	No	Date the anchor was last visited, in `date` format.
anchors[].dofollow_backlinks	Integer	No	Number of dofollow backlinks for the anchor.
anchors[].nofollow_backlinks	Integer	No	Number of nofollow backlinks for the anchor.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

limitOPTIONAL

integer

—

DEFAULT 100

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

order_byOPTIONAL

string

backlinks · refdomains

—

DEFAULT backlinks

▣ ENDPOINT 29 / 44

POST

List Backlink Anchor Texts

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/anchors

QUICKSTART

GUIDE

Quickstart

Fetch backlink anchor data for a target domain, host, or URL.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/anchors?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

What you'll get back

Returns a JSON object with an anchors array. Each item in anchors is an object that can include anchor, backlinks, first_seen, refdomains, last_visited, dofollow_backlinks, and nofollow_backlinks.

{
  "anchors": [
    {
      "anchor": "Example site",
      "backlinks": 12,
      "first_seen": "2024-01-15",
      "refdomains": 3,
      "last_visited": "2024-06-20",
      "dofollow_backlinks": 9,
      "nofollow_backlinks": 3
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Retrieves backlink anchor texts for the target you provide in the request body and returns them as a list. You can optionally control the request mode, result limit, and sort order, and choose the response format with the output query parameter.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Request mode. Allowed values: `domain`, `host`, `url`.
limit	Integer	No	Maximum number of results to return.
target	String	Yes	Target to retrieve backlink anchor texts for.
order_by	ENUM	No	Sort order for results. Allowed values: `backlinks`, `refdomains`.

Response

Returns a JSON object with an anchors array field. Each item in the array is an object containing the anchor text and backlink metrics for that anchor.

Parameter	Type	Mandatory	Description
anchors	Object Array	No	List of anchor objects. Each object includes: `anchor` (string), `backlinks` (integer), `first_seen` (string, date format), `refdomains` (integer), `last_visited` (string, date format), `dofollow_backlinks` (integer), and `nofollow_backlinks` (integer).

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 30 / 44

GET

Get Backlink Profile Summary

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/summary

QUICKSTART

GUIDE

Quickstart

Fetch backlink summary data for a target site. mode and output use their defaults, so only target is included.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/summary?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a summary array. Each item in summary is an object containing backlink summary metrics such as target, backlinks, refdomains, anchors, ips, and related nested lists like top_tlds, top_countries, top_pages_by_backlinks, and top_anchors_by_backlinks.

{
  "summary": [
    {
      "target": "example.com",
      "backlinks": 120,
      "refdomains": 45,
      "anchors": 18
    }
  ]
}

TRY ITLIVE · 2000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns backlink summary data for the specified target. You can choose the lookup mode and the response output format via query parameters.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Lookup mode.<br>Allowed values: `domain`, `host`, `url`.<br>Default: `host`.
output	ENUM	No	Response format.<br>Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	Target value to summarize.

Response

Returns a JSON object with a summary array field. Each item in summary is an object containing backlink-related count fields and grouped arrays such as top_tlds, top_countries, top_pages_by_backlinks, top_pages_by_refdomains, top_anchors_by_backlinks, and top_anchors_by_refdomains.

Parameter	Type	Mandatory	Description
summary	Object Array	No	Array of backlink summary objects.
summary[].ips	Integer	No	Number of IPs.
summary[].target	String	No	Target being summarized.
summary[].anchors	Integer	No	Number of anchors.
summary[].subnets	Integer	No	Number of subnets.
summary[].top_tlds	Object Array	No	Top TLDs by count.
summary[].top_tlds[].tld	String	No	TLD value.
summary[].top_tlds[].count	Integer	No	Count for the TLD.
summary[].backlinks	Integer	No	Number of backlinks.
summary[].refdomains	Integer	No	Number of referring domains.
summary[].inlink_rank	Integer	No	Inlink rank.
summary[].edu_backlinks	Integer	No	Number of .edu backlinks.
summary[].gov_backlinks	Integer	No	Number of .gov backlinks.
summary[].top_countries	Object Array	No	Top countries by count.
summary[].top_countries[].count	Integer	No	Count for the country.
summary[].top_countries[].country	String	No	Country value.
summary[].edu_refdomains	Integer	No	Number of .edu referring domains.
summary[].gov_refdomains	Integer	No	Number of .gov referring domains.
summary[].text_backlinks	Integer	No	Number of text backlinks.
summary[].dofollow_anchors	Integer	No	Number of dofollow anchors.
summary[].dofollow_backlinks	Integer	No	Number of dofollow backlinks.
summary[].domain_inlink_rank	Integer	No	Domain inlink rank.
summary[].nofollow_backlinks	Integer	No	Number of nofollow backlinks.
summary[].dofollow_refdomains	Integer	No	Number of dofollow referring domains.
summary[].pages_with_backlinks	Integer	No	Number of pages with backlinks.
summary[].top_pages_by_backlinks	Object Array	No	Top pages by backlink count.
summary[].top_pages_by_backlinks[].url	String	No	Page URL.
summary[].top_pages_by_backlinks[].backlinks	Integer	No	Backlink count for the page.
summary[].top_pages_by_refdomains	Object Array	No	Top pages by referring domain count.
summary[].top_pages_by_refdomains[].url	String	No	Page URL.
summary[].top_pages_by_refdomains[].refdomains	Integer	No	Referring domain count for the page.
summary[].from_home_page_backlinks	Integer	No	Number of backlinks from the home page.
summary[].top_anchors_by_backlinks	Object Array	No	Top anchors by backlink count.
summary[].top_anchors_by_backlinks[].anchor	String	No	Anchor text.
summary[].top_anchors_by_backlinks[].backlinks	Integer	No	Backlink count for the anchor.
summary[].from_home_page_refdomains	Integer	No	Number of referring domains from the home page.
summary[].top_anchors_by_refdomains	Object Array	No	Top anchors by referring domain count.
summary[].top_anchors_by_refdomains[].anchor	String	No	Anchor text.
summary[].top_anchors_by_refdomains[].refdomains	Integer	No	Referring domain count for the anchor.
summary[].dofollow_from_home_page_backlinks	Integer	No	Number of dofollow backlinks from the home page.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 31 / 44

POST

Get Backlink Profile Summary

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/summary

QUICKSTART

GUIDE

Quickstart

Fetch backlink summary data for a target domain or URL.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/summary?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "example.com",
    "mode": "host"
  }'

What you'll get back

Returns a JSON object with a summary array. Each item in the array is an object containing backlink metrics for a target, such as target, backlinks, refdomains, anchors, ips, subnets, and related top lists like top_tlds, top_countries, top_pages_by_backlinks, and top_anchors_by_backlinks.

{
  "summary": [
    {
      "target": "example.com",
      "backlinks": 1234,
      "refdomains": 56,
      "anchors": 78
    }
  ]
}

TRY ITLIVE · 2000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns backlink summary data for one target or a batch of targets submitted in the request body. You can also request the response format with the output query parameter.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Target interpretation mode. Allowed values: `domain`, `host`, `url`. Default: `host`.
target	String/Array	Yes	The target or targets to summarize. Accepts either a string or an array of strings.

Response

Returns a JSON object with a summary array field. Each item in summary is an object containing backlink summary metrics for a target, including target plus the numeric fields and nested arrays defined by the schema. Success response is the object defined by the output schema.

Parameter	Type	Mandatory	Description
summary	Object Array	No	Array of summary objects. Each object may contain `ips`, `target`, `anchors`, `subnets`, `top_tlds`, `backlinks`, `refdomains`, `inlink_rank`, `edu_backlinks`, `gov_backlinks`, `top_countries`, `edu_refdomains`, `gov_refdomains`, `text_backlinks`, `dofollow_anchors`, `dofollow_backlinks`, `domain_inlink_rank`, `nofollow_backlinks`, `dofollow_refdomains`, `pages_with_backlinks`, `top_pages_by_backlinks`, `top_pages_by_refdomains`, `from_home_page_backlinks`, `top_anchors_by_backlinks`, `from_home_page_refdomains`, `top_anchors_by_refdomains`, and `dofollow_from_home_page_backlinks`.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 32 / 44

GET

Get Backlink Metrics Overview

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/metrics

QUICKSTART

GUIDE

Quickstart

Look up backlink metrics for a target by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/metrics?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object that may include backlink counts and related totals for the requested target.

{
  "metrics": [
    {
      "target": "example.com",
      "backlinks": 0,
      "refdomains": 0,
      "ips": 0,
      "subnets": 0,
      "edu_backlinks": 0,
      "gov_backlinks": 0,
      "dofollow_backlinks": 0,
      "nofollow_backlinks": 0
    }
  ]
}

TRY ITLIVE · 250 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Retrieves backlink-related metrics for the specified target using query parameters. The response returns a JSON object containing a metrics array of metric objects.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Selects the target interpretation:<br>- `domain`<br>- `host`<br>- `url`<br>Default: `host`
output	ENUM	No	Response format:<br>- `json`<br>- `xml`<br>Default: `json`
target	String	Yes	The target to analyze.

Response

Returns a JSON object with a metrics array field. Each item in metrics is an object containing backlink metric fields for a target.

Parameter	Type	Mandatory	Description
metrics	Object Array	No	Array of metric objects.
metrics[].ips	Integer	No	Number of IPs associated with the target.
metrics[].target	String	No	The target value represented in this metric object.
metrics[].subnets	Integer	No	Number of subnets associated with the target.
metrics[].backlinks	Integer	No	Total number of backlinks.
metrics[].refdomains	Integer	No	Number of referring domains.
metrics[].edu_backlinks	Integer	No	Number of backlinks from `.edu` domains.
metrics[].gov_backlinks	Integer	No	Number of backlinks from `.gov` domains.
metrics[].dofollow_backlinks	Integer	No	Number of dofollow backlinks.
metrics[].nofollow_backlinks	Integer	No	Number of nofollow backlinks.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 33 / 44

POST

Get Backlink Metrics Overview

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/metrics

QUICKSTART

GUIDE

Quickstart

Look up backlink metrics for a single target and return the result as JSON.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/metrics?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object with fields like target, backlinks, refdomains, ips, subnets, edu_backlinks, gov_backlinks, dofollow_backlinks, and nofollow_backlinks.

{
  "metrics": [
    {
      "target": "example.com",
      "backlinks": 123,
      "refdomains": 45,
      "ips": 12,
      "subnets": 8,
      "edu_backlinks": 2,
      "gov_backlinks": 1,
      "dofollow_backlinks": 100,
      "nofollow_backlinks": 23
    }
  ]
}

TRY ITLIVE · 250 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns backlink metrics for one target or a batch of targets submitted in the request body. The response is a JSON object containing a metrics array with per-target backlink counts and related integer metrics.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Target interpretation mode. Allowed values: `domain`, `host`, `url`. Default: `host`.
target	String / String Array	Yes	The target to analyze. Accepts either a single string or an array of strings.

Response

Returns a JSON object with a metrics array field. Each array item is an object containing backlink metric fields for a target: ips integer, target string, subnets integer, backlinks integer, refdomains integer, edu_backlinks integer, gov_backlinks integer, dofollow_backlinks integer, and nofollow_backlinks integer. Success status code is not declared in the schema.

Parameter	Type	Mandatory	Description
metrics	Object Array	Yes	Array of metric objects, one per target. Each item includes the fields `ips`, `target`, `subnets`, `backlinks`, `refdomains`, `edu_backlinks`, `gov_backlinks`, `dofollow_backlinks`, and `nofollow_backlinks`.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 34 / 44

GET

List Backlinks (Filtered)

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/all

QUICKSTART

GUIDE

Quickstart

Fetch backlinks for a target site by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/all?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a backlinks array. Each item in the array is an object that may include fields like url_from, url_to, anchor, title, nofollow, inlink_rank, domain_inlink_rank, and date strings such as first_seen and last_visited.

{
  "backlinks": [
    {
      "url_from": "https://blog.example.com/post-1",
      "url_to": "https://example.com/",
      "anchor": "Example",
      "nofollow": false,
      "inlink_rank": 42,
      "domain_inlink_rank": 58,
      "first_seen": "2024-01-12",
      "last_visited": "2024-02-03"
    }
  ]
}

TRY ITLIVE · 250 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns a list of backlinks for the supplied target, with optional query parameters to filter, sort, and limit the results.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Allowed values: `domain`, `host`, `url`<br>Default: `host`
limit	Integer	No	Minimum: `1`<br>Maximum: `10000`<br>Default: `100`
output	ENUM	No	Allowed values: `json`, `xml`<br>Default: `json`
target	String	Yes	The target to retrieve backlinks for.
order_by	ENUM	No	Allowed values: `date_found`, `domain_inlink_rank`, `inlink_rank`<br>Default: `date_found`
per_domain	Integer	No	Minimum: `1`<br>Maximum: `100`
anchor_filter	String	No	Maximum length: `2063`
url_to_filter	String	No	Maximum length: `2063`
inlink_rank_to	Integer	No	Minimum: `0`<br>Maximum: `100`<br>Default: `100`
nofollow_filter	ENUM	No	Allowed values: `nofollow_only`, `dofollow_only`
url_from_filter	String	No	Maximum length: `2063`
inlink_rank_from	Integer	No	Minimum: `0`<br>Maximum: `100`<br>Default: `0`
anchor_filter_mode	ENUM	No	Allowed values: `contains`, `does_not_contain`<br>Default: `contains`
url_to_filter_mode	ENUM	No	Allowed values: `contains`, `does_not_contain`<br>Default: `contains`
url_from_filter_mode	ENUM	No	Allowed values: `contains`, `does_not_contain`<br>Default: `contains`
domain_inlink_rank_to	Integer	No	Minimum: `0`<br>Maximum: `100`<br>Default: `100`
domain_inlink_rank_from	Integer	No	Minimum: `0`<br>Maximum: `100`<br>Default: `0`

Response

Returns a JSON object with a backlinks array field. Each item in backlinks is an object containing backlink details such as alt, image, title, anchor, url_to, nofollow, url_from, first_seen, inlink_rank, image_source, last_visited, and domain_inlink_rank.

Parameter	Type	Mandatory	Description
backlinks	Object Array	No	Array of backlink objects. Each object may include `alt`, `image`, `title`, `anchor`, `url_to`, `nofollow`, `url_from`, `first_seen`, `inlink_rank`, `image_source`, `last_visited`, and `domain_inlink_rank`.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

limitOPTIONAL

integer

—

DEFAULT 100

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

order_byOPTIONAL

string

date_found · domain_inlink_rank · inlink_rank

—

DEFAULT date_found

per_domainOPTIONAL

integer

—

anchor_filterOPTIONAL

string

—

url_to_filterOPTIONAL

string

—

inlink_rank_toOPTIONAL

integer

—

DEFAULT 100

nofollow_filterOPTIONAL

string

nofollow_only · dofollow_only

—

url_from_filterOPTIONAL

string

—

inlink_rank_fromOPTIONAL

integer

—

DEFAULT 0

anchor_filter_modeOPTIONAL

string

contains · does_not_contain

—

DEFAULT contains

url_to_filter_modeOPTIONAL

string

contains · does_not_contain

—

DEFAULT contains

url_from_filter_modeOPTIONAL

string

contains · does_not_contain

—

DEFAULT contains

domain_inlink_rank_toOPTIONAL

integer

—

DEFAULT 100

domain_inlink_rank_fromOPTIONAL

integer

—

DEFAULT 0

▣ ENDPOINT 35 / 44

POST

List Backlinks (Filtered)

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/all

QUICKSTART

GUIDE

Quickstart

Fetch backlinks for a target URL or domain. This example uses the required target field and the default output=json.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/all?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"https://example.com"}'

What you'll get back

Returns a JSON object with a backlinks array. Each item in backlinks is an object that may include fields such as url_from, url_to, anchor, title, alt, image, nofollow, first_seen, last_visited, inlink_rank, and domain_inlink_rank.

{
  "backlinks": [
    {
      "url_from": "https://blog.example.org/post",
      "url_to": "https://example.com",
      "anchor": "Example site",
      "nofollow": false,
      "first_seen": "2024-01-15",
      "inlink_rank": 42
    }
  ]
}

TRY ITLIVE · 250 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Retrieves a list of backlinks for the specified target and returns them in a JSON object with a backlinks array. You can control the lookup mode, result limit, ordering, and backlinks per domain through the request body, and choose the response format with the output query parameter.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format.<br>Allowed values: `json`, `xml`.<br>Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Lookup scope.<br>Allowed values: `domain`, `host`, `url`.<br>Default: `host`.
limit	Integer	No	Maximum number of backlinks to return.<br>Minimum: 1.<br>Maximum: 10000.
target	String	Yes	The target to list backlinks for.
order_by	ENUM	No	Sort order for the returned backlinks.<br>Allowed values: `date_found`, `domain_inlink_rank`, `inlink_rank`.
per_domain	Integer	No	Maximum number of backlinks to return per domain.<br>Minimum: 1.<br>Maximum: 100.

Response

Returns a JSON object with a backlinks array field. Each array item is an object with backlink details including alt, image, title, anchor, url_to, nofollow, url_from, first_seen, inlink_rank, image_source, last_visited, and domain_inlink_rank.

Parameter	Type	Mandatory	Description
backlinks	Object Array	Yes	Array of backlink objects.
backlinks[].alt	String	No	Alternative text associated with the backlink, if present.
backlinks[].image	Boolean	No	Indicates whether the backlink is an image link.
backlinks[].title	String	No	Title associated with the backlink, if present.
backlinks[].anchor	String	No	Anchor text for the backlink, if present.
backlinks[].url_to	String	No	Destination URL for the backlink.
backlinks[].nofollow	Boolean	No	Indicates whether the backlink is marked as nofollow.
backlinks[].url_from	String	No	Source URL of the backlink.
backlinks[].first_seen	String	No	Date the backlink was first seen. Format: `date`.
backlinks[].inlink_rank	Integer	No	Inlink rank value for the backlink.
backlinks[].image_source	String	No	Source associated with the backlink image, if present.
backlinks[].last_visited	String	No	Date the backlink was last visited. Format: `date`.
backlinks[].domain_inlink_rank	Integer	No	Domain inlink rank value for the backlink.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 36 / 44

GET

Count Total Backlinks

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/count

QUICKSTART

GUIDE

Quickstart

Fetch the backlink count for a target by passing it as a query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/count?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object with a target string and a backlinks integer.

{
  "metrics": [
    {
      "target": "example.com",
      "backlinks": 1234
    }
  ]
}

TRY ITLIVE · 500 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the total backlinks count for the specified target, with optional query controls for how the target is interpreted and the response format.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	How to interpret the target.<br>- `domain`<br>- `host`<br>- `url`<br>Default: `host`
output	ENUM	No	Response format.<br>- `json`<br>- `xml`<br>Default: `json`
target	String	Yes	The target whose backlinks count will be returned.

Response

Returns a JSON object with a metrics array field. Each item in metrics is an object with a target string field and a backlinks integer field.

Parameter	Type	Mandatory	Description
metrics	Object Array	No	A list of backlink count results. Each item contains `target` and `backlinks`.
metrics[].target	String	No	The target value associated with the count.
metrics[].backlinks	Integer	No	The backlinks count for that target.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 37 / 44

POST

Count Total Backlinks

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/count

QUICKSTART

GUIDE

Quickstart

Count backlinks for a single target by posting its target in JSON, with the result format set in the query string.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/count?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object with a target string and a backlinks integer.

{
  "metrics": [
    {
      "target": "example.com",
      "backlinks": 42
    }
  ]
}

TRY ITLIVE · 500 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Counts the total number of backlinks for the target you submit in the request body. You can also choose the mode used to interpret the target.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	How the target is interpreted. Allowed values: `domain`, `host`, `url`. Default: `host`.
target	String Array	Yes	The target to analyze. Can be either a single string or an array of strings.

Response

Returns a JSON object with a metrics array field. Each item in metrics is an object containing a target string and a backlinks integer.

Parameter	Type	Mandatory	Description
metrics	Object Array	No	Array of metric objects. Each item includes:<br>- `target`: the target string<br>- `backlinks`: the backlink count as an integer

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 38 / 44

GET

List New/Lost Backlinks

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history

QUICKSTART

GUIDE

Quickstart

Fetch backlink history for a target host, domain, or URL using the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a new_lost_backlinks array field. Each item in the array is an object describing a backlink history record, with fields such as url_from, url_to, new_lost_date, new_lost_type, and related backlink metadata.

{
  "new_lost_backlinks": [
    {
      "url_from": "https://example.com/article",
      "url_to": "https://targetsite.com/page",
      "new_lost_date": "2024-01-15",
      "new_lost_type": "new"
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns a list of new and lost backlinks for the specified target, with optional filters for backlink type, date range, mode, and other backlink attributes.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Target matching mode.<br>- `domain`<br>- `host`<br>- `url`<br>Default: `host`
limit	Integer	No	Maximum number of results to return.<br>Minimum: `1`<br>Maximum: `10000`<br>Default: `100`
output	ENUM	No	Response format.<br>- `json`<br>- `xml`<br>Default: `json`
target	String	Yes	The target to analyze.
date_to	String	No	End of the date range. Format: `date`.
dofollow	ENUM	No	Filter by link follow type.<br>- `dofollow`<br>- `nofollow`<br>- `undefined`
order_by	ENUM	No	Sort order for results.<br>- `new_lost_date`<br>- `domain_inlink_rank`<br>- `inlink_rank`<br>Default: `new_lost_date`
url_from	String	No	Filter by source URL.
date_from	String	No	Start of the date range. Format: `date`.
link_type	ENUM	No	Filter by link type.<br>- `href`<br>- `redirect`
anchor_type	ENUM	No	Filter by anchor type.<br>- `text`<br>- `image`<br>- `undefined`
new_lost_type	ENUM	No	Filter by backlink change type.<br>- `new`<br>- `lost`

Response

Returns a JSON object with a new_lost_backlinks array field. Each array item is an object representing a backlink record with fields such as url_from, url_to, new_lost_type, and related metadata defined in the schema.

Parameter	Type	Mandatory	Description
new_lost_backlinks	Object Array	No	Array of backlink records. Each item includes the fields defined below.
new_lost_backlinks[].alt	String	No	Image alt text. Nullable.
new_lost_backlinks[].image	Boolean	No	Indicates whether the backlink is an image link.
new_lost_backlinks[].title	String	No	Title associated with the backlink.
new_lost_backlinks[].anchor	String	No	Anchor text or anchor value.
new_lost_backlinks[].url_to	String	No	Target URL of the backlink.
new_lost_backlinks[].nofollow	Boolean	No	Indicates whether the backlink is nofollow.
new_lost_backlinks[].url_from	String	No	Source URL of the backlink.
new_lost_backlinks[].link_type	ENUM	No	Link type.<br>- `href`<br>- `redirect`
new_lost_backlinks[].first_seen	String	No	First seen date. Format: `date`.
new_lost_backlinks[].inlink_rank	Integer	No	Inlink rank value.
new_lost_backlinks[].reason_lost	ENUM	No	Reason the backlink was lost. Nullable.<br>- `page_not_found`<br>- `crawl_error`<br>- `page_dropped`<br>- `redirect`<br>- `not_canonical`<br>- `noindex`<br>- `link_removed`<br>- `broken_redirect`<br>- `other`
new_lost_backlinks[].image_source	String	No	Source for the image backlink. Nullable.
new_lost_backlinks[].new_lost_date	String	No	Date the backlink was marked new or lost. Format: `date`.
new_lost_backlinks[].new_lost_type	ENUM	No	Backlink change type.<br>- `new`<br>- `lost`
new_lost_backlinks[].redirect_chain	Boolean	No	Indicates whether the backlink uses a redirect chain.
new_lost_backlinks[].domain_inlink_rank	Integer	No	Domain inlink rank value.
new_lost_backlinks[].redirect_chain_urls	String Array	No	URLs in the redirect chain.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

limitOPTIONAL

integer

—

DEFAULT 100

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

date_toOPTIONAL

string

—

dofollowOPTIONAL

string

dofollow · nofollow · undefined

—

order_byOPTIONAL

string

new_lost_date · domain_inlink_rank · inlink_rank

—

DEFAULT new_lost_date

url_fromOPTIONAL

string

—

date_fromOPTIONAL

string

—

link_typeOPTIONAL

string

href · redirect

—

anchor_typeOPTIONAL

string

text · image · undefined

—

new_lost_typeOPTIONAL

string

new · lost

—

▣ ENDPOINT 39 / 44

POST

List New/Lost Backlinks

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history

QUICKSTART

GUIDE

Quickstart

Fetch backlink history for a target site or URL.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target":"https://example.com","mode":"url"}'

What you'll get back

Returns a JSON object with a new_lost_backlinks array. Each item in the array is an object describing one backlink record, with fields such as url_from, url_to, anchor, first_seen, new_lost_date, new_lost_type, and other backlink metadata.

{
  "new_lost_backlinks": [
    {
      "url_from": "https://example.com/page-a",
      "url_to": "https://example.com",
      "anchor": "Example",
      "first_seen": "2024-01-01",
      "new_lost_date": "2024-01-15",
      "new_lost_type": "new"
    }
  ]
}

TRY ITLIVE · 200 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns a list of new and lost backlinks for the target you submit in the request body. You can scope the target as a domain, host, or URL and optionally limit the date range; the response is a JSON object containing a new_lost_backlinks array.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Scope of the target. Allowed values: `domain`, `host`, `url`.
target	String	Yes	The target to inspect.
date_from	String	No	Start date in `date` format (`YYYY-MM-DD`).
date_to	String	No	End date in `date` format (`YYYY-MM-DD`).

Response

Returns a JSON object with a new_lost_backlinks array field. Each array item is an object describing one backlink entry, including backlink URLs, link metadata, dates, ranking fields, and optional loss reasons.

Parameter	Type	Mandatory	Description
new_lost_backlinks	Object Array	Yes	Array of backlink history entries. Each item includes the fields below.
new_lost_backlinks[].alt	String	No	Alternate text. Nullable.
new_lost_backlinks[].image	Boolean	No	Indicates whether the backlink is an image link.
new_lost_backlinks[].title	String	No	Title of the backlink entry.
new_lost_backlinks[].anchor	String	No	Anchor text.
new_lost_backlinks[].url_to	String	No	Destination URL.
new_lost_backlinks[].nofollow	Boolean	No	Indicates whether the link is nofollow.
new_lost_backlinks[].url_from	String	No	Source URL.
new_lost_backlinks[].link_type	ENUM	No	Link type. Allowed values: `href`, `redirect`.
new_lost_backlinks[].first_seen	String	No	First seen date in `date` format (`YYYY-MM-DD`).
new_lost_backlinks[].inlink_rank	Integer	No	Inlink rank.
new_lost_backlinks[].reason_lost	ENUM	No	Reason the backlink was lost. Nullable. Allowed values: `page_not_found`, `crawl_error`, `page_dropped`, `redirect`, `not_canonical`, `noindex`, `link_removed`, `broken_redirect`, `other`.
new_lost_backlinks[].image_source	String	No	Image source. Nullable.
new_lost_backlinks[].new_lost_date	String	No	Date when the backlink became new or lost, in `date` format (`YYYY-MM-DD`).
new_lost_backlinks[].new_lost_type	ENUM	No	Type of backlink history entry. Allowed values: `new`, `lost`.
new_lost_backlinks[].redirect_chain	Boolean	No	Indicates whether a redirect chain exists.
new_lost_backlinks[].domain_inlink_rank	Integer	No	Domain inlink rank.
new_lost_backlinks[].redirect_chain_urls	String Array	No	URLs in the redirect chain.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 40 / 44

GET

Get Page Authority History

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/page/history

QUICKSTART

GUIDE

Quickstart

Get backlink authority history for a target URL or domain by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/authority/page/history?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a history array. Each item in history is an object with a date string and an inlink_rank integer.

{
  "history": [
    {
      "date": "2024-01-01",
      "inlink_rank": 42
    }
  ]
}

TRY ITLIVE · 500 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Gets the page authority history for a target URL or domain over a requested date range. The response returns a JSON object containing a history array of dated inlink_rank values.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.
target	String	Yes	The target to look up.
date_to	String	No	End date in `date` format.
date_from	String	No	Start date in `date` format.
granularity	String	No	Granularity of the history points. Example: `by_week`.

Response

Returns a JSON object with a history array field. Each item in history is an object with a date string field in date format and an inlink_rank integer field.

Parameter	Type	Mandatory	Description
history	Object Array	No	Array of history entries.
history[].date	String	No	Date of the history point in `date` format.
history[].inlink_rank	Integer	No	Page authority value for that date.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

date_toOPTIONAL

string

—

date_fromOPTIONAL

string

—

granularityOPTIONAL

string

—

▣ ENDPOINT 41 / 44

GET

Get New/Lost Backlinks — Daily Counts

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history/count

QUICKSTART

GUIDE

Quickstart

Fetch backlink history counts for a target by passing the required target query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history/count?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a new_lost_backlinks_count array. Each array item is an object that may include new and lost integers plus a date string in YYYY-MM-DD format.

{
  "new_lost_backlinks_count": [
    {
      "date": "2024-01-01",
      "new": 12,
      "lost": 3
    }
  ]
}

TRY ITLIVE · 1000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns daily counts of new and lost backlinks for the specified target. The endpoint accepts query parameters to filter the history by target, date range, link attributes, and output format.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Allowed values: `domain`, `host`, `url`.<br>Default: `host`.
output	ENUM	No	Allowed values: `json`, `xml`.<br>Default: `json`.
target	String	Yes	The target to retrieve backlink history counts for.
date_to	String	No	End date in `date` format (`YYYY-MM-DD`).
dofollow	ENUM	No	Allowed values: `dofollow`, `nofollow`, `undefined`.
url_from	String	No	Source URL to filter by.
date_from	String	No	Start date in `date` format (`YYYY-MM-DD`).
link_type	ENUM	No	Allowed values: `href`, `redirect`.
anchor_type	ENUM	No	Allowed values: `text`, `image`, `undefined`.
new_lost_type	ENUM	No	Allowed values: `new`, `lost`.

Response

Returns a JSON object with a new_lost_backlinks_count array field. Each array item is an object with new integer, date string, and lost integer fields.

Parameter	Type	Mandatory	Description
new_lost_backlinks_count	Object Array	No	Array of daily backlink count objects.
new_lost_backlinks_count[].new	Integer	No	Number of new backlinks for the date.
new_lost_backlinks_count[].date	String	No	Date in `date` format (`YYYY-MM-DD`).
new_lost_backlinks_count[].lost	Integer	No	Number of lost backlinks for the date.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

date_toOPTIONAL

string

—

dofollowOPTIONAL

string

dofollow · nofollow · undefined

—

url_fromOPTIONAL

string

—

date_fromOPTIONAL

string

—

link_typeOPTIONAL

string

href · redirect

—

anchor_typeOPTIONAL

string

text · image · undefined

—

new_lost_typeOPTIONAL

string

new · lost

—

▣ ENDPOINT 42 / 44

POST

Get New/Lost Backlinks — Daily Counts

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history/count

QUICKSTART

GUIDE

Quickstart

Get backlink history counts for a target domain, host, or URL.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/history/count?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "example.com"
  }'

What you'll get back

Returns a JSON object with a new_lost_backlinks_count array. Each array item is an object with new (integer), date (string date), and lost (integer).

{
  "new_lost_backlinks_count": [
    {
      "new": 12,
      "date": "2024-01-01",
      "lost": 3
    }
  ]
}

TRY ITLIVE · 1000 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns a JSON object containing new_lost_backlinks_count, an array of daily backlink count records. Each record includes the date plus integer counts for new and lost backlinks.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	ENUM	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Scope of the lookup. Allowed values: `domain`, `host`, `url`.
target	String	Yes	Target to analyze.
date_from	String	No	Start date in `date` format (`YYYY-MM-DD`).
date_to	String	No	End date in `date` format (`YYYY-MM-DD`).

Response

Returns a JSON object with a new_lost_backlinks_count array field. Each array item is an object with new and lost integer fields, and a date string field in date format (YYYY-MM-DD).

Parameter	Type	Mandatory	Description
new_lost_backlinks_count	Object Array	No	Daily backlink count records.
new_lost_backlinks_count[].new	Integer	No	Number of new backlinks for the day.
new_lost_backlinks_count[].date	String	No	Date for the record in `date` format (`YYYY-MM-DD`).
new_lost_backlinks_count[].lost	Integer	No	Number of lost backlinks for the day.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ ENDPOINT 43 / 44

GET

Count Referring IPs

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-ips/count

QUICKSTART

GUIDE

Quickstart

Check the number of referring IPs for a target by passing it as a query parameter.

curl -X GET "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-ips/count?target=example.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object with a target string and a referring_ips integer.

{
  "metrics": [
    {
      "target": "example.com",
      "referring_ips": 42
    }
  ]
}

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the total referring IPs count for the specified target. The request accepts the target and optional query parameters to control the target mode and response format.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Target interpretation mode.<br>- `domain`<br>- `host` (default)<br>- `url`
output	ENUM	No	Response format.<br>- `json` (default)<br>- `xml`
target	String	Yes	The target to analyze.

Response

Returns a JSON object with a metrics array field. Each item in metrics is an object containing a target string and a referring_ips integer.

Parameter	Type	Mandatory	Description
metrics	Object Array	No	Array of metric objects.
metrics[].target	String	No	The target associated with the metric.
metrics[].referring_ips	Integer	No	The total referring IPs count for the target.

Query parameters

Name

Type

Description

modeOPTIONAL

string

domain · host · url

—

DEFAULT host

outputOPTIONAL

string

json · xml

—

DEFAULT json

targetREQUIRED

string

—

▣ ENDPOINT 44 / 44

POST

Count Referring IPs

https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-ips/count

QUICKSTART

GUIDE

Quickstart

Count the referring IPs for one target by sending its mode and target in a JSON body.

curl -X POST "https://api.eu.apyhub.com/se-ranking/backlinks/v1/backlinks/referring-ips/count?output=json" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mode":"domain","target":"example.com"}'

What you'll get back

Returns a JSON object with a metrics array. Each item in metrics is an object with a target string and a referring_ips integer.

{
  "metrics": [
    {
      "target": "example.com",
      "referring_ips": 42
    }
  ]
}

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns referring IP count metrics for the supplied target in the request body. The response is a JSON object containing a metrics array, where each item includes the target and its referring_ips count.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Response format. Allowed values: `json`, `xml`. Default: `json`.

Request Body

Parameter	Type	Mandatory	Description
mode	ENUM	No	Mode for interpreting the target. Allowed values: `domain`, `host`, `url`.
target	String Array	Yes	Target value(s) to analyze. The schema allows either a single string or an array of strings.

Response

Returns a JSON object with a metrics array field. Each array item is an object with a target string field and a referring_ips integer field.

Parameter	Type	Mandatory	Description
metrics	Object Array	No	Collection of referring IP metrics returned by the endpoint.
metrics[].target	String	No	Target associated with the metric.
metrics[].referring_ips	Integer	No	Total number of referring IPs for the target.

Query parameters

Name

Type

Description

outputOPTIONAL

string

json · xml

—

DEFAULT json

Body

Name

Type

Description

bodyOPTIONAL

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.