API Документация

Введение

Описание

SEOlib API обеспечивает доступ к техническим возможностям сервиса. Вы можете использовать API для более гибкой работы с проектами, отчетами, позициями, а также для использования сервиса без веб-интерфейса.

С чего начать

Как воспользоваться API:

Зарегистрироваться
Подтвердить регистрацию.
Получить API токен.

Как получить API токен:

Войти
Перейти в настройки аккаунта.
Выбрать вкладку "Настройки API".
Нажмите кнопку "Сгенерировать ключ".

Возможности

Аккаунт:
1. Баланс пользователя
Общее:
1. Список поисковых систем
2. Список регионов поиска
Проекты:
1. Список проектов
2. Параметры проекта
  1. Поисковые системы проекта
  2. Регионы поиска проекта
3. Отчеты по проекту:
  1. Отчет по позициям
  2. Отчет по ТОП(ам)
Метрики:
1. Проверка позиций:
  1. Создать задачу
  2. Получить результат
2. Проверка ТОП(а):
  1. Создать задачу
  2. Получить результат
Ошибки:
1. Коды ошибок

Аккаунт

Баланс пользователя

Описание

Метод для получения текущего баланса пользователя с учетом заблокированных средств

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/account/balance	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя

Пример запроса

{
	"token": "<string>"
}

Ответ сервера

Название		Тип	Описание
success		boolean	Возвращает true в случае успеха или false в случае ошибки
content		array	Возвращает массив с результатом запроса или сообщение об ошибке
	balance	float	Текущий баланс пользователя с учетом заблокированных средств
	currency	string	Валюта в формате ISO 4217

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"balance": "<float>",
		"currency": "<string>"
	}
}

Общее

Список поисковых систем

Описание

Метод вернет список активных поисковых систем

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/globals/engines	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя

Пример запроса

{
	"token": "<string>"
}

Ответ сервера

Название			Тип	Описание
success			boolean	Возвращает true в случае успеха или false в случае ошибки
content			array	Возвращает массив с результатом запроса или сообщение об ошибке
	engines		array	Список активных поисковых систем
		id	numeric	Идентификатор поисковой системы
		name	string	Название поисковой системыtype
		depths	array	Допустимая глубина поиска
		prices	array	Стоимость проверки для выбранной глубины

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"engines": [{
			"id": "<numeric>",
			"name": "<string>",
			"depths": [
				"<numeric>"
			],
			"prices": [
				"<array>"
			]
		}]
	}
}

Список регионов поиска

Описание

Метод вернет список активных регионов поиска

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/globals/regions	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя
engine	numeric	Да	Идентификатор поисковой системы

Пример запроса

{
	"token": "<string>",
	"engine": "<numeric>"
}

Ответ сервера

Название			Тип	Описание
success			boolean	Возвращает true в случае успеха или false в случае ошибки
content			array	Возвращает массив с результатом запроса или сообщение об ошибке
	regions		array	Список активных регионов поиска
		id	numeric	Идентификатор региона поиска
		name	string	Название региона поиска

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"regions": [{
			"id": "<numeric>",
			"name": "<string>"
		}]
	}
}

Проекты

Список проектов

Описание

Метод вернет список проектов

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/projects/list	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя

Пример запроса

{
	"token": "<string>"
}

Ответ сервера

Название				Тип	Описание
success				boolean	Возвращает true в случае успеха или false в случае ошибки
content				array	Возвращает массив с результатом запроса или сообщение об ошибке
	projects			array	Список проектов
		id		numeric	Идентификатор проекта
		name		string	Название проекта
		domain		string	Адрес сайта
		group		array	Информация о группе
			id	numeric	Идентификатор группы
			name	string	Название группы
		keywords		array	Информация о запросах
			count	numeric	Количество запросов
		active		boolean	Статус проекта

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"projects": [{
			"id": "<numeric>",
			"name": "<string>",
			"domain": "<string>",
			"group": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"keywords": {
				"count": "<numeric>"
			},
			"active": "<boolean>"
		}]
	}
}

Параметры проекта

Описание

Методы параметров проекта

Поисковые системы проекта

Описание

Метод вернет список поисковых систем проекта

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/projects/settings/engines	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя
project	numeric	Да	Идентификатор проекта

Пример запроса

{
	"token": "<string>",
	"project": "<numeric>"
}

Ответ сервера

Название				Тип	Описание
success				boolean	Возвращает true в случае успеха или false в случае ошибки
content				array	Возвращает массив с результатом запроса или сообщение об ошибке
	engines			array	Список поисковых систем
		engine		array	Информация о поисковой системе
			id	numeric	Идентификатор поисковой системы
			name	string	Название поисковой системыtype
		active		boolean	Статус поисковой системы

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"engines": [{
			"engine": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"active": "<boolean>"
		}]
	}
}

Регионы поиска проекта

Описание

Метод вернет список регионов поиска проекта

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/projects/settings/engines/regions	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя
project	numeric	Да	Идентификатор проекта
engine	numeric	Да	Идентификатор поисковой системы

Пример запроса

{
	"token": "<string>",
	"project": "<numeric>",
	"engine": "<numeric>"
}

Ответ сервера

Название				Тип	Описание
success				boolean	Возвращает true в случае успеха или false в случае ошибки
content				array	Возвращает массив с результатом запроса или сообщение об ошибке
	regions			array	Список регионов поиска
		region		array	Информация о регионе
			id	numeric	Идентификатор региона
			name	string	Название региона
		active		boolean	Статус региона

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"regions": [{
			"region": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"active": "<boolean>"
		}]
	}
}

Отчеты по проекту

Описание

Методы отчетов по проекту

Отчет по позициям

Описание

Метод вернет отчет по позициям проекта

Запрос

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": "<string>",
	"project": "<numeric>",
	"engine": "<numeric>",
	"region": "<numeric>",
	"period": [
		"<YYYY-MM-DD/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	Название проекта
		engine		array	Информация о поисковой системе
			id	numeric	Идентификатор поисковой системы
			name	string	Название поисковой системыtype
		region		array	Информация о регионе поиска
			id	numeric	Идентификатор региона
			name	string	Название региона
		group		array	Информация о группе ключевого запроса
			id	numeric	Идентификатор группы ключевого запроса
			name	string	Название группы ключевого запроса
			sort	numeric	Порядковый номер группы ключевого запроса
		keyword		array	Информация о ключевом запросе
			id	numeric	Идентификатор ключевого запроса
			name	string	Название ключевого запроса
			sort	numeric	Порядковый номер ключевого запроса
		data		array	Данные по проверке
			position	numeric	Позиция сайта
			page	string	Страница сайта

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"reports": [{
			"created": {
				"date": "<string>",
				"timezone_type": "<string>",
				"timezone": "<string>"
			},
			"project": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"engine": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"region": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"group": {
				"id": "<numeric>",
				"name": "<string>",
				"sort": "<numeric>"
			},
			"keyword": {
				"id": "<numeric>",
				"name": "<string>",
				"sort": "<numeric>"
			},
			"data": {
				"position": "<numeric>",
				"page": "<string>"
			}
		}]
	}
}

Отчет по ТОП(ам)

Описание

Метод вернет отчет по топ(ам) проекта

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/projects/reports/tops	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя
project	numeric	Да	Идентификатор проекта
engine	numeric	Да	Идентификатор поисковой системы
region	numeric	Да	Идентификатор региона поиска
period	array	Да	Период проверки проекта в формате ISO 8601

Пример запроса

{
	"token": "<string>",
	"project": "<numeric>",
	"engine": "<numeric>",
	"region": "<numeric>",
	"period": [
		"<YYYY-MM-DD/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	Название проекта
		engine		array	Информация о поисковой системе
			id	numeric	Идентификатор поисковой системы
			name	string	Название поисковой системыtype
		region		array	Информация о регионе поиска
			id	numeric	Идентификатор региона
			name	string	Название региона
		group		array	Информация о группе ключевого запроса
			id	numeric	Идентификатор группы ключевого запроса
			name	string	Название группы ключевого запроса
			sort	numeric	Порядковый номер группы ключевого запроса
		keyword		array	Информация о ключевом запросе
			id	numeric	Идентификатор ключевого запроса
			name	string	Название ключевого запроса
			sort	numeric	Порядковый номер ключевого запроса
		data		array	Данные по проверке
			position	numeric	Позиция сайта
			page	string	Страница сайта

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"reports": [{
			"created": {
				"date": "<string>",
				"timezone_type": "<string>",
				"timezone": "<string>"
			},
			"project": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"engine": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"region": {
				"id": "<numeric>",
				"name": "<string>"
			},
			"group": {
				"id": "<numeric>",
				"name": "<string>",
				"sort": "<numeric>"
			},
			"keyword": {
				"id": "<numeric>",
				"name": "<string>",
				"sort": "<numeric>"
			},
			"data": {
				"position": "<numeric>",
				"page": "<string>"
			}
		}]
	}
}

Метрики

Проверка позиций

Описание

Методы проверки позиций

Создать задачу

Описание

Метод создает отложенную задачу на проверку позиций и возвращает идентификатор

Запрос

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": "<string>",
	"domain": "<string>",
	"keywords": [
		"<string>"
	],
	"engines": [{
		"engine": "<numeric>",
		"regions": "<array>",
		"depth": "<numeric>"
	}]
}

Ответ сервера

Название		Тип	Описание
success		boolean	Возвращает true в случае успеха или false в случае ошибки
content		array	Возвращает массив с результатом запроса или сообщение об ошибке
	task	string	Токен задачи для получения результатов

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"task": "<string>"
	}
}

Получить результат

Описание

Метод возвращает результат отложенной задачи

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/metrics/positions/task/result	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя
task	string	Да	Токен задачи для получения результатов

Пример запроса

{
	"token": "<string>",
	"task": "<string>"
}

Ответ сервера

Название						Тип	Описание
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": "<boolean>",
	"content": {
		"status": "<boolean>",
		"result": [{
			"keyword": "<string>",
			"engines": {
				"engine": "<numeric>",
				"regions": {
					"region": "<numeric>",
					"report": {
						"total": "<array>",
						"page": "<array>",
						"position": "<array>",
						"snippet": "<array>"
					}
				}
			}
		}]
	}
}

Проверка ТОП(а)

Описание

Методы проверки ТОП(а)

Создать задачу

Описание

Метод создает отложенную задачу на проверку ТОП(а) и возвращает идентификатор

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/metrics/tops/task/create	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название		Тип	Обязательно	Описание
token		string	Да	Токен авторизации пользователя
keywords		array	Да	Ключевые запросы для проверки
engines		array	Да	Поисковые системы и регионы поиска
	engine	numeric	Да	Идентификатор поисковой системы
	regions	array	Да	Идентификатор региона поиска
	depth	numeric	Да	Глубина поиска

Пример запроса

{
	"token": "<string>",
	"keywords": [
		"<string>"
	],
	"engines": [{
		"engine": "<numeric>",
		"regions": "<array>",
		"depth": "<numeric>"
	}]
}

Ответ сервера

Название		Тип	Описание
success		boolean	Возвращает true в случае успеха или false в случае ошибки
content		array	Возвращает массив с результатом запроса или сообщение об ошибке
	task	string	Токен задачи для получения результатов

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"task": "<string>"
	}
}

Получить результат

Описание

Метод возвращает результат отложенной задачи

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/metrics/tops/task/result	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя
task	string	Да	Токен задачи для получения результатов

Пример запроса

{
	"token": "<string>",
	"task": "<string>"
}

Ответ сервера

Название						Тип	Описание
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": "<boolean>",
	"content": {
		"status": "<boolean>",
		"result": [{
			"keyword": "<string>",
			"engines": {
				"engine": "<numeric>",
				"regions": {
					"region": "<numeric>",
					"report": {
						"total": "<array>",
						"pages": "<array>"
					}
				}
			}
		}]
	}
}

Проверка частоты

Описание

Методы проверки частоты

Создать задачу

Описание

Метод создает отложенную задачу на проверку частоты и возвращает идентификатор

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/metrics/frequency/task/create	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название		Тип	Обязательно	Описание
token		string	Да	Токен авторизации пользователя
keywords		array	Да	Ключевые запросы для проверки
engines		array	Да	Поисковые системы и регионы поиска
	engine	numeric	Да	Идентификатор поисковой системы
	regions	array	Да	Идентификатор региона поиска
type		array	Да	Тип соответствия
	1	numeric	Да	Широкое соответствие
	2	numeric	Да	Широкое с точной словоформой
	3	numeric	Да	Фразовое соответствие
	4	numeric	Да	Фразовое с точной словоформой
more		array	Нет	Дополнительно
	1	numeric	Нет	Подобрать похожие запросы

Пример запроса

{
	"token": "<string>",
	"keywords": [
		"<string>"
	],
	"engines": [{
		"engine": "<numeric>",
		"regions": "<array>"
	}],
	"type": [
		"<numeric>"
	],
	"more": [
		"<numeric>"
	]
}

Ответ сервера

Название		Тип	Описание
success		boolean	Возвращает true в случае успеха или false в случае ошибки
content		array	Возвращает массив с результатом запроса или сообщение об ошибке
	task	string	Токен задачи для получения результатов

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"task": "<string>"
	}
}

Получить результат

Описание

Метод возвращает результат отложенной задачи

Запрос

URL

Адрес метода	Метод запроса	Формат запроса
https://api.seolib.ru/metrics/frequency/task/result	POST	JSON

Заголовки

Заголовок	MIME Тип	Описание
Content-Type	application/json	Запрос в формате JSON

Параметры

Запрос к серверу

Название	Тип	Обязательно	Описание
token	string	Да	Токен авторизации пользователя
task	string	Да	Токен задачи для получения результатов

Пример запроса

{
	"token": "<string>",
	"task": "<string>"
}

Ответ сервера

Название						Тип	Описание
success						boolean	Возвращает true в случае успеха или false в случае ошибки
content						array	Возвращает массив с результатом запроса или сообщение об ошибке
	status					boolean	Возвращает true в случае готовности задачи или false если задача еще в работе
	result					array	Возвращает массив с результатом выполненной задачи
		keyword				string	Ключевой запрос
		phrases				array	Похожие запросы
		engines				array	Поисковые системы
			engine			numeric	Идентификатор поисковой системы
			regions			array	Регионы поиска
				region		numeric	Идентификатор региона поиска
				report		array	Отчет по результату поиска
					1	numeric	Широкое соответствие
					2	numeric	Широкое с точной словоформой
					3	numeric	Фразовое соответствие
					4	numeric	Фразовое с точной словоформой

Пример ответа

{
	"success": "<boolean>",
	"content": {
		"status": "<boolean>",
		"result": [{
			"keyword": "<string>",
			"phrases": [
				"<string>"
			],
			"engines": {
				"engine": "<numeric>",
				"regions": {
					"region": "<numeric>",
					"report": {
						"1": "<numeric>",
						"2": "<numeric>",
						"3": "<numeric>",
						"4": "<numeric>"
					}
				}
			}
		}]
	}
}

Ошибки

Коды ошибок

Описание

Список всех ошибок

Коды

Пример ответа

{
	"success": "<boolean>",
	"content": [
		"<string>"
	]
}