Search our Knowledge Base
Search

Get Link Info API



The get_link_info method provides link from/to URLs, anchor text, tracking status, last checked date, ip address, number of internal and external links, supplier ID and name, and ID and name of the person managing the link campaign, plus optional social metrics and backlink details. 

Refer to Rank Ranger API Overview page for information on how to obtain API access, obtain an API Key, a full list of API methods and error codes.


 
 

Parameters

 
 
key string The unique API key assigned to your account
link_id int Link ID is used to retrieve the default data for one specific link
link_from string Enter full URL of the Link From a specific page to retrieve all link data matching that URL
link_domain string Domain allows you to specify the Link To domain and retrieve data for all links matching it
inc_profile string Include Link Profile Name in results (optional add-on to other parameters)
inc_social string Include a variety of social signals for the Link From URL: Delicious, Facebook, Google +, LinkedIn, Pinterest, Reddit, Stumbleupon & Twitter data (optional add-on to other parameters)
inc_backlinks string Include Majestic and Moz backlink metrics for the Link From URL (optional add-on to other parameters)
link_ip string Retrieve results only for a specific IP Address
Class C block of IPs is available by adding an *(asterisk) to the end of the IP address. Using this will return link data for all IP addresses with matching Class C (e.g., in IP address 111.222.333.444, "333" is the C-Class section) instead of the single IP address in the request.


Example

 
Link ID Option with Link Profile added
https://www.rankranger.com/api/tracking/?get_link_info&key=YOURAPIKEY&link_id=123&inc_profile=true

Link From Option
https://www.rankranger.com/api/v2/?get_link_info&key=YOURAPIKEY&link_from=http://www.example-domain.com/?p=224

Link Domain Option
https://www.rankranger.com/api/v2/?get_link_info&key=YOURAPIKEY&link_domain=example-domain.com

Link Social Signals Option
https://www.rankranger.com/api/v2/?get_link_info&key=YOURAPIKEY&link_id=123&inc_social=true

Link Backlink Metrics Option
https://www.rankranger.com/api/v2/?get_link_info&key=YOURAPIKEY&link_id=123&inc_backlinks=true

Link Social Signals and Backlink Metrics together
https://www.rankranger.com/api/v2/?get_link_info&key=YOURAPIKEY&link_id=123&inc_social=true&inc_backlinks=true

Link IP Option
https://www.rankranger.com/api/v2/?get_link_info&key=YOURAPIKEY&link_ip=255.255.255.255
(note: using this example, the results will include all the links that have an IP address that explicitly equals 255.255.255.255)

Link IP Option with Class C block of IPs
https://www.rankranger.com/api/v2/?get_link_info&key=YOURAPIKEY&link_ip=255.255.255.*
(note: using this example, the results will include all the links that are in the Class C range including
255.255.255.1, 255.255.255.2, 255.255.255.3, ... 255.255.255.254, 255.255.255.255)

The default output format is XML, if you want JSON simply add "&output=json" to the end of the string.


Response

 
In this example we'll see the following response
https://www.rankranger.com/api/v2/?get_link_info&key=YOURAPIKEY&link_id=238&inc_profile=true&inc_social=true&inc_backlinks=true

<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/12/2016" time="18:56:01" status="ok" >
<links>
  <link>
      
<link_id>16238</link_id>
      <creation_date>11/30/2015</creation_date>
      <page_rank>3</page_rank>
      <link_from>http://example-domain.com/?p=224</link_from>
      <link_to>
http://www.your-domain.com/promo2015</link_to>
      <anchor_text>
Keyword Text Example</anchor_text>
  
   <tracking_status>Valid Link</tracking_status>
      <last_checked>
02/12/2016</last_checked>
      <ip_address>
192.111.111.11</ip_address>
      <internal_links>7</internal_links>
      <external_links>18</external_links>
      <link_price>25</link_price>
      <link_currency>
USD</link_currency>
      <link_type>
Paid</link_type>
      <link_position>Content</link_position>
      <link_start_date>11/15/2015</link_start_date>
      <link_expiration_date>03/15/2016</link_expiration_date>
      <invoice_number>12436</invoice_number>
  <supplier>
      <supplier_id>
18</supplier_id>
      <supplier_name>
ABC Supplier</supplier_name>
  </supplier>
  <manager>
      <manager_id>
3</manager_id>
      <manager_name>
Sarah</manager_name>
   </manager>
      <profile>
SEO Examples</profile>
  <social_metrics>
      
<google_plus>38</google_plus>
      <twitter>
224</twitter>
      <facebook_total_count>
2015</facebook_total_count>
      <facebook_like_count>1900</facebook_like_count>
      <facebook_share_count>100</facebook_share_count>
      <facebook_comment_count>15</facebook_comment_count>
      <facebook_click_count>329</facebook_click_count>
      <linkedin>7</linkedin>
      <pinterest>0</pinterest>
      <stumbleupon>14</stumbleupon>
      <reddit>
0</reddit>
      <delicious>
0</delicious>
  </social metrics>
  <backlink_metrics>
      
<majestic_page_backlinks>115286</majestic_page_backlinks>
      <majestic_referring_domains>
474</majestic_referring_domains>
      <majestic_citation_flow>
42</majestic_citation_flow>
      <majestic_trust_flow>35</majestic_trust_flow>
  
    <moz_page_backlinks>20211</moz_page_backlinks>
 
     <moz_page_authority>64.794127588275</moz_page_authority>
      <moz_rank>5.9998712303026</moz_rank>
  </backlink_metrics>
 </link>
</links>
</
tracking-data>
 



How to Generate New API Keys


You can obtain API Keys per user if your Rank Ranger account has API access by navigating to
1. Account  
2. Connections > API & Connected Apps
3. Click the Generate Key button
4. Select a User and add a note (optional)
5. Click the Add button

Generate API Key

How to Obtain API Access


If you see an error message when accessing the Account > Connections > API & Connected Apps screen, then to obtain API access you will need to upgrade to a package that includes API access by completing a custom package request form or contacting Rank Ranger support with your requirements.

API Console: Construct & Test API Requests


Referencing the parameters information that is listed in the specific API method documentation, you can construct and test API requests in Rank Ranger's API Console by navigating to:

1. Tools
2. Utilities
3. API Console
4. Select the Method and complete the applicable fields
5. Click the Generate button
6.Test your API method by clicking the launch URL icon and view your results. Once your results are as you want them, copy that URL into your own application and modify as needed for each request.

Rank Ranger API Testing Tool

API Query Limits


Rank Ranger APIs can pull up to 100 queries per minute. If more than 10,000 API GET requests per hour is required, then there is an option available at an additional throughput fee, contact customer service for assistance.

Rank Reporting Method Limits
  • Rank Data & Research Reporting API methods can only provide data from campaigns tracking in your Rank Ranger account.
  • You can run an unlimited number of queries through the API.
Search API Method Limits
  • SEO Intelligence API method query limits are based on the number of units purchased for your custom plan (e.g., 1 unit = 1 keyword tracked on 1 search engine, 1 time).
  • Search API plans do not include access to the reporting platform.

Developer API Methods

API Error Codes


Code Text Description
101 Invalid Method
Method does not exist, check your syntax
102 Invalid API Key
The API Key inserted is invalid, check for key accuracy
103 Invalid Domain
The Domain requested is invalid or does not exist in your account
104 Invalid Date
The selected date range or syntax is invalid
105 Invalid Keyword
The Keyword does not exist in this campaign 
202 Invalid Campaign Name
The Campaign name is invalid or missing
203 Invalid Primary URL
The Primary URL is invalid or missing
204 Invalid Campaign ID
The Campaign ID is invalid or missing
208 Invalid Search Engine
Invalid Search Engine ID
210 Keyword already exists
The Keyword already exists in this campaign
211 Keywords exist in campaign
You need to delete Keywords from this campaign before trying to delete the campaign
212 Invalid Package ID
Invalid Package ID
215 Custom White Label URL is already in use for another campaign
The Custom URL that you have selected for your White Label Portal is in use by another campaign, please select a different URL
400 No Results
No results were found
401 Limit Reached
You have reached the maximum number of Campaigns allowed in your package

406 Too many processes requested
The account has exceeded the limit on the number of exports that can be run and stored via the Tools > Utilities > Campaign Export tool. After downloading the files, you may delete them in the Campaign Export screen or via the API.



Get the ultimate SEO tools with the Rank Ranger Software
Learn More About Rank Ranger