API Description

General data

List of search engines

Description

The method allows to get a list of available search engines along with regions that can be added to projects for position tracking.

Request format

Title of the code block
Copy
GET /system/search-engines

Result

If successful, the server returns an array of available search engines.

NameDescription
idUnique search engine ID
nameName
region_idRegion ID
typeType of search engine

Response example

Title of the code block
Copy
[
{
"id": "200",
"name": "Google USA",
"regionid": "182"
},
{
"id": "201",
"name": "Google Andorra",
"regionid": "4"
},
{
"id": "202",
"name": "Google United Arab Emirates",
"regionid": "178"
},
...
]

List of languages for Google

Description

The method allows to obtain a complete list of possible languages for the Google search engine.

Request format

Title of the code block
Copy
GET /system/google-langs

Result

If successful, the server will return an array with a complete list of language codes and their names for the Google search engine.

NameRequiredDescription
lang_codeYesLanguage code
nameYesLanguage name

Response example

Title of the code block
Copy
[
  "de":"Deutsch",
  "en":"English",
  "es":"español"
  ...
]

List of regions to get the search volume

Description

The method allows to obtain a list of all regions where SE Ranking can run a keyword search volume check.

Parameters

This method doesn’t have any parameters.

Request format

Title of the code block
Copy
GET /system/volume-regions

Result

If successful, the server returns an array of regions.

NameRequiredDescription
idYesUnique region ID
nameNoRegion name

Response example

Title of the code block
Copy
[
{
  "id": "180",
    "name": "United Kingdom",
  },   
{
"id": "182",
    "name": "USA",  
 },
  ...
]

Obtaining keyword search volume data

Description

The method allows to get the search volume data for a specified region and keyword list.

Parameters

NameRequiredDescription
region_idYesRegion ID. All regions and their IDs can be obtained via /system/volume-regions
keywordYesArray of keywords for which the search volume will be obtained. Cyrillic keywords in URLs must be URL-encoded, i.e. the keyword will transform into %D0%BA%D0%BB%D1%8E%D1%87.An array can contain a maximum of 10 words.

Request format

Title of the code block
Copy
GET /system/volume?regionid=12&keyword[]=%D0%BA%D0%BB%D1%8E%D1%87

Result

If successful, the server returns an array of keywords with their search volumes.

NameRequiredDescription
volumeYesKeyword search volume

Response example

Title of the code block
Copy
{
    "key1": "1000",
    "key2": "10000",
   ...,
    "keyN": "100000"
}

Errors

HTTP code Error message
400Not enough params. region_id and keyword required
400Incorrect region_id
404No data