API Documentation
Home

API Documentation

The Ranks API is a service for Ranks Friends only.

Ranks Friends can find their personal API key by going to the URL below when logged in:
http://www.ranks.nl/cgi-bin/ranksnl/spider/spider.cgi?myranks=1

The API key system works by adding "&apikey=YOUR_API_KEY" to the standard URLs. Replace "YOUR_API_KEY" with your actual key.

So, for example.. to get an HTML report for
http://www.webmasterworld.com you would create the URL like this:

http://www.ranks.nl/cgi-bin/ranksnl/spider/spider.cgi?url=http%3A%2F%2Fwww.webmasterworld.com%2F&ff=1&api_key=YOUR_API_KEY

To get the same in XML, add "&output=xml" to the URL:

http://www.ranks.nl/cgi-bin/ranksnl/spider/spider.cgi?url=http%3A%2F%2Fwww.webmasterworld.com%2F&ff=1&output=xml&api_key=YOUR_API_KEY

To simply show the form:

http://www.ranks.nl/cgi-bin/ranksnl/spider/spider.cgi?api_key=YOUR_API_KEY 

Note the URL to analyze should be URL-encoded or unpredictable things may happen.

Please be careful to keep the API key a secret when you use it.. all requests made through this key will be counted as a request on your behalf.

There is a way to speed up requests, by skipping all external data sources, such as Google Pagerank, Majestic SEO backlinks and Alexa data. Add "&qck=1" to an URL to use this feature.

For example, an URL with your API key, with output in XML and without external sources:

http://www.ranks.nl/cgi-bin/ranksnl/spider/spider.cgi?url=http%3A%2F%2Fwww.webmasterworld.com%2F&ff=1&output=xml&api_key=YOUR_API_KEY&qck=1


All other settings are currently determined by your last settings from when you last used the form here: http://www.ranks.nl/tools/spider.html So if you do not chose to show 'All text' in your reports by default, 'All Text' will not be in the API response either. 

Please note this is a limited service, not all data found in the HTML reports are included in the XML. Including more then a few external sources would slow down the XML results too much.
In the HTML reports most external data is retrieved using AJAX so there is no need to wait for them before the report can be displayed, but this is not possible with the XML report. The API data does include Alexa, MajesticSEO backlink counts, Google Pagerank and WOT trustworthiness data , but not the Google Rankings and SEOmoz backlink data for example.

Fair use for a standard subscription is currently set to 4000 queries per 31 days. If you need more then 4000/month we can offer a custom subscription, please tell us what you need and we'll be happy to send you a quote.

Advantages to membership

Ranks Friends have access to more webmaster tools and enjoy less restrictions on the free tools!

Money Back Guarantee

Payment methods

Using our tools for a
Search Engine Marketing course ?
We offer Discounts to Students


I’m thankful for finding Ranks.nl at the beginning of my online career. Ranks enables me to make decisions based on raw data unlike other websites who feed me data and values for what they believe is important. From a support/customer service standpoint, Ranks can’t be beat. Damian has always been quick to respond to any questions or concerns and always eager to accept suggestions for improving the site.

Ranks is the only site that I’ve been a loyal member for over the past 5 years.

Ryan Rose , Department of Search March 24 2011

More quotes

 


Recommend Ranks NL



ADVERTISEMENTS:

National Parks
25 of the most impressive national parks in the world

Amsterdam Expats
Expat issues for expatriates in Amsterdam, Netherlands

Earth Platform
About the main threats of the world today, such as deforestation, global warming, endangered animals and pollution.