Documentation > Reporting API > Rank Data Methods

Rank API

The rank method returns ranking data for the selected domain (including landing page) within a selected date range (limited to a 60 day period).

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

Table of Contents

Parameters

key	string	&key=yourAPIkey The unique API key assigned to your account
campaign_id	string	&campaign_id=XXXXXX Your Campaign ID number (get campaigns IDs)
domain	tld	&domain=example.com Top level domain requested. This can be the primary domain or one of the competitor domains tracked in the campaign
start_date	yyyy-mm-dd	Requested data start date
end_date	yyyy-mm-dd	Requested data end date There is a 60-day limit to the date range
se_id	string	Optional: &se_id=XXX Search Engine ID can be added to the request in order to filter by a specific search engine Get search engine ID list
keyword	string	Optional: &keyword=your keyword A keyword may be added to the request in order to filter that data for a specific keyword

Example

Construct & test API requests in the API Console or follow this example:

https://www.rankranger.com/api/v2/?rank&key=YOURAPIKEY&campaign_id=12345&domain=yourdomain.com&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD

Example filtering for 1 Search Engine
https://www.rankranger.com/api/v2/?rank&key=YOURAPIKEY&campaign_id=12345&domain=yourdomain.com&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&se_id=123

Example filtering for 1 Keyword
https://www.rankranger.com/api/v2/?rank&key=YOURAPIKEY&campaign_id=12345&domain=yourdomain.com&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&keyword=abc blocks

Example filtering for 1 Search Engine & 1 Keyword
https://www.rankranger.com/api/v2/?rank&key=YOURAPIKEY&campaign_id=12345&domain=yourdomain.com&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&se_id=123&keyword=abc blocks

The default output is in XML format, if you would like the output to be json the you will need to add "&output=json” at the end of the string

Response

<tracking-data provider="rankranger" date="01/28/2020" time="13:43:43" status="ok" num_of_days="7" total_results="168">
    <result>
        <date>01/19/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad ideas</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>7</rank>
    </result>
    <result>
        <date>01/20/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad ideas</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>8</rank>
    </result>
    <result>
        <date>01/21/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad ideas</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>7</rank>
    </result>
    <result>
        <date>01/22/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad ideas</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>8</rank>
    </result>
    <result>
        <date>01/23/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad ideas</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>8</rank>
    </result>
    <result>
        <date>01/24/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad ideas</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>8</rank>
    </result>
    <result>
        <date>01/25/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad ideas</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>8</rank>
    </result>
    <result>
        <date>01/19/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad recipes</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>2</rank>
    </result>
    <result>
        <date>01/20/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad recipes</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>2</rank>
    </result>
    <result>
        <date>01/21/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad recipes</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>2</rank>
    </result>
    <result>
        <date>01/22/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/96/salad/</lp>
        <keyword>salad recipes</keyword>
        <se>google.com</se>
        <se_name>Google USA</se_name>
        <rank>2</rank>
    </result>

--- continues ---


    <result>
        <date>01/25/2020</date>
        <url>www.allrecipes.com</url>
        <lp>/recipes/377/desserts/cakes/cupcakes/</lp>
        <keyword>cupcakes</keyword>
        <se>google.com</se>
        <se_name>Google Mobile</se_name>
        <rank>7</rank>
    </result>
</result>undefined</tracking-data>

​x
 
<tracking-data provider="rankranger" date="01/28/2020" time="13:43:43" status="ok" num_of_days="7" total_results="168">    <result>        <date>01/19/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad ideas</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>7</rank>    </result>    <result>        <date>01/20/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad ideas</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>8</rank>    </result>    <result>        <date>01/21/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad ideas</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>7</rank>    </result>    <result>        <date>01/22/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad ideas</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>8</rank>    </result>    <result>        <date>01/23/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad ideas</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>8</rank>    </result>    <result>        <date>01/24/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad ideas</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>8</rank>    </result>    <result>        <date>01/25/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad ideas</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>8</rank>    </result>    <result>        <date>01/19/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad recipes</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>2</rank>    </result>    <result>        <date>01/20/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad recipes</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>2</rank>    </result>    <result>        <date>01/21/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad recipes</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>2</rank>    </result>    <result>        <date>01/22/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/96/salad/</lp>        <keyword>salad recipes</keyword>        <se>google.com</se>        <se_name>Google USA</se_name>        <rank>2</rank>    </result>​--- continues ---​​    <result>        <date>01/25/2020</date>        <url>www.allrecipes.com</url>        <lp>/recipes/377/desserts/cakes/cupcakes/</lp>        <keyword>cupcakes</keyword>        <se>google.com</se>        <se_name>Google Mobile</se_name>        <rank>7</rank>    </result></result>undefined</tracking-data>

How to Obtain API Access

How to Generate New API Keys

API Console: Construct & Test API Requests

API Query Limits

Developer API Methods

API Error Codes

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

Featured SEO Tools

SEO Dashboard Rank Tracker Social Analytics Link Manager White Label SEO

Marketing Dashboard Keyword Finder Insight Graph API

Resources

Top 100 Websites Rank Risk Index Google Algorithm Updates Google SERP Features Tool Mobile SERP Features Tool Visual Guide to SERP Features SEO Glossary

Rank Ranger

Pricing Contact us Blog Help Center Documentation Brand Ambassadors

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 Campaigns > Import & Export > Campaign Export tool. After downloading the files, you may delete them in the Campaign Export screen or via the API.

Rank API

Parameters

Example

Response

How to Obtain API Access

How to Generate New API Keys

API Console: Construct & Test API Requests

Getting Started: Samples of APIs used for Creating Campaigns

API Query Limits

Developer API Methods

Account Management

Account Data

Reporting API

Rank Data Methods

Research Methods

Search API

SEO Intelligence Methods

API FAQs

API Error Codes

Search our Knowledge Base
	Search