Search Engine Setup
This page documents the lookup data you need to attach and configure a Google search engine on a project: the engine catalogue, the city catalogue used for sub-country targeting, and the language catalogue.
All three endpoints take no parameters, return data that changes rarely, and should be cached client-side.
List country search engines
GET https://api.seranking.com/v1/project-management/system/search-engines
Returns a list of available search engines along with their regions, which can be added to projects for position tracking.
Request parameters
No parameters.
Request example
GET https://api.seranking.com/v1/project-management/system/search-enginesResponse parameters
If successful, the server returns the 200 HTTP status code and an array of search engines.
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique search engine ID. |
| name | String | Search engine name. |
| regionid | String | Associated region ID. |
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 cities for search engines targeting
GET https://api.seranking.com/v1/project-management/system/google/regions
Returns every city and sub-region that search engines tracking can target, grouped by country. The name returned here is the value you pass as region_name to Add Search Engine / Update Search Engine when you want sub-country targeting (e.g. tracking USA specifically for New York).
Request parameters
No parameters.
Request example
GET https://api.seranking.com/v1/project-management/system/google/regionsResponse parameters
If successful, the server returns the 200 HTTP status code and an array of regions.
| Parameter | Type | Description |
|---|---|---|
| name | String | Full canonical location string in English, formatted {city}, {region}, {country} |
| region_id | number | Country ID (not city ID). |
Response example
[
{ "name": "New York, New York, United States", "region_id": 182 },
{ "name": "San Francisco, California, United States", "region_id": 182 },
{ "name": "Berlin, Berlin, Germany", "region_id": 61 },
{ "name": "Tokyo, Tokyo, Japan", "region_id": 83 },
{ "name": "Kabul, Kabul, Afghanistan", "region_id": 1 }
]List languages
GET https://api.seranking.com/v1/project-management/system/google/languages
Returns a complete list of supported languages for the Google search engine.
Request parameters
No parameters.
Request example
GET https://api.seranking.com/v1/project-management/system/google/languagesResponse parameters
If successful, the server returns the 200 HTTP status code and an array of language codes and names.
| Parameter | Type | Description |
|---|---|---|
| lang_code | String | Language code (ISO 639-1). |
| name | String | Language name. |
Response example
[
{
"lang_code": "de",
"name": "Deutsch"
},
{
"lang_code": "en",
"name": "English"
},
{
"lang_code": "es",
"name": "Español"
}
]
