Search our Knowledge Base
Search

Rank Ranger Developer API Overview



Rank Ranger's API allows you to integrate data from your account into your own applications. Tracking data is available in XML and JSON format. Detailed instructions with parameter options and examples are provided for each API method.

Choosing an API Type
  • Access to Reporting Rank Data and Research API methods is available as an add-on to a Rank Ranger reporting platform package, and provides results only for the keywords and URLs that are being tracked in a reporting platform campaign.
  • SEO Intelligence Search API methods include top competitor or specialty search engine data that is only available via API, they do not include access to reports, graphs or analysis tools within the reporting platform.
API package capacity can be upgraded at any time. Multiple types of packages (e.g., reporting platform and a variety of search APIs) can exist in the same account, so it is important to be careful when creating a new campaign to select the correct API or reporting platform package because it is not possible to:
  • transfer keywords or campaigns between Reporting Platform and API packages or between different types of API packages.
  • change an existing API package to a different type (e.g., Rank Top50 to Search Query API).
  • change the tracking frequency (e.g. from Monthly to Daily) of an existing API package.
API XML API JSON
 
 

Simple to Use API with XML & JSON Options

 
With API access and an HTTP GET request sent to the API endpoint at https://www.rankranger.com/api/v2/ you are able to retrieve data stored on our servers or execute a search query (depending upon the type of API package).

Output Format Options
The default output format is XML, adding "&output=json" to the end of the string provides results in JSON format.
  • &output=xml  (this is the default format)
  • &output=json
    Either of these parameters can be added to the json output parameter:
    • &output=json&json_strict=true 
      (forces the results to come back as array instead of objects) 
    • &output=json&json_arr=true 
      (causes the entire json to be wrapped as array)
The GET request needs to contain parameters that identify the type of data you want, so if, for example, you want to pull the rank stats for a domain (that is tracking in a reporting platform package) on a specific date, you can use the rank_stats API method.

Sample XML GET Request & Results
 
https://www.rankranger.com/api/v2/?rank_stats&key=YourAPIKey&date=YYYY-MM-DD&domain=example.com&campaign_id=YourCampaignID

API XML output example

Sample JSON GET Request & Results

 
https://www.rankranger.com/api/v2/?rank_stats&key=YourAPIKey&date=YYYY-MM-DD&domain=example.com&campaign_id=YourCampaignID&output=json

API JSON output example

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