Search our Knowledge Base
Search

Google Related Search API



The google_related_api method provides up to 10 keyword results from Google related search. 

Google Suggested Search Results API


Google Related Search API is one of our SEO Intelligence Search API methods, data is available for Google, including localized versions.

API Type: this is a stand-alone API-only package, it does not include access to our reporting platform reports or Reporting API methods.

Data Retention: data generated by this API is stored for 60 days.

Please contact us with the number of keywords and search engines you'd like this data for, along with the frequency (e.g., daily, weekly or monthly), and we'll provide you with information regarding a custom SERP API package and pricing.


 

API Options & Restrictions

 

API package capacity can be upgraded at any time.

Multiple types of API packages (Rank Top 50 Daily with SERP Features, Google Suggested Search Monthly, etc.) can exist in one account.
IMPORTANT! When creating new campaigns you must be careful to select the correct package for the new campaign because you:
  • Cannot transfer keywords or campaigns between Reporting Platform and API packages or between different types of API packages.
  • Cannot change an existing API package to a different type (e.g., Rank Top50 to Google Suggested Search).
  • Cannot change the frequency (e.g. from Monthly to Daily) of an existing API package.

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.


Parameters

 
key string The unique API key assigned to your account
keyword string Keyword
se_id int Search Engine ID
campaign_id
int Campaign ID number
date yyyy-mm-dd Requested data date
Optional: Date Range can be called using
&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD
(for up to a span of 10 days)
If date is used, then do not include the results parameter

results int Number of days' data (up to 10)
Do not use with date parameter


Examples

 

Construct & test API requests in the API Console or follow one of these examples:

Google Related Search for the most recent 2 results

https://www.rankranger.com/api/v2/?google_related_api&key=YOUR-API-KEY&keyword=YOUR-KEYWORD&se_id=SEARCH-ENGINE-ID&campaign_id=YOUR-CAMPAIGN-ID&results=2

Google Related Search for a specific date

https://www.rankranger.com/api/v2/?google_related_api&key=YOUR-API-KEY&keyword=YOUR-KEYWORD&se_id=SEARCH-ENGINE-ID&campaign_id=YOUR-CAMPAIGN-ID&date=YYYY-MM-DD

Google Related Search for a specific date range

https://www.rankranger.com/api/v2/?google_related_api&key=YOUR-API-KEY&keyword=YOUR-KEYWORD&se_id=SEARCH-ENGINE-ID&campaign_id=YOUR-CAMPAIGN-ID&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD


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



Sample Response

 
Words that display in bold print in the Google Related search results are enclosed in <b> </b> tags in the API response.

<?xml version="1.0" encoding="utf-8"?>
<tracking-data provider="rankranger" date="02/01/2016" time="12:28:59" status="ok" >
 - <results>
  --  
<result>
   ---  <details>
   
        <date>02-14-2015</date>
           <se_id>1</se_id>
           <keyword_name>
camera</keyword_name>
           <keyword_identifier>123456789</keyword_identifier>
    ---  </details>
     --- <search_results>
             <search_result>camera <b>prices</b></search_result>
             <search_result>camera <b>online</b></search_result>
             <search_result>camera <b>reviews</b></search_result>
             <search_result><b>sony</b> camera</search_result>
             <search_result>camera <b>download</b></search_result>
             <search_result>camera <b>history</b></search_result>
             <search_result><b>olympus</b> camera</search_result>
             <search_result>camera <b>app</b></search_result>
     --- </search_results>
  -- </result>
 - </results>
 </tracking-data>

Notes:
Keyword Identifier is an optional user defined field that can be used when adding a keyword to a campaign.
Up to 10 results are displayed, dependent upon the actual number of Google results for the keyword on the specified date(s).

If no results are found for a keyword on the specified search engine, then no results displays like this:
<result>no results</result>





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