SE Ranking projects

login (authentication - receiving token to use other methods)

Parameters

  • login - username (required)
  • pass - md5 from the password (required)

A successful call returns something like:

{
    "name":"name1 name2",
    "token":"c3b7ce7ae4cce5a6312f4046b701da9d",
    "avatar": "http://online.seranking.com/tmp/avatar/upload-icon.png"
}

The description of the parameters returned:

  • name - full user's name
  • token - auth token for any other method
  • avatar - user's avatar image url

The sample call:

https://api2.seranking.com/?method=login&login= username&pass= md5passwords

searchEngines (the list of search engines)

This method has no parameters. Returns a list of all the search engines in an array of all possible regions (for Yandex).

The data in each element of the array:

Name Description
id A unique identifier of the search engine
name The name
region_id The ID of a region for searchVolume
regions An array of regions (for Yandex)

A successful call returns something like:

[
    {"id":"200","name":"Google USA","regionid":"123","regions":[]},
    {"id":"411","name":"Yandex Russia","regionid":"456",
     "regions":[
        {"id":"213","name":"\u041c\u043e\u0441\u043a\u0432\u0430"},
        {"id":"1095","name":"\u0410\u0431\u0430\u043a\u0430\u043d"},
    ...]},
    ....
]

The sample call:

https://api2.seranking.com/?method=searchEngines&token= токенПолученныйПриЛогине

sites (a list of a user's sites)

This method has no parameters. Returns a list of all the client’s websites.

A successful call returns something like:

[
    {
        "id": 123,
        "name": "site1.com",
        "group_id": null,
        "title": "my site",
        "todayAvgPosition": 123,
        "yesterdayAvgPosition": 111,
        "totalUp": 0,
        "totalDown": 5,
        "keysCount": 124,
        "process": "99.9",
        "SEs": [
            { "site_engine_id": "1", "seID": "226", "regionID": null },
            { "site_engine_id": "2", "seID": "413", "regionID": "157" },
            { "site_engine_id": "3", "seID": "384", "regionID": null },
            { "site_engine_id": "4", "seID": "413", "regionID": "153" }
        ],
        "guestLink": "https://online.seranking.com/guest.html?site_id=123&hv=0&hash=555a7745&tab=detailed",
        "top5" : 1,
        "top10" : 2,
        "top30" : 3,
        "visibility" : 2,
        "visibility_percent" : 30.0,
        "da" : 4,
        "index_yandex" : 100,
        "index_google" : 200,
        "yandex_x" : 100,
    },
    {
        "id": 456,
        "name": "site2.com",
        "group_id": 2,
        "title": "my site#2",
        "todayAvgPosition": 222,
        "yesterdayAvgPosition": 223,
        "totalUp": 4,
        "totalDown": 4,
        "keysCount": 34,
        "process": "100",
        "SEs": [
            { "site_engine_id": "5", "seID": "226", "regionID": null }
        ],
        "guestLink": "https://online.seranking.com/guest.html?site_id=456&hv=0&hash=555b8856&tab=detailed",
        "top5" : 1,
        "top10" : 2,
        "top30" : 0,
        "visibility" : 2,
        "visibility_percent" : 30.0,
        "da" : 4,
        "index_yandex" : 100,
        "index_google" : 200,
        "yandex_x" : null,
    }
]

The description of the parameters returned for each site:

Name Description
id A unique identifier of a site(ID)
name Website URL
title Website title
group_id Website group ID
todayAvgPosition An average position for last position checking date (today)
yesterdayAvgPosition An average position for prev position checking date (yesterday)
totalUp How many keywords have moved up in SERP
totalDown How many keywords have moved down in SERP
keysCount Keywords count
process The current percentage of the website rankings processing
SEs An array of search engine IDs, to which the site is attached
guestLink Link for viewing website statistics without authorization
top5 Keywords in Top 5
top10 Keywords in Top 10
top30 Keywords in Top 30
visibility Traffic forecast
visibility_percent Search visibility
da MozDomainAuthority
index_yandex Yandex pages indexed
index_google Google pages indexed

The sample call:

https://api2.seranking.com/?method=sites&token= logintoken

siteKeywords (a list of website keywords)

Parameters

Name Description
siteid A unique identifier of a website (required)

A successful call returns something like:

[
    {"id":1,"name":"ключ1","group_id":"11", "link":null, "first_check_date":null},
    {"id":2,"name":"ключ2","group_id":"22", "link":"http://mysite.ru/", "first_check_date":"2014-02-03"},
    ....
]

The description of the parameters returned for each keyword

Name Description
id A unique identifier of a keyword(ID)
name Keyword
group_id ID of keyword's group
link Target URL
first_check_date Date of first check for keyword

The sample call:

https://api2.seranking.com/?method=sites&token= logintoken

stat (statistics on keyword positions)

Parameters:

Name Description
siteid A unique identifier of a website (required)
dateStart The start date in the format yyyy-mm-dd (optional , by default - today minus one week )
dateEnd The end date in the format yyyy-mm-dd (optional , by default - today)
SE search engine IDs, on which statistics should be displayed - a string with numbers separated by a comma (200,411, 453,). If it is not specified it will be displayed for all search engines of a website (optional)
with_serp_features special elements of Google search results by the keyword (optional)
with_map Returns the Google map result. “Include google map results” option is to be enabled in the search engine settings (optional)
with_paid Returns Google paid result. “Track Google AdWords rankings” option is to be enabled in the search engine settings (optional)

A successful call returns something like:

[
    {"seID":"1","regionID":null,"keywords":[{"id":"1","positions":[{"date":"2013-09-03", "change":"1","pos":"1", "price":3},...]]},
    ....
]

Returns an array of all the search engines of a website. Each search engine has an array of keywords. Sample element from "keywords" array:

{
    "id": "4188",
    "positions": [
        {"date": "2014-06-20", "pos": "2", "change": 0, "price":3},
        {"date": "2014-06-21", "pos": "2", "change": 0, "price":4},
        {"date": "2014-06-22", "pos": "3", "change": 0, "price":5},
        {"date": "2014-06-23", "pos": "4", "change": -1, "price":1}
    ],
    "landing_pages": [
        {"url": "http:\/\/mysite.com\/", "date": "2014-02-06"},
        {"url": "http:\/\/mysite.com\/page1", "date": "2014-02-08"}
    ]
}
Name Description
id Unique key identifier
positions array of elements:
Name Description
date date in "yyyy-mm-dd" format
change The change of keyword positions compared to the previous date (can be negative)
pos Current position
price Price, based on financial reports settings
is_map indicates the result’s rank. 0 value stands for organic results, 1 stands for map results block
map_position Position in the map results block. “Count organic and maps results separately” option should be enabled in the search engine settings
paid_position Position in the Google paid result
landing_pages array of elements:
Name Description
date Date in "yyyy-mm-dd" format
url Url in SERP
features Array of search elements. If the value is "true" - project website URL is found in the search element

The sample callа:

https://api2.seranking.com/?method=stat&siteid=12345&dateStart=2014-01-01&SE[]=123&SE[]=123~456&with_serp_features=1&with_map=1&with_paid=1&token= logintoken

logout - the session interruption

This method has no parameters. Resets the access-token obtained in authorization. After calling the token method obtained earlier, it becomes invalid.

The sample call:

https://api2.seranking.com/?method=logout&token= logintoken

searchVolumeRegions (a list of regions for avg.search volume)

This method has no parameters. Returns a list of all regions for getting avg.search volume.

A successful call returns the following:

[
    {"id":"1","name":"Afghanistan"},
    {"id":"2","name":"Algeria"},
    ...
]

The sample call:

https://api2.seranking.com/?method=searchVolumeRegions&token= токенПолученныйПриЛогине

keySearchVolume (getting avg.search volume for one keyword)

Returns avg.search volume for a specified region and a keyword.

Parameters:

Name Description
regionid A region ID. All regions and its IDs can be obtained with the method searchVolumeRegions (required)
keyword A keyword (search query). It should be url-encoded (required)

A successful call returns something like:

{"volume":123500}

The sample call:

https://api2.seranking.com/?method=keySearchVolume®ionid=12&keyword=%D0%BA%D0%BB%D1%8E%D1%87&token= logintoken

keySearchVolumeList (getting avg.search volume for keywords list)

Returns avg.search volumes for a specified region and keywords list.

Parameters

Name Description
regionid A region ID. All regions and its ID can be obtained with the method searchVolumeRegions (required)
keyword An array of keywords (search queries) (required)

A successful call returns something like:

{
    "keyword1":"123500",
    "keyword2":"5678"
}

The sample call:

https://api2.seranking.com/?method=keySearchVolumeList®ionid=12&keyword[]=%D0%BA%D0%BB%D1%8E%D1%87&keyword[]=sony&token= logintoken

addSiteKeywords (add keywords to site)

Returns array with to elements: 'added' - qty of added keywords, 'ids' - array of IDs for added keywords. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
siteid Site ID (required)
keywords Array of keywords (required)
groupid Key group ID (if not specified, the default group will be used)

A successful call returns something like:

{
    "added": "2",
    "ids": [111,112]
}

addSiteKeywordsExt (add keywords to site)

Extended version of addSiteKeywords. Returns array with to elements: 'added' - qty of added keywords, 'ids' - array of IDs for added keywords. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
siteid Site ID (required)
keywords Associative array of keywords (keyword=>targetUrl pairs) (required)
groupid Key group ID (if not specified, the default group will be used)
is_strict_target_urls Check rankings for target URLs only (0 or 1, default - 0)

A successful call returns something like:

{
    "added": "2",
    "ids": [111,112]
}

addSite (add site)

Returns ID of new site of keywords, element 'siteid' in result array on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
url Site ulr (required)
title Site name (required)
depth Collection depth (50,100,150,200), default - 100
subdomain_match Match subdomains in SERP? (0 or 1), default - 0
exact_url Exact URL? (0 or 1), default - 0
manual_check_freq Check frequency - ('check_daily','check_1in3','check_weekly','check_yandex_up','manual'), by default - check_daily
auto_reports Weekly report? (0 or 1), default - 1
group_id ID of site group to put newly created site
day_of_week If manual_check_freq param is set to 'check_weekly', you can set day of week here. Values from 1 (Monday) to 7 (Sunday)

Sample PHP code:

$method = 'addSite';
$token = 'my_login_token';

$apiUrl = 'https://api2.seranking.com/?method='.$method.'&token='.$token;
$curlHandler = curl_init($apiUrl);
curl_setopt($curlHandler, CURLOPT_POST, 1);
$data = [
    'url' => 'http://my_site.com',
    'title' => 'my site',
];
curl_setopt($curlHandler, CURLOPT_POSTFIELDS, http_build_query(array('data' => json_encode($data))));
curl_setopt($curlHandler, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curlHandler);
$err = curl_error($curlHandler);
if ($err) {
    print 'error: '.$err."\n";
}
print 'result: '.$result;

deleteSite (delete a site)

Returns key 'status' (=1) in result array on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
siteid Site ID to delete (required)

moveSites2group (moves sites to another group of sites)

Returns key 'status' (=1) in result array on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
site_ids Array of sites ID to move (required)
group_id Group ID to move site to (required)

sitesGroupsList (sites groups list)

Returns sites groups list. A successful call returns something like:

[
    {"id":"111","name":"group1"},
    {"id":"222","name":"group2"},
    ...
]

addSiteGroup (adds new group of sites)

Returns ID of new created group on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
name Name for new group (required)

deleteKeywords (delete keywords)

Returns key 'status' (=1) in result array on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
keywords_ids Array of keywords ID to delete (required)
siteid Site ID of keywords (required)

addKeywordsGroup (adds keyword group)

Returns key 'id' (=1), holding an ID of new group in result array on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
name Group name (required)
siteid Site ID to add group (required)

moveKeywords2Group (moves keywords from one group to another)

Returns key 'status' (=1) in result array on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
keywords_ids Array of IDs for moved keywords (required)
siteid Site ID of group (required)
groupid Group ID to move keywords (required))

changeGroupName (changes keywords group name)

Returns key 'status' (=1) in result array on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
newname New group name (required)
siteid Site ID of group (required)
groupid Group ID (required)

deleteKeywordGroup (delete keywords group)

Returns key 'status' (=1) in result array on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
siteid Site ID of group (required)
groupid Group ID (required)

keywordsGroupsList (keywords groups list)

Returns keywords groups list for a specified site. Parameters passed in JSON-encoded format in 'data' element of POST request

Name Description
siteid Site ID of group (required)

A successful call returns something like:

[
    {"id":"111","name":"group1","creation_date":"2016-08-08"},
    {"id":"222","name":"group2","creation_date":null},
    ...
]

updateSiteSE (update/add site's search engines)

Returns key 'status' (=1) in result array on successful call. Parameters passed in JSON-encoded format in 'data' element of POST request

Name Description
siteid (required) Site ID
se (required) Array of search engines
[
    "engineId1" => {
        "region_name" => "DesiredRegionName1",
        "lang_code" => "LangCode1",
    },
    "engineId2" => null,
    ...
]

"region_name" and "lang_code" (see method getGoogleLangs for full list) are only for google search engines (empty string or NULL for others)

getGoogleLangs (get google's languages)

Returns full list of available languages for google search engines as key=>value (code=>full name) list. This method does not require any parameters

A successful call returns something like

[
    "de":"Deutsch",
    "en":"English",
    "es":"español"
    ...
]

competitorsList (list of competitors)

Parameters:

Name Description
siteid Site ID (required)

A successful call returns something like:

[
{"id":"111", "name":"my competitor","domain":"comp1domain.com","yandex_x":1000},
...
{"id":"222", "name":"my competitor5","domain":"comp5domain.com","yandex_x":null}
]

Returns a list of all added competitors for specified site as array:

Name Description
id A unique identifier of the competitor
name Competitor's name
domain домен сайта конкурента
yandex_x Competitor's domain

The sample call::

https://api2.seranking.com/?method=competitorsList&siteid= your_site_id&token= logintoken

competitorStat (statistics on keyword positions for competitor)

Parameters:

Name Description
competitorid A unique identifier of a competitor (required)
dateStart The start date in the format yyyy-mm-dd (optional , by default - today minus one week)
dateEnd The end date in the format yyyy-mm-dd (optional , by default - today)
SE Search engine IDs, on which statistics should be displayed - a string with numbers separated by a comma (200,411, 453,). If it is not specified it will be displayed for all search engines of a website (optional)

A successful call returns something like:

[

    {"seID":"1","regionID":null,"keywords":[{"id":"1","positions":[{"date":"2013-09-03", "change":"1","pos":"1"},...]]},
    ....
]

Returns an array of all the search engines of a website competitor belongs to. Each search engine has an array of keywords, consisting of elements that have the form {"id": 123 , "positions": [...]} - id search query and an array of positions (positions):

Name Description
date The date in the format yyyy-mm-dd
change The change of keyword positions compared to the previous date (it can be negative)
pos The current position

The sample call:

https://api2.seranking.com/?method=competitorStat&competitorid=12345&dateStart=2014-01-01&SE[]=123&SE[]=123~456&token= logintoken

addSiteCompetitor (adding competitor to site)

Returns a unique identifier of added competitor, key "id" in result array.

Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
siteid A unique identifier of a website (required)
url Competitor's site url (required)
name Competitor name (will be used url if omitted)

deleteCompetitor (delete a competitor)

Returns key 'status' (=1) in result array on successful call.

Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
competitorid competitor ID to delete (required)

getTopCompetitors (get top 10 site competitors)

Gets site's top 10 competitors with URLs and positions

Parameters passed in JSON-encoded format in 'data' element of POST request:

Name Description
siteid A unique identifier of a website (required)
date Date for report (current date will be used if omitted)
seID Identifier of search engine (optional, every engine data will be in response if omitted)
keywordID identifier of site keyword - call siteKeywords method to get identifiers (optional, all keywords will be in response if omitted)
The sample call:
https://api2.seranking.com/?method=getTopCompetitors&siteid=12345&date=2016-02-01&seID=200&keywordID=678&token= logintoken

SE Ranking projects (site settings update)

Returns key 'status' (=1) in result array on successful call.

Parameters (anything is optional except siteid) passed in JSON-encoded format in 'data' element of POST request:

Name Description
siteid A unique identifier of a website (required)
site_title Site name
site_name Site URL
site_exact_url Exact URL? (0 or 1)
site_active Status (0 - disabled, 1 - enabled)
site_subdomain_match Match subdomains in SERP? (0 or 1)
site_depth Collection depth (50,100,150,200), default - 100

getBalance

Returns account's balance.

No parameters required

A successful call returns something like:

{"currency":"USD","value":11.22}

The sample call:

https://api2.seranking.com/?method=getBalance&token= logintoken

setPosition (manual position set)

Returns key 'status' (=1) in result array on successful call.

Parameters (all required) passed in JSON-encoded format in 'data' element of POST request:

Name Description
keyword_id Identifier of site keyword
date Date in the format yyyy-mm-dd
search_engine_uid Search engine id
position Position, from 0 to 200. 0 means "not found"

recheck (start keywords positions checker)

On successful call returns the total number of keywords queued to recheck.

Parameters passed in JSON-encoded format in 'data' element of POST request:

siteid Website ID (required). If this is the only parameter stated in the query all project keywords positions will be rechecked.
site_engine_id Search engine ID, see sites (optional). When applied the keywords positions will be rechecked only for the specified search engine.
search_engine_uid Search engine ID, see sites (optional). When applied the keywords positions will be rechecked only for the specified search engine.
keywords An array of the specific keywords to be rechecked (optional). Two parameters are stated for every keyword: site_engine_id (website search engine identifier) and keyword_id (website keyword identifier). When applied, the site_engine_id parameter is ignored.
By continuing to use this site you consent to the use of cookies in accordance with our Cookie policy. close notification