Search our Knowledge Base
Search

Search Query API



The search_api_query is a direct query rank on-demand API method that returns the HTML of the search results for a keyword and search engine query. This is a real time tracking API method that features a callback URL option for automation with your software. 

Search Engines: data is available for Google Desktop, and Google Mobile. 

Frequency: one time on-demand.

Data Retention: data generated by this API is stored for 24 hours

Data Format: XML is the default format, and JSON can be obtained by adding an output parameter to the request

Package Capacity: 
  • Recurring monthly fee is based on the number of units purchased (1 unit = 1 keyword tracked 1 time on 1 search engine).
  • Units are available in multiples of 1000. 
  • At the beginning of each month the package capacity is reset (unused capacity is not transferable from previous month).
Contact us with the number keyword queries you want to run per month and we'll provide you with pricing.

Search Query API


 

API Options & Restrictions

 

API package capacity can be upgraded at any time.

Search API packages do not include access to Rank Ranger's reporting platform or white label features, these are data-only packages.

This on-demand API does not require campaign set up, it is used for one-time queries on one search engine per query so it can be built into your software or website, and as such there is no data storage.


 

Query Parameters

 
key string The unique API key assigned to your account
&key=yourAPIkey
keyword string Keyword
&keyword=your keyword
se_id int Search Engine ID (get search engine ID list)
&se_id=XXX
geo
string Optional: custom Location can be entered to target a specific location by adding &geo=location name or postal code. For example:
  • miami, fl  OR 90210 (specific postal code within the area of Google USA)
  • california (the entire state) 
  • london  or  wc1n (specific postal code within the area of Google.co.uk)
  • amsterdam or 1012nx (specific postal code within the area of Google.nl)
callback int Optional: When &callback=true is included in the request, the system will send a callback to the URL that is defined in the account settings as the 'callback_url'.
A callback is a POST request sent to your machine informing it that the data extraction task has been completed, and it provides the URL for downloading the HTML of the search results pages. 


Keyword Query with Callback URL

             
 
To receive the URL for downloading the HTML of the search results when the data extraction task has been completed, add the callback parameter to your keyword query and a POST response will be sent to your machine.

Example of Keyword Query to obtain Callback URL
https://www.rankranger.com/api/v2/?search_api_query&key=YOUR-API-KEY&keyword=YOUR-KEYWORD&se_id=XXX&callback=true


Sample Callback URL Response





Keyword Query Examples without Callback

 

Run Keyword Query for XML output

https://www.rankranger.com/api/v2/?search_api_query&key=YOUR-API-KEY&keyword=YOUR-KEYWORD&se_id=XXX

Run Keyword Query for JSON output

https://www.rankranger.com/api/v2/?search_api_query&key=YOUR-API-KEY&keyword=YOUR-KEYWORD&se_id=XXX&output=json

Run Keyword Query for specific USA location

https://www.rankranger.com/api/v2/?search_api_query&key=YOUR-API-KEY&keyword=YOUR-KEYWORD&se_id=XXX&geo=nashville, tn

Run Keyword Query for specific city for a non-USA location when using a country-specific search engine (e.g., Google UK)
https://www.rankranger.com/api/v2/?search_api_query&key=YOUR-API-KEY&keyword=YOUR-KEYWORD&se_id=XXX&geo=london
The default output is in XML format, if you would like the output to be json then add "&output=json” at the end of the string.



Response: Successful Query Processing

 
Query ID

A successful search_api_query request returns a status of success, along with a Query ID (query_id) that can be used to call the rank results.



Get Results Parameters

 

se_id int Search Engine ID (get search engine ID list)
query_id int Query ID is used to request rank results after submitting a keyword query
parse_results string To obtain parsed results, add &parse_results=true&se_id=XXX to the request
parse_serp_features string Optional: Adding &parse_serp_features=true to the search_query-api_results request provides the special SERP indicators from our Google SERP Features API and Related Search API when those features are present in the search results for the query.
output string To obtain JSON format, add &output=json to the request


HTML Results Request Example

 
The Parse Results, Parse SERP Features and/or Output parameters can be added to the Callback URL or it can be used in its original form to obtain the HTML SERP results.  

Example of a Callback URL
https://www.rankranger.com/api/v2/?search_api_query_results&key=YOUR-API-KEY&query_id=QUERY-ID


HTML Results Example

The Callback URL produces the full HTML results inside of content tags. For example:
 

Example of saved HTML results viewed in a web browser 

Callback HTML


Parsed Results Request Example

 
Parsed results can be requested manually in the following format using the query_id received via the search_api_query request, plus the parse_results and se_id parameters.

https://www.rankranger.com/api/v2/?search_api_query_results&key=YOUR-API-KEY&query_id=QUERY-ID&output=json&parse_results=true&se_id=XXX&parse_serp_features=true

Example of Search Query API Parsed Results including SERP Features




Results Not Available

 
Depending upon the queue results may be returned in a matter of seconds to a minute or slightly more for the query to process, so your results request should be set to repeat until results are returned.

When results are not ready, this Not available error is the response:


API Query Limits


You can run an unlimited number of queries through the API.
  • Only data from your Rank Ranger account can be pulled through the API.
  • Rank Ranger APIs can pull up to 10 queries per minute.
If more than 10,000 API GETs per hour is required, then there is an option available at an additional throughput fee.

How to Obtain an API Key


You can obtain API Keys per user if your Rank Ranger account has API access.

To do this, go to Account Settings --> API & Connected Apps and select Generate Key.

Generate API Key


Select User
  • Add Notes (optional)
  • Click the Add button 

select user


API Keys successfully generated

API key generated


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


Developer API Methods


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