nofollow
BLACKFRIDAY2018

-30% скидки на любую оплату
подробнее

Черная пятница в SE Ranking: 30% скидки на любую оплату. подробнее

API для получения данных по вашим проектам в SE Ranking

login (аутентификация - получение токена для вызова остальных методов)

Параметры

  • login - логин (обязательный параметр)
  • pass - md5 от пароля (обязательный параметр)

При успешном вызове возвращает результат вида:

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

Описание возвращаемых параметров:

  • name - полное имя пользователя
  • token - токен авторизации
  • avatar - адрес изображения аватара пользователя

Пример вызова:

https://api2.seranking.com/?method=login&login= вашлогин &pass= хэшМд5пароля

searchEngines (список поисковых систем)

Для этого метода нет параметров. Возвращает список в массиве всех поисковиков с возможными регионами (для яндекса).

Данные в каждом элементе массива:

Имя Описание
id уникальный идентификатор поисковой системы
name Название
region_id ID региона для searchVolume
regions массив регионов (для яндекса)

При успешном вызове возвращает результат вида:

[
    {"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"},
    ...]},
    ....
]

Пример вызова:

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

sites (список сайтов пользователя)

Для этого метода нет параметров. Возвращает список всех сайтов клиента.

При успешном вызове возвращает результат вида:

[
    {
        "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,
    }
]

Описание параметров, возвращаемых для каждого сайта:

Имя Описание
id уникальный идентификатор сайта (ID)
name url сайта
title название сайта
group_id ID группы сайтов
todayAvgPosition средняя позиция за последнюю дату снятия позиций (сегодня)
yesterdayAvgPosition средняя позиция за предыдущую дату снятия позиций (вчера)
totalUp сколько позиций поднялось в выдаче
totalDown сколько позиций опустилось в выдаче
keysCount всего запросов в сайте
process текущий процент обработки позиций сайта
SEs массив поисковиков, к которым привязан сайт, каждый элемент - массив с четырьмя элементами - site_engine_id (ID поисковика сайта), seID (ID поисковика), regionID (ID региона яндекса, если поисковик - не яндекс, то null), regionName (название города (или индекс), если такой был указан для google)
guestLink гостевая ссылка для просмотра статистики сайта без авторизации
top5 запросов в ТОП 5
top10 запросов в ТОП 10
top30 запросов в ТОП 30
visibility Прогноз трафика
visibility_percent Видимость в %
da MozDomainAuthority
index_yandex Количество страниц в индексе Яндекс
index_google Количество страниц в индексе Google
yandex_x Яндекс ИКС для домена

Пример вызова:

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

siteKeywords (список запросов сайта)

Параметры

Имя Описание
siteid уникальный идентификатор сайта (обязательный параметр)

При успешном вызове возвращает результат вида:

[
    {"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"},
    ....
]

Описание параметров, возвращаемых для каждого запроса:

Имя Описание
id уникальный идентификатор запроса (ID)
name сам запрос
group_id ID группы запросов
link целевой URL
first_check_date дата первой проверки запроса

Пример вызова:

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

stat (статистика по запросам)

Параметры:

Имя Описание
siteid уникальный идентификатор сайта (обязательный параметр)
dateStart дата начала в формате yyyy-mm-dd (необязательный параметр, по умолчанию - сегодня минус неделя)
dateEnd дата конца в формате yyyy-mm-dd (необязательный параметр, по умолчанию - сегодня)
SE ID поисковиков, на которые надо отобразить статистику - массив ID поисковиков сайта (для яндекса указывается в формате IDпоисковика~IDрегиона). Если не указан - отображается для всех поисковиков сайта (необязательный параметр)
with_serp_features специальные элементы поисковой выдачи Google, найденные в результатах поиска по ключевому слову (необязательный параметр)
with_map возвращает позицию в Google Maps, если в настройках поисковой системы включена опция "Учитывать выдачу google maps" (необязательный параметр)
with_paid возвращает позицию в платной выдаче Google, если была выбрана опция "Отслеживать позиции в Google Adwords" (необязательный параметр)

При успешном вызове возвращает результат вида:

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

Возвращает массив из всех поисковиков сайта. В каждом поисковике - массив keywords, состоящий из элементов вида {"id":123,"positions":[...],"landing_pages":[...]} . Пример одного элемента массива keywords:

{
    "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"}
    ]
}
Имя Описание
id уникальный идентификатор запроса
positions массив с элементами:
Имя Описание
date дата в формате yyyy-mm-dd
change изменение позиции по сравнению с пред. датой (может быть отрицательное)
pos текущая позиция
price цена, рассчитанная из настроек фин. отчёта
is_map указывает где найдена позиция, принимает значение 0 для органической выдачи, 1 для блока с картами.
map_position позиция в блоке с картами, при включенной опции "Отображать позиции для органической и выдачи карт отдельно"
paid_position позиция в платной выдаче Google
landing_pages массив с элементами:
Имя Описание
date дата в формате yyyy-mm-dd
url url в выдаче
features массив с элементами поиска. Если значение true - в элементе поиска надена ссылка на сайт проекта

Пример вызова:

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= токенПолученныйПриЛогине

logout - прекращение сеанса

Для этого метода нет параметров. Сбрасывает access-token, полученный при авторизации. После вызова метода token, полученный ранее, становится недействительным.

Пример вызова:

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

searchVolumeRegions (список регионов для avg.search volume)

Для этого метода нет параметров. Возвращает список всех регионов для получения avg.search volume.

При успешном вызове возвращает результат вида:

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

Пример вызова:

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

keySearchVolume (получение avg.search volume для одного запроса)

Возвращает avg.search volume для указанного региона и ключевого слова.

Параметры:

Имя Описание
regionid ID региона. Все регионы и их ID можно получить в методе searchVolumeRegions (обязательный параметр)
keyword ключевое слово (запрос), для которого будет получен avg.search volume. Должен быть url-encoded в url, т.е. "ключ" превратится в %D0%BA%D0%BB%D1%8E%D1%87 (обязательный параметр)
yandex_region_code код региона из wordstat (необязательный параметр, если указан - вернётся частотность из яндекс wordstat, если нет - из google)

При успешном вызове возвращает результат вида:

{"volume":123500}

Пример вызова:

https://api2.seranking.com/?method=keySearchVolume®ionid=12&keyword=%D0%BA%D0%BB%D1%8E%D1%87&token= токенПолученныйПриЛогине

keySearchVolumeList (получение avg.search volume для списка запросов)

Возвращает avg.search volume для указанного региона и массива ключевых слов.

Параметры

Имя Описание
regionid ID региона. Все регионы и их ID можно получить в методе searchVolumeRegions (обязательный параметр)
keyword массив ключевых слов (запросов), для которого будет получен avg.search volume. Каждый элемент должен быть url-encoded в url, т.е. "ключ" превратится в %D0%BA%D0%BB%D1%8E%D1%87 (обязательный параметр)
yandex_region_code код региона из wordstat (необязательный параметр, если указан - вернётся частотность из яндекс wordstat, если нет - из google)

При успешном вызове возвращает результат вида:

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

Пример вызова:

https://api2.seranking.com/?method=keySearchVolumeList®ionid=12&keyword[]=%D0%BA%D0%BB%D1%8E%D1%87&keyword[]=sony&token= токенПолученныйПриЛогине

addSiteKeywords (добавление запросов к сайту)

Возвращает массив из двух элементов: 'added' - количество реально добавленных запросов, 'ids' - массив ID добавленных запросов. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
siteid уникальный идентификатор сайта (обязательный параметр)
keywords массив запросов (обязательный параметр)
groupid ID группы запросов (если не указать, будет использована группа по умолчанию)

При успешном вызове возвращает результат вида:

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

addSiteKeywordsExt (расширенное добавление запросов к сайту)

Возвращает массив из двух элементов: 'added' - количество реально добавленных запросов, 'ids' - массив ID добавленных запросов. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
siteid уникальный идентификатор сайта (обязательный параметр)
keywords ассоциативный массив запросов, пары запрос=>целевая_ссылка (обязательный параметр)
groupid ID группы запросов (если не указать, будет использована группа по умолчанию)
is_strict_target_urls Проверять позиции только для указанных целевых ссылок (0 или 1, по умолчанию - 0)

При успешном вызове возвращает результат вида:

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

addSite (добавление сайта)

Возвращает ключ siteid (ID добавленого сайта) в массиве результата при успешном вызове. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
url url сайта (обязательный параметр)
title название сайта (обязательный параметр)
depth глубина сбора позиций (50,100,150,200), по умолчанию - 100
subdomain_match учитывать сабдомены в выдаче? (0 или 1), по умолчанию - 0
exact_url точный URL? (0 или 1), по умолчанию - 0
manual_check_freq частота сбора позиций - ('check_daily','check_1in3','check_weekly','check_yandex_up','manual'), по умолчанию - check_daily
auto_reports еженедельный отчет? (0 или 1), по умолчанию - 1
group_id ID группы, куда добавить созданный сайт
day_of_week если указан manual_check_freq=check_weekly, то в этом параметре можно задать день недели. Значения от 1 (понедельник) до 7 (воскресенье)

Пример кода на PHP:

$method = 'addSite';
$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 (удаление сайта)

Возвращает ключ status (=1) в массиве результата при успешном вызове. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
siteid ID сайта для удаления (обязательный параметр)

moveSites2group (переносит сайты в другую группу сайтов)

Возвращает ключ status (=1) в массиве результата при успешном вызове. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
site_ids массив ID сайтов для перемещения (обязательный параметр)
group_id ID группы, куда переместить сайты (обязательный параметр)

sitesGroupsList (список групп сайтов)

Возвращает список групп сайтов. При успешном вызове возвращает результат вида:

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

addSiteGroup (добавление группы сайтов)

Возвращает ID созданной группы . Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
name имя группы (обязательный параметр)

deleteKeywords (удаление запросов)

Возвращает ключ status (=1) в массиве результата при успешном вызове. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
keywords_ids массив ID удаляемых запросов (обязательный параметр)
siteid ID сайта, из которого удаляются запросы (обязательный параметр)

addKeywordsGroup (добавление группы для запросов)

Возвращает ключ id, содержащий id добавленной группы в массиве результата при успешном вызове. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
name имя группы (обязательный параметр)
siteid ID сайта, в который будет добавлена группа (обязательный параметр)

moveKeywords2Group (перенос запросов в другую группу)

Возвращает ключ status (=1) в массиве результата при успешном вызове. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
keywords_ids массив ID переносимых запросов (обязательный параметр)
siteid ID сайта, к которому принадлежат запросы (обязательный параметр)
groupid ID группы, куда переносить запросы (обязательный параметр)

changeGroupName (изменение названия группы запросов)

Возвращает ключ status (=1) в массиве результата при успешном вызове. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
newname новое название группы (обязательный параметр)
siteid ID сайта, к которому принадлежит группа (обязательный параметр)
groupid ID группы (обязательный параметр)

deleteKeywordGroup (удаление группы запросов)

Возвращает ключ status (=1) в массиве результата при успешном вызове. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
siteid ID сайта, к которому принадлежит группа (обязательный параметр)
groupid ID удаляемой группы (обязательный параметр)

keywordsGroupsList (список групп запросов)

Возвращает список групп запросов для указанного сайта. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
siteid ID сайта (обязательный параметр)

При успешном вызове возвращает результат вида:

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

updateSiteSE (обновление/добавление поисковиков сайта)

Возвращает ключ status (=1) в массиве результата при успешном вызове. Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
siteid (обязательный параметр) ID сайта
se (обязательный параметр) массив поисковых систем в виде
[
    "IDпоисковойСистемы1" => {
        "region_name" => "названиеРегиона",
        "lang_code" => "кодЯзыка",
    },
    "IDпоисковойСистемы2~IDрегиона" => null,
    ...
]

"названиеРегиона" и "кодЯзыка" задаются только для гугл-поисковиков (для остальных пустая строка или null). Для яндекс-поисковиков ID поисковика задаётся как IDпоисковойСистемы~IDрегиона (например, яндекс-москва это 411~213)

getGoogleLangs (список языков гугла)

Возвращает полный список возможных языков для гугл-поисковиков в виде массива код=>название. Метод не требует параметров

При успешном вызове возвращает результат вида:

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

competitorsList (получение списка добавленных конкурентов)

Параметры:

Имя Описание
siteid ID сайта для списка конкурентов (обязательный параметр)

При успешном вызове возвращает результат вида:

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

Возвращает массив добавленных конкурентов с данными по ним:

Имя Описание
id уникальный идентификатор конкурента
name указанное название конкурента
domain домен сайта конкурента
yandex_x Яндекс ИКС домена

Пример вызова:

https://api2.seranking.com/?method=competitorsList&siteid= айди_вашего_сайта &token= токенПолученныйПриЛогине

competitorStat (статистика по запросам для конкурентов)

Параметры:

Имя Описание
competitorid уникальный идентификатор конкурента (обязательный параметр)
dateStart дата начала в формате yyyy-mm-dd (необязательный параметр, по умолчанию - сегодня минус неделя)
dateEnd дата конца в формате yyyy-mm-dd (необязательный параметр, по умолчанию - сегодня)
SE ID поисковиков, на которые надо отобразить статистику - массив ID поисковиков сайта (для яндекса указывается в формате IDпоисковика~IDрегиона) Если не указан - отображается для всех поисковиков сайта (необязательный параметр)

При успешном вызове возвращает результат вида:

[

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

Возвращает массив из всех поисковиков сайта, к которому относится конкурент. В каждом поисковике - массив keywords, состоящий из элементов вида {"id":123,"positions":[...]} - id запроса и массив позиций (positions):

Имя Описание
date дата в формате yyyy-mm-dd
change изменение позиции по сравнению с пред. датой (может быть отрицательное)
pos текущая позиция

Пример вызова:

https://api2.seranking.com/?method=competitorStat&competitorid=12345&dateStart=2014-01-01&SE[]=123&SE[]=123~456&token= токенПолученныйПриЛогине

addSiteCompetitor (добавление конкурента к сайту)

Возвращает уникальный идентификатор добавленного конкурента, ключ id в массиве результата.

Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
siteid уникальный идентификатор сайта (обязательный параметр)
url url сайта конкурента (обязательный параметр)
name имя сайта конкурента (если не указать, будет использован url)

deleteCompetitor (удаление конкурента сайта)

Возвращает ключ status (=1) в массиве результата при успешном вызове.

Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
competitorid уникальный идентификатор конкурента (обязательный параметр)

getTopCompetitors (получение топ 10 конкурентов для сайта)

Возвращает топ 10 конкурентов сайта с адресами и позициями

Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
siteid уникальный идентификатор сайта (обязательный параметр)
date дата (если не указана, будет возвращена выдача за текущую дату)
seID идентификатор поисковой системы (необязательный параметр, если не указан, будут возвращены все)
keywordID идентификатор ключевого слова (смотрите метод siteKeywords для получения списка с идентификаторами для сайта) (необязательный параметр, если не указан, будет возвращена выдача для всех ключевых слов)
Пример вызова:
https://api2.seranking.com/?method=getTopCompetitors&siteid=12345&date=2016-02-01&seID=200&keywordID=678&token= токенПолученныйПриЛогине

updateSite (обновление настроек сайта)

При успешном выполнении возвращает массив {"status" => 1}.

Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
siteid ID сайта (обязательный)
site_title имя сайта (необязательный)
site_name адрес сайта (необязательный)
site_exact_url точный URL? (0 или 1) (необязательный)
site_active автоматический съём позиций (0 - выключен, 1 - включён)
site_subdomain_match учитывать сабдомены в выдаче? (0 или 1) (необязательный)
manual_check_freq частота сбора позиций - ('check_daily','check_1in3','check_weekly','check_yandex_up','manual') (необязательный)
site_depth глубина сбора позиций (50, 100,150,200) (необязательный)
manual_check_freq_day если указан у сайта выставлена еженедельная проверка позиций (check_weekly_, то в этом параметре можно задать день недели. Значения от 1 (понедельник) до 7 (воскресенье) (необязательный)

Баланс аккаунта (getBalance)

Возвращает баланс аккаунта.

Не требует параметров

Результат вида:

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

Пример вызова:

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

setPosition (ручная установка позиции)

При успешном выполнении возвращает массив {"status" => 1} .

Параметры (все обязательные), передаваемые в json-encoded элементе 'data' в POST-запросе:

Имя Описание
keyword_id ID запроса
date дата в формате ГГГГ-ММ-ДД (yyyy-mm-dd)
search_engine_uid ID поисковика (для яндекса указывается в формате IDпоисковика~IDрегиона)
position позиция, от 0 до 200, 0 считается как "не найдено"

recheck (запуск проверки позиций)

При успешном выполнении возвращает количество запросов, для которых запущена проверка позиций.

Параметры, передаваемые в json-encoded элементе 'data' в POST-запросе:

siteid ID сайта (обязательный). Если в запросе передан только этот параметр, будет запущена проверка позиций всех запросов проекта.
site_engine_id ID поисковика сайта, полученный в запросе sites (необязательный). Если этот параметр присутствует в запросе, то будет запущена проверка позиций только для этого поисковика.
date ID сайта (обязательный). Если в запросе передан только этот параметр, будет запущена проверка позиций всех запросов проекта.
search_engine_uid ID поисковика сайта, полученный в запросе sites (необязательный). Если этот параметр присутствует в запросе, то будет запущена проверка позиций только для этого поисковика.
keywords массив отдельных ключевых слов, для которых нужно запустить проверку позиций (необязательный). Для каждого ключевого слова указывается пара значений: site_engine_id (ID поисковика сайта) и keyword_id (ID запроса). Если этот параметр присутствует в запросе, то параметр site_engine_id игнорируется.