# Referring Networks

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/backlinks/referring_networks/live`

**Tags:** DataForSEO

Collapses referring domains to the networks behind them - one row per `network_address` with `referring_domains` plus `rank`, `backlinks`, `first_seen`, `lost_date`, `backlinks_spam_score`, `broken_backlinks` and `broken_pages`. `network_address_type` chooses IP or subnet. This is the level at which link schemes become visible: many domains on one subnet is one operator, not many endorsements. The un-collapsed view is `post_dataforseo_backlinks_referring_domains_live`.

### Pricing reference

- Metering: Reported response cost.
- Reference request estimate: USD 0.0276.
- Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "target": {
            "type": "string",
            "description": "<em>domain, subdomain or webpage to get referring networks for</em><br><strong>required field</strong><br>a domain or a subdomain should be specified without <code>https://</code> and <code>www.</code><br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)"
          },
          "network_address_type": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>indicates the type of network to get data for</em><br>optional field<br>possible values: <code>ip</code>, <code>subnet</code><br>default value: <code>ip</code>"
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>the maximum number of returned networks</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>"
          },
          "offset": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>offset in the results array of returned networks</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages"
          },
          "internal_list_limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>referring_links_tld</code><br><code>referring_links_types</code><br><code>referring_links_attributes</code><br><code>referring_links_platform_types</code><br><code>referring_links_semantic_locations</code><p>default value: <code>10</code><br>maximum value: <code>1000</code>"
          },
          "backlinks_status_type": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>set what backlinks to return and count</em><br>optional field<br>you can use this field to choose what backlinks will be returned and used for aggregated metrics for your <code>target</code>;<br>possible values: <br><code>all</code> - all backlinks will be returned and counted;<br><code>live</code> - backlinks found during the last check will be returned and counted;<br><code>lost</code> - lost backlinks will be returned and counted;<p>default value: <code>live</code>"
          },
          "filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ]
            },
            "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code>, <code>ilike</code>, <code>not_ilike</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"referring_pages\",\"&gt;\",\"1\"]</code><p><code>[[\"referring_pages\",\"&gt;\",\"2\"],<br>\"and\",<br>[\"backlinks\",\"&gt;\",\"10\"]]</code><p><code>[[\"first_seen\",\">\",\"2017-10-23 11:31:45 +00:00\"],<br>\"and\",<br>[[\"network_address\",\"like\",\"194.1.%\"],\"or\",[\"referring_ips\",\"&gt;\",\"10\"]]]</code><p>The full list of possible filters is available <a href=\"/v3/backlinks/filters/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">here.</a>"
          },
          "order_by": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>[\"backlinks,desc\"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"backlinks,desc\",\"rank,asc\"]</code>"
          },
          "backlinks_filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ]
            },
            "description": "<em>filter the backlinks of your <code>target</code></em><br>optional field<br>you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your <code>target</code><br>you can filter the backlinks by all fields available in the response of <a href=\"/v3/backlinks/backlinks/live\">this endpoint</a><br>using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for<br>example:<br><code>\"backlinks_filters\": [[\"dofollow\", \"=\", true]]</code>"
          },
          "include_subdomains": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>indicates if the subdomains of the <code>target</code> will be included in the search</em><br>optional field<br>if set to <code>false</code>, the subdomains will be ignored<br>default value: <code>true</code>"
          },
          "include_indirect_links": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>indicates if indirect links to the <code>target</code> will be included in the results</em><br>optional field<br>if set to <code>true</code>, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page<br>if set to <code>false</code>, indirect links will be ignored<br>default value: <code>true</code>"
          },
          "exclude_internal_backlinks": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>indicates whether the backlinks from subdomains of the <code>target</code> are excluded</em><br>optional field<br>if set to <code>false</code>, the backlinks from subdomains of the <code>target</code> will be ommited and you won't receive the same domain in the response;<br>default value: <code>true</code>"
          },
          "rank_scale": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>defines the scale used for calculating and displaying the <code>rank</code>, <code>domain_from_rank</code>, and <code>page_from_rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works and how ranking metrics are calculated in <a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale\">this Help Center article</a>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response"
          }
        },
        "example": [
          {
            "target": "backlinko.com",
            "network_address_type": "subnet",
            "limit": 5,
            "order_by": [
              "rank,desc"
            ],
            "exclude_internal_backlinks": true,
            "backlinks_filters": [
              "dofollow",
              "=",
              true
            ],
            "filters": [
              "backlinks",
              ">",
              100
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "backlinko.com",
      "network_address_type": "subnet",
      "limit": 5,
      "order_by": [
        "rank,desc"
      ],
      "exclude_internal_backlinks": true,
      "backlinks_filters": [
        "dofollow",
        "=",
        true
      ],
      "filters": [
        "backlinks",
        ">",
        100
      ]
    }
  ]
}
```

## Responses

### 200 — Successful operation

Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksReferringNetworksLiveResponseInfo"
    }
  ]
}
```

### 400 — The request could not be processed. Check the request parameters.

### 401 — A valid Felo API key is required.

### 402 — The request cannot proceed because a billing requirement is not met.

### 403 — The account is not permitted to perform this operation.

### 429 — A request or spending limit has been reached.

### 502 — The service could not complete the request.

### 503 — The API or billing service is temporarily unavailable.

### 504 — The service timed out while processing the request.

### default — Error response; upstream passthrough responses may use provider formats

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BacklinksReferringNetworksLiveItem

`#/components/schemas/Response36Afe1097B20_BacklinksReferringNetworksLiveItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "type of element"
    },
    "network_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>address of the referring subnetwork or IP</em>"
    },
    "rank": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>network rank</em><br>rank volume that a referring network passes to the <code>target</code><br><code>rank</code> is calculated based on the method for node ranking in a linked database - a principle used in the original Google PageRank algorithm<br>learn more about the metric and how it is calculated in <a href=\"https://dataforseo.com/help-center/what_is_rank_in_backlinks_api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article</a>"
    },
    "backlinks": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>indicates the number of backlinks pointing to the <code>target</code></em>",
      "format": "int64"
    },
    "first_seen": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>date and time when our crawler found the backlink for the first time</em><br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2019-11-15 12:57:46 +00:00</code>"
    },
    "lost_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>date and time when the last backlink from this domain was lost</em><br>indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed<br>in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”<br>example:<br><code>2017-01-24 13:20:59 +00:00</code>"
    },
    "broken_backlinks": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of broken backlinks</em><br>number of broken backlinks pointing to the domain",
      "format": "int64"
    },
    "broken_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of broken pages</em><br>number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to"
    },
    "referring_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>indicates the number of referring domains</em><br>referring domains include subdomains that are counted as separate domains for this metric",
      "format": "int64"
    },
    "referring_domains_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of domains pointing at least one nofollow link to the <code>target</code></em>",
      "format": "int64"
    },
    "referring_main_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>indicates the number of referring main domains</em>",
      "format": "int64"
    },
    "referring_main_domains_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of main domains pointing at least one nofollow link to the <code>target</code></em>",
      "format": "int64"
    },
    "referring_ips": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of referring IP addresses</em><br>number of IP addresses pointing to this page",
      "format": "int64"
    },
    "referring_subnets": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of referring subnetworks</em>",
      "format": "int64"
    },
    "referring_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>indicates the number of pages pointing to the <code>target</code> specified</em>",
      "format": "int64"
    },
    "referring_pages_nofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of referring pages pointing at least one nofollow link to the <code>target</code></em>",
      "format": "int64"
    },
    "referring_links_tld": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>top-level domains of the referring links</em><br>contains top level domains and referring link count per each"
    },
    "referring_links_types": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>types of referring links</em><br>indicates the types of the referring links and link count per each type<br>possible values:<br><code>anchor</code>, <code>image</code>, <code>link</code>, <code>meta</code>, <code>canonical</code>, <code>alternate</code>, <code>redirect</code>"
    },
    "referring_links_attributes": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>link attributes of the referring links</em><br>indicates link attributes of the referring links and link count per each attribute"
    },
    "referring_links_platform_types": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>types of referring platforms</em><br>indicates referring platform types and and link count per each platform<p>possible values: <code>cms</code>, <code>blogs</code>, <code>ecommerce</code>, <code>message-boards</code>, <code>wikis</code>, <code>news</code>, <code>organization</code>"
    },
    "referring_links_semantic_locations": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>semantic locations of the referring links</em><br>indicates semantic elements in HTML where the referring links are located and the link count per each semantic location<p>you can get the full list of semantic elements <a href=\"https://www.w3schools.com/html/html5_semantic_elements.asp\" target=\"_blank\" rel=\"noopener noreferrer\">here</a><br>examples:<br><code>article</code>, <code>section</code>, <code>summary</code>"
    },
    "referring_links_countries": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>ISO country codes of the referring links</em><br>indicates ISO country codes of the domains where the referring links are located and the link count per each country"
    }
  }
}
```

### Response36Afe1097B20_BacklinksReferringNetworksLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_BacklinksReferringNetworksLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksReferringNetworksLiveTaskInfo"
              }
            ]
          },
          "description": "<em>array of tasks</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_BacklinksReferringNetworksLiveResultInfo

`#/components/schemas/Response36Afe1097B20_BacklinksReferringNetworksLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em><code>target</code> in a POST array</em>"
    },
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>total number of relevant items in the database</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of items in the <code>items</code> array</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksReferringNetworksLiveItem"
          }
        ]
      },
      "description": "<em>items array</em>"
    }
  }
}
```

### Response36Afe1097B20_BacklinksReferringNetworksLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_BacklinksReferringNetworksLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksReferringNetworksLiveResultInfo"
              }
            ]
          },
          "description": "<em>array of results</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "the current version of the API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "general status code\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "general informational message\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "total execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array returned with an error",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "task identifier\nunique task identifier in our system in the UUID format"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "informational message of the task\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "number of elements in the result array",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL path"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "contains the same parameters that you specified in the POST request"
    }
  }
}
```