Search our Knowledge Base
Search

Keyword Volume API



The Keyword Volume API method provides the following data for the list of keywords queried:
  • Keyword
  • Average Global Search Volume (country-based volume can be achieved using the Local Volume Settings)
  • Average Cost Per Click (CPC)
  • PPC Competition score

This API is intended to be used to obtain an initial list of keywords with average search volume, and then again after adding new keywords. Search volume may be updated as often as once per month, if Google has updates available.

The daily usage limit for this API is based on the package capacity.

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(s)
Enter a comma "," between keywords when requesting search volume for more than one keyword.
package_id int The Rank Ranger Package ID can be obtained by running the Get Packages Info API
Packages have a capacity for Site Explorer requests, and this API utilizes that capacity. 
ccode string (Optional) Country Code can be added to the request if local search volume has been configured.
To utilize this feature, refer to the Local Volume Settings and Country Code List sections in this document.
output string Output format options:
  • &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)


Example Requests

 

Construct & test Keyword Volume API requests in the API Console or follow one of these examples:
Keyword Volume for 1 Keyword
https://www.rankranger.com/api/v2/?keyword_volume_api&key=YourAPIkey&keyword=your-keyword&package_id=XXXX

Keyword Volume for Multiple Keywords - limited to 300 keywords per request
https://www.rankranger.com/api/v2/?keyword_volume_api&key=YourAPIkey&keyword=keyword1,keyword2,keyword3,keyword4,keyword5,keyword6,keyword7,keyword8,keyword9,keyword10&package_id=XXXX

Keyword Volume for Multiple Keywords (limited to 300 keywords per request) and country-based data
https://www.rankranger.com/api/v2/?keyword_volume_api&key=YourAPIkey&keyword=keyword1,keyword2,keyword3,keyword4,keyword5,keyword6,keyword7,keyword8,keyword9,keyword10&package_id=XXXX&ccode=gb

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 Example

             
 


   

Campaign Local Volume Settings

             
 
Change from Global to Country-based Search Volume
The Local Volume Settings option is available at the bottom of the Campaign Settings > Keywords screen for API packages. To utilize this option, scroll to the bottom of the Keywords screen, select a country and click the Update button. 

local volume setting


Status: In Queue
While local volume data is being collected for the campaign keywords, the Local Volume status will indicate that it is "in queue". 

local volume queue


Local Volume Updated
When the local volume data collection has been completed, the status indicates "Last Update:" followed by the date. 

local volume updated


Local Volume Service Limit Reached

If you attempt to update the local volume more one time per month, you will receive a message indicating that a volume update request was already completed during the period. 

local volume limit reached



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.

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

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


Country Code List

Country codes can be utilized in certain API methods and must be entered in lowercase format.

Country Name Country Code
Afghanistan af
Åland Islands ax
Albania al
Algeria dz
American Samoa as
Andorra ad
Angola ao
Anguilla ai
Antarctica aq
Antigua & Barbuda ag
Argentina ar
Armenia am
Aruba aw
Australia au
Austria at
Azerbaijan az
Bahamas bs
Bahrain bh
Bangladesh bd
Barbados bb
Belarus by
Belgium be
Belize bz
Benin bj
Bermuda bm
Bhutan bt
Bolivia bo
Bosnia & Herzegovina ba
Botswana bw
Bouvet Island bv
Brazil br
British Indian Ocean Territory io
British Virgin Islands vg
Brunei bn
Bulgaria bg
Burkina Faso bf
Burundi bi
Cambodia kh
Cameroon cm
Canada ca
Cape Verde cv
Caribbean Netherlands bq
Cayman Islands ky
Central African Republic cf
Chad td
Chile cl
China cn
Christmas Island cx
Cocos (Keeling) Islands cc
Colombia co
Comoros km
Congo (DRC) cd
Congo (Republic) cg
Cook Islands ck
Costa Rica cr
Côte d’Ivoire ci
Croatia hr
Cuba cu
Curaçao cw
Cyprus cy
Czech Republic cz
Denmark dk
Djibouti dj
Dominica dm
Dominican Republic do
Ecuador ec
Egypt eg
El Salvador sv
Equatorial Guinea gq
Eritrea er
Estonia ee
Ethiopia et
Falkland Islands (Islas Malvinas) fk
Faroe Islands fo
Fiji fj
Finland fi
France fr
French Guiana gf
French Polynesia pf
French Southern Territories tf
Gabon ga
Gambia gm
Georgia ge
Germany de
Ghana gh
Gibraltar gi
Greece gr
Greenland gl
Grenada gd
Guadeloupe gp
Guam gu
Guatemala gt
Guernsey gg
Guinea gn
Guinea-Bissau gw
Guyana gy
Haiti ht
Heard & McDonald Islands hm
Honduras hn
Hong Kong hk
Hungary hu
Iceland is
India in
Indonesia id
Iran ir
Iraq iq
Ireland ie
Isle of Man im
Israel il
Italy it
Jamaica jm
Japan jp
Jersey je
Jordan jo
Kazakhstan kz
Kenya ke
Kiribati ki
Kosovo xk
Kuwait kw
Kyrgyzstan kg
Laos la
Latvia lv
Lebanon lb
Lesotho ls
Liberia lr
Libya ly
Liechtenstein li
Lithuania lt
Luxembourg lu
Macau mo
Macedonia (FYROM) mk
Madagascar mg
Malawi mw
Malaysia my
Maldives mv
Mali ml
Malta mt
Marshall Islands mh
Martinique mq
Mauritania mr
Mauritius mu
Mayotte yt
Mexico mx
Micronesia fm
Moldova md
Monaco mc
Mongolia mn
Montenegro me
Montserrat ms
Morocco ma
Mozambique mz
Myanmar (Burma) mm
Namibia na
Nauru nr
Nepal np
Netherlands nl
New Caledonia nc
New Zealand nz
Nicaragua ni
Niger ne
Nigeria ng
Niue nu
Norfolk Island nf
North Korea kp
Northern Mariana Islands mp
Norway no
Oman om
Pakistan pk
Palau pw
Palestine ps
Panama pa
Papua New Guinea pg
Paraguay py
Peru pe
Philippines ph
Pitcairn Islands pn
Poland pl
Portugal pt
Puerto Rico pr
Qatar qa
Réunion re
Romania ro
Russia ru
Rwanda rw
Samoa ws
San Marino sm
São Tomé and Príncipe st
Saudi Arabia sa
Senegal sn
Serbia rs
Seychelles sc
Sierra Leone sl
Singapore sg
Sint Maarten sx
Slovakia sk
Slovenia si
Solomon Islands sb
Somalia so
South Africa za
South Georgia & South Sandwich Islands gs
South Korea kr
South Sudan ss
Spain es
Sri Lanka lk
Saint Barthélemy bl
St. Helena sh
St. Kitts & Nevis kn
St. Lucia lc
St. Martin mf
St. Pierre & Miquelon pm
St. Vincent & Grenadines vc
Sudan sd
Suriname sr
Svalbard & Jan Mayen sj
Swaziland sz
Sweden se
Switzerland ch
Syria sy
Taiwan tw
Tajikistan tj
Tanzania tz
Thailand th
Timor-Leste tl
Togo tg
Tokelau tk
Tonga to
Trinidad & Tobago tt
Tunisia tn
Turkey tr
Turkmenistan tm
Turks & Caicos Islands tc
Tuvalu tv
U.S. Outlying Islands um
U.S. Virgin Islands vi
Uganda ug
Ukraine ua
United Arab Emirates ae
United Kingdom gb
United States us
Uruguay uy
Uzbekistan uz
Vanuatu vu
Vatican City va
Venezuela ve
Vietnam vn
Wallis & Futuna wf
Western Sahara eh
Yemen ye
Zambia zm
Zimbabwe zw




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