Linking Root Domains

In this guide you’ll learn more about making API calls to the Linking Root Domains endpoint for the Links API V2.

Use this endpoint to get linking root domains to a target.

This documentation specifies information for Moz Links API V2. V1 of the Links API does not include a Linking Root Domains endpoint.

Quick Links

• Getting Started
• Endpoint Location
• Request Syntax
• Example JSON Request
• Request Parameters
• Parameter Compatibility
• Response Syntax
• Example JSON Response
• Response Elements
• Limits
• Errors
• Example HTTP Request
• Example cURL Request
• Example Python Request

Before making calls to the Linking Root Domains endpoint, be sure you are set up with an Access ID and Secret Key within your Moz Account.

Just a reminder - the Links API V2 supports Basic Auth in which you are able to use your Access ID as a username and and your Secret Key as a password.

All requests and responses are structured in JSON.

• Learn more about how to get a key
• Learn more about Moz Links API authentication

When requesting linking root domains data from Links V2, be sure to use the following endpoint.

"target" - A URL to get linking root domains for.

• Type: string
• Required: yes

"target_scope" - Find links to 'target' at this scope. The default value is 'page'.

• Type: string
• Required: no
• Valid Values: page, subdomain, root_domain

"sort" - The order to return linking root domains in. The default value is 'source_domain_authority'. Results are returned in descending order (higher values first). For date sorts, more recent results are returned first.

• Type: string
• Required: no
• Valid Values: See the Parameter Compatibility section below.

"filter" - Only return linking root domains that match this filter. The default value is 'external'. Multiple filters can be combined into an expression using the '+' symbol (for example, 'external+follow'). Positive filters require at least one matching link from the source root domain, and negative filters require all links to match -- for example, the 'follow' filter requires at least one followed link from the source domain to the target, but the 'nofollow' filter requires all links from the source domain to the target to be nofollow links.

• Type: string
• Required: no
• Valid Values: See the Parameter Compatibility section below.

"begin_date" - This parameter can only be used when 'sort' is 'date_gained' or 'date_lost', and restricts results to only those gained or lost on or after this date. Values must be in YYYY-MM-DD form.

• Type: string
• Required: no

"end_date" - This parameter can only be used when 'sort' is 'date_gained' or 'date_lost', and restricts results to only those gained or lost on or before this date. Values must be in YYYY-MM-DD form.

• Type: string
• Required: no

"limit" - Only return up to this number of results. The default value is 25.

• Type: number
• Required: no
• Valid Values: 1-50

"next_token" - If set, return the next set of results from a previous request whose 'next_token' element equals this value.

• Type: string
• Required: no

The following combinations of request parameters are valid:

"results" - An array of linking root domains to 'target'.

• Type: Array of Map objects
• Within “results” the following response elements exist:
  • "root_domain" - The source root domain for this result.
    • Type: string
  • "root_domains_to_root_domain" - The number of unique root domains currently linking to the source root domain.
    • Type: number
  • "domain_authority" - A score from 1 to 100 representing the likelihood that the source root domain will rank well in search engine result pages.
    • Type: number
  • "link_propensity" - A score from 0 to 1 indicating the likelihood of the source root domain to link out to other root domains. This is currently calculated as the ratio of 'root_domains_from_root_domain' to 'pages_crawled_from_root_domain'.
    • Type: number
  • "spam_score" - The spam score for the source root domain, or -1 if a spam score does not exist for that root domain.
    • Type: number
  • "to_target" - A map of link counts from the source root domain to the target.
    • Type: Map object
    • Within “to_target” the following response elements exist:
      • "pages" - The number of pages on the source root domain currently linking to the target.
        • Type: number
      • "nofollow_pages" - The number of pages on the source root domain currently linking to the target with only nofollow links.
        • Type: number
      • "redirect_pages" - The number of pages on the source root domain currently redirecting to the target.
        • Type: number
      • "deleted_pages" - The number of pages on the source root domain that used to link to the target, but no longer do.
        • Type: number
      • "date_gained" - The date the source root domain started linking to the target, in 'YYYY-MM-DD' format.
        • Type: string
      • "date_lost" - The date the source root domain stopped linking to the target, in 'YYYY-MM-DD' format.
        • Type: string

"next_token" - If non-empty, the number of results was limited by the 'limit' parameter, and the next set of results can be obtained by repeating the request with the 'next_token' request parameter set to this value.

• Type: string

• When sort is 'source_domain_authority' and no filter is in effect, there are no limits (i.e. it's possible to iterate through all linking root domains to a target).
• Otherwise, at most 10,000 linking root domains are returned.

See the Common Errors section for errors that are common to all endpoints.