If an API request fails, a JSON object containing details about the error will be returned by the API. Find below an example error that is returned if the maximum allowed API request limit has been reached or exceeded.
Code |
Description |
|---|---|
100 |
User did not provide an API Key. |
101 |
User provided an invalid API Key. |
102 |
User has reached money ballance. |
103 |
User has reached his subscription's monthly request limit. |
104 |
User account is inactive or blocked. |
105 |
User has not provided a valid value inside the [query] parameter. |
106 |
User has not provided a valid value inside the [system] parameter. |
300 |
Error getting search results. |
301 |
Error getting search results with HTTP Code. |
302 |
Error getting search results with Yandex API Error Code. |
399 |
API request failed due to an unknown error. Please contact customer support and report the error. |
HTTP GET Request Parameters
Parameter |
Description |
|---|---|
api_key |
[Required] Your API access key, available in your account dashboard |
query |
[Required] Specify any query to search for (advanced operators like intext: are supported) |
system |
[Required] Specify any search system google, yandex, bing (default: google) |
domain |
[optional] Specify which search engine domain to use: com, de, fr, etc. (default: com). Download a list of all supported domains: domains.csv |
result_cnt |
[optional] Specify the number of results (default: 10 – shows 10 organic results, MAX – 100 (10, 50, 100)) |
hl |
[optional] Specify a language to use for your query (default: en for English). Download a list of all supported languages: languages.csv |
gl |
[optional] Specify a country code to use for your query (default: us for United States). Download a list of supported 2-letter country codes: countries.csv |
location |
[optional] Specify the geographical location for your request, which will be processed using free text in Google format (which wll be auto-transformate to UULE-string). Download a list of supported locations: locations.csv |
device |
[optional] Specify which device to use: desktop (default) or mobile |
HTTP GET Request Parameters
Parameter |
Description |
|---|---|
api_key |
[Required] Your API access key, available in your account dashboard |
query |
[Required] Specify any query to search for (advanced operators like intext: are supported) |
system |
[Required] Specify any search system google, yandex, bing (default: google) |
result_cnt |
[optional] Specify the number of results (default: 10 – shows 10 organic results, MAX – 100 (10, 50, 100)) |
lang |
[optional] Specify a language to use for your query (default: en for English). Download a list of all supported languages: languages.csv |
country |
[optional] Specify a country code to use for your query (default: us for United States). Download a list of supported 2-letter country codes: markets.csv |
device |
[optional] Specify which device to use: desktop (default) or mobile |
HTTP GET Request Parameters
Parameter |
Description |
|---|---|
api_key |
[Required] Your API access key, available in your account dashboard |
query |
[Required] Specify any query to search for (advanced operators like site: are supported) |
system |
[Required] Specify any search system google, yandex, bing (default: google) |
domain |
[optional] Specify which search engine domain to use: ru (default). Other Yandex Domains: ua, by, kz, com, com.tr |
result_cnt |
[optional] Specify the number of results (default: 10 – shows 10 organic results, MAX – 100 (10, 50, 100)) |
lr |
[optional] Specify the geographical location for your request, which will be processed using local region ID in Yandex format (default: 213 (Moscow)). Download a list of supported locations: lr.csv |
Parameter |
Description |
|---|---|
position |
Returns the position of the current organic result in the entire search result |
link |
Returns the actual URL of the organic result |
title |
Returns the title of the organic result |
snippet |
Returns the description of the organic result |
res_found |
Returns the number of results found in Google and Yandex search engines (you can also get the number of site pages in the index by the site: operator) |
