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

GET /system/search-engines

Result

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

Name Description
id Unique search engine ID
name Name
region_id Region ID
type Type of search engine

Response example

[
    {
        "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 available regions for Yandex

Description

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

Request format

GET /system/yandex-regions

Result

If successful, the server returns an array containing a list of regions for Yandex and their unique IDs

Response example

{
    "1": "Moscow",
    "2": "Saint-Petersburg",
    "3": "Centre",
    "4": "Belgorod",
    "5": "Ivanovo",
    ...
    "122068": "Ambrolauri",
    "122069": "Zugdidi",
    "122070": "Akhaltsikhe",
    "123580": "Tedzhen"
}

List of languages for Google

Description

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

Request format

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.

Name Required Description
lang_code Yes Language code
name Yes Language name

Response example

[
    "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

GET /system/volume-regions

Result

If successful, the server returns an array of regions.

Name Required Description
id Yes Unique region ID
name Нет Region name

Response example

[
    {
        "id": "180",
        "name": "United Kingdom",
        "name_ru": "United Kingdom",
        "ordr": "1890",
        "code": "GB",
        "show_in_list": "1"
    },
    {
        "id": "182",
        "name": "USA",
        "name_ru": "USA",
        "ordr": "10",
        "code": "US",
        "show_in_list": "1"
    },

...
]

Obtaining keyword search volume data

Description

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

Parameters

Name Required Description
region_id Yes Region ID. All regions and their IDs can be obtained via /system/volume-regions
keyword Yes Array 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
yandex_region_code No Region code from Wordstat (non-mandatory parameter; if specified, the search volume from Yandex Wordstat will be indicated. If not from Google)

Request format

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.

Name Required Description
volume Yes Keyword search volume

Response example

{
    "key1": "1000",
    "key2": "10000"
    ...
    "keyN": "100000"
}

Errors

HTTP code Error message
400 Not enough params. region_id and keyword required
400 Incorrect region_id
404 No data
By continuing to use this site you consent to the use of cookies in accordance with our Cookie policy. close notification