SEOlib API Документация обеспечивает доступ к техническим возможностям сервиса. Вы можете использовать API для более гибкой работы с проектами, отчетами, позициями, а также для использования сервиса без веб-интерфейса.
Метод для получения текущего баланса пользователя с учетом заблокированных средств
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/account/balance | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание |
---|---|---|---|
token | string | Да | Токен авторизации пользователя |
Пример запроса
{ "token": "<токен авторизации>" }
Ответ сервера
Название | Тип | Описание | |
---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | |
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | |
balance | float | Текущий баланс пользователя с учетом заблокированных средств | |
currency | string | Валюта в формате ISO 4217 |
Пример ответа
{ "success": "<статус>", "content": { "balance": "<баланс пользователя>", "currency": "<валюта>" } }
Метод вернет список активных поисковых систем
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/globals/engines | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание |
---|---|---|---|
token | string | Да | Токен авторизации пользователя |
Пример запроса
{ "token": "<токен авторизации>" }
Ответ сервера
Название | Тип | Описание | ||
---|---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | ||
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | ||
engines | array | Список активных поисковых систем | ||
id | numeric | Идентификатор поисковой системы | ||
name | string | Название поисковой системы | ||
depths | array | Допустимая глубина поиска | ||
prices | array | Стоимость проверки для выбранной глубины |
Пример ответа
{ "success": "<статус>", "content": { "engines": [{ "id": "<идентификатор поисковой системы>", "name": "<название поисковой системы>", "depths": [ "<глубина поиска>" ], "prices": [ "<стоимость проверки>" ] }] } }
Метод вернет список активных регионов поиска
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/globals/regions | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание |
---|---|---|---|
token | string | Да | Токен авторизации пользователя |
engine | numeric | Да | Идентификатор поисковой системы |
Пример запроса
{ "token": "<токен авторизации>", "engine": "<идентификатор поисковой системы>" }
Ответ сервера
Название | Тип | Описание | ||
---|---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | ||
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | ||
regions | array | Список активных регионов поиска | ||
id | numeric | Идентификатор региона поиска | ||
name | string | Название региона поиска |
Пример ответа
{ "success": "<статус>", "content": { "regions": [{ "id": "<идентификатор поисковой системы>", "name": "<название поисковой системы>" }] } }
Метод вернет список проектов
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/projects/list | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание |
---|---|---|---|
token | string | Да | Токен авторизации пользователя |
Пример запроса
{ "token": "<токен авторизации>" }
Ответ сервера
Название | Тип | Описание | |||
---|---|---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | |||
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | |||
projects | array | Список проектов | |||
id | numeric | Идентификатор проекта | |||
name | string | Название проекта | |||
domain | string | Адрес сайта | |||
group | array | Информация о группе | |||
id | numeric | Идентификатор группы | |||
name | string | Название группы | |||
count | array | Информация о запросах | |||
keywords | numeric | Кол-во запросов | |||
active | boolean | Статус проекта |
Пример ответа
{ "success": "<статус>", "content": { "projects": [{ "id": "<идентификатор проекта>", "name": "<название проекта>", "domain": "<адрес сайта>", "group": { "id": "<идентификатор группы>", "name": "<название группы>" }, "count": { "keywords": "<кол-во запросов>" }, "active": "<статус>" }] } }
Методы параметров проекта
Метод вернет список поисковых систем проекта
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/projects/settings/engines | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание |
---|---|---|---|
token | string | Да | Токен авторизации пользователя |
project | numeric | Да | Идентификатор проекта |
Пример запроса
{ "token": "<токен авторизации>", "project": "<идентификатор проекта>" }
Ответ сервера
Название | Тип | Описание | |||
---|---|---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | |||
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | |||
engines | array | Список поисковых систем | |||
engine | array | Информация о поисковой системе | |||
id | numeric | Идентификатор поисковой системы | |||
name | string | Название поисковой системы | |||
active | boolean | Статус поисковой системы |
Пример ответа
{ "success": "<статус>", "content": { "engines": [{ "engine": { "id": "<идентификатор поисковой системы>", "name": "<название поисковой системы>" }, "active": "<статус>" }] } }
Метод вернет список регионов поиска проекта
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/projects/settings/engines/regions | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание |
---|---|---|---|
token | string | Да | Токен авторизации пользователя |
project | numeric | Да | Идентификатор проекта |
engine | numeric | Да | Идентификатор поисковой системы |
Пример запроса
{ "token": "<токен авторизации>", "project": "<идентификатор проекта>", "engine": "<идентификатор поисковой системы>" }
Ответ сервера
Название | Тип | Описание | |||
---|---|---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | |||
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | |||
regions | array | Список регионов поиска | |||
region | array | Информация о регионе | |||
id | numeric | Идентификатор региона | |||
name | string | Название региона | |||
active | boolean | Статус проекта |
Пример ответа
{ "success": "<статус>", "content": { "regions": [{ "region": { "id": "<идентификатор региона>", "name": "<название региона>" }, "active": "<статус>" }] } }
Методы отчетов по проекту
Метод вернет отчет по позициям проекта
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/projects/reports/positions | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание |
---|---|---|---|
token | string | Да | Токен авторизации пользователя |
project | numeric | Да | Идентификатор проекта |
engine | numeric | Да | Идентификатор поисковой системы |
region | numeric | Да | Идентификатор региона поиска |
period | array | Да | Период проверки проекта в формате ISO 8601 |
Пример запроса
{ "token": "<токен авторизации>", "project": "<идентификатор проекта>", "engine": "<идентификатор поисковой системы>", "region": "<идентификатор региона>", "period": [ "<YYYY-MM-DD>", "<YYYY-MM-DD/YYYY-MM-DD>" ] }
Ответ сервера
Название | Тип | Описание | |||
---|---|---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | |||
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | |||
reports | array | Список регионов поиска | |||
created | array | Дата и время проверки | |||
date | string | Дата и время | |||
timezone_type | string | Тип часовой зоны | |||
timezone | string | Название часовой зоны | |||
project | array | Информация о прокте | |||
id | numeric | Идентификатор проекта | |||
name | string | Название проекта | |||
keyword | array | Информация о ключевом запросе | |||
id | numeric | Идентификатор ключевого запроса | |||
name | string | Название ключевого запроса | |||
engine | array | Информация о поисковой системе | |||
id | numeric | Идентификатор поисковой системы | |||
name | string | Название поисковой системы | |||
region | array | Информация о регионе поиска | |||
id | numeric | Идентификатор региона | |||
name | string | Название региона | |||
data | array | Данные по проверке | |||
id | position | Позиция сайта | |||
page | string | Страница сайта |
Пример ответа
{ "success": "<статус>", "content": { "reports": [{ "created": { "date": "<дата и время>", "timezone_type": "<тип часовой зоны>", "timezone": "<название часовой зоны>" }, "project": { "id": "<идентификатор проекта>", "name": "<название проекта>" }, "keyword": { "id": "<идентификатор запроса>", "name": "<название ключевого запроса>" }, "engine": { "id": "<идентификатор поисковой системы>", "name": "<название поисковой системы>" }, "region": { "id": "<идентификатор региона>", "name": "<название региона>" }, "data": { "position": "<позиция сайта>", "page": "<страница сайта>" } }] } }
Методы проверки позиций
Срок хранения результата - 7 дней с момента получения результатов.
Метод создает отложенную задачу на проверку позиций и возвращает идентификатор
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/metrics/positions/task/create | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание | |
---|---|---|---|---|
token | string | Да | Токен авторизации пользователя | |
domain | string | Да | Адрес сайта | |
keywords | array | Да | Ключевые запросы для проверки | |
engines | array | Да | Поисковые системы и регионы поиска | |
engine | numeric | Да | Идентификатор поисковой системы | |
regions | array | Да | Идентификатор региона поиска | |
depth | numeric | Да | Глубина поиска |
Пример запроса
{ "token": "<токен авторизации>", "domain": "<адрес сайта>", "keywords": [ "<ключевой запрос>" ], "engines": [{ "engine": "<идентификатор поисковой системы>", "regions": "<регионы поиска>", "depth": "<глубина поиска>" }] }
Ответ сервера
Название | Тип | Описание | |
---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | |
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | |
task | string | Токен задачи для получения результатов |
Пример ответа
{ "success": "<статус>", "content": { "task": "<токен задачи>" } }
Метод возвращает результат отложенной задачи
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/metrics/positions/task/result | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание |
---|---|---|---|
token | string | Да | Токен авторизации пользователя |
task | string | Да | Токен задачи для получения результатов |
Пример запроса
{ "token": "<токен авторизации>", "task": "<токен задачи>" }
Ответ сервера
Название | Тип | Описание | |||||
---|---|---|---|---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | |||||
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | |||||
status | boolean | Возвращает true в случае готовности задачи или false если задача еще в работе | |||||
result | array | Возвращает массив с результатом выполненной задачи | |||||
keyword | string | Ключевой запрос | |||||
engines | array | Поисковые системы | |||||
engine | numeric | Идентификатор поисковой системы | |||||
regions | array | Регионы поиска | |||||
region | numeric | Идентификатор региона поиска | |||||
report | array | Отчет по результату поиска | |||||
total | array | Общее количество найденных результатов поисковой системой | |||||
pages | array | Все найденные ранжируемые страницы на странице поиска | |||||
page | string | Ранжируемая страница на странице поиска для указанного адреса сайта | |||||
position | numeric | Позиция указанного адреса сайта на странице поиска | |||||
snippet | string | Сниппет указанного адреса сайта на странице поиска |
Пример ответа
{ "success": "<статус>", "content": { "status": "<статус>", "result": [{ "keyword": "<ключевой запрос>", "engines": { "engine": "<идентификатор поисковой системы>", "regions": { "region": "<идентификатор региона>", "report": { "total": "<результат поиска>", "page": "<результат поиска>", "position": "<результат поиска>", "snippet": "<результат поиска>" } } } }] } }
Методы проверки ТОП(а)
Срок хранения результата - 7 дней с момента получения результатов.
Метод создает отложенную задачу на проверку ТОП(а) и возвращает идентификатор
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/metrics/positions/task/create | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание | |
---|---|---|---|---|
token | string | Да | Токен авторизации пользователя | |
keywords | array | Да | Ключевые запросы для проверки | |
engines | array | Да | Поисковые системы и регионы поиска | |
engine | numeric | Да | Идентификатор поисковой системы | |
regions | array | Да | Идентификатор региона поиска | |
depth | numeric | Да | Глубина поиска |
Пример запроса
{ "token": "<токен авторизации>", "keywords": [ "<ключевой запрос>" ], "engines": [{ "engine": "<идентификатор поисковой системы>", "regions": "<регионы поиска>", "depth": "<глубина поиска>" }] }
Ответ сервера
Название | Тип | Описание | |
---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | |
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | |
task | string | Токен задачи для получения результатов |
Пример ответа
{ "success": "<статус>", "content": { "task": "<токен задачи>" } }
Метод возвращает результат отложенной задачи
URL
Адрес метода | Метод запроса | Формат запроса |
---|---|---|
https://api.seolib.ru/metrics/positions/task/result | POST | JSON |
Заголовки
Заголовок | MIME Тип | Описание |
---|---|---|
Content-Type | application/json | Запрос в формате JSON |
Запрос к серверу
Название | Тип | Обязательно | Описание |
---|---|---|---|
token | string | Да | Токен авторизации пользователя |
task | string | Да | Токен задачи для получения результатов |
Пример запроса
{ "token": "<токен авторизации>", "task": "<токен задачи>" }
Ответ сервера
Название | Тип | Описание | |||||
---|---|---|---|---|---|---|---|
success | boolean | Возвращает true в случае успеха или false при ошибке | |||||
content | array | Возвращает массив с результатом запроса или сообщение об ошибке | |||||
status | boolean | Возвращает true в случае готовности задачи или false если задача еще в работе | |||||
result | array | Возвращает массив с результатом выполненной задачи | |||||
keyword | string | Ключевой запрос | |||||
engines | array | Поисковые системы | |||||
engine | numeric | Идентификатор поисковой системы | |||||
regions | array | Регионы поиска | |||||
region | numeric | Идентификатор региона поиска | |||||
report | array | Отчет по результату поиска | |||||
total | array | Общее количество найденных результатов поисковой системой | |||||
pages | array | Все найденные ранжируемые страницы на странице поиска |
Пример ответа
{ "success": "<статус>", "content": { "status": "<статус>", "result": [{ "keyword": "<ключевой запрос>", "engines": { "engine": "<идентификатор поисковой системы>", "regions": { "region": "<идентификатор региона>", "report": { "total": "<результат поиска>", "pages": "<результат поиска>" } } } }] } }
Список всех ошибок
Пример ответа
{ "success": "<статус>", "content": [ "<сообщение об ошибке>" ] }