Api Интерфейс

Введение

API-интерфейс предоставляет возможность пользоваться базой keytoday.net с помощью сторонних программ, без использования веб-интерфейса базы. Для использования API-интерфейса необходимо иметь активный аккаунт в базе keytoday.net.

Формат запроса

Api-интерфейс расположен по адресу http://keytoday.net/api. Параметры могут передаваться в GET или POST массивах. Пример запроса:

Единственным обязательным параметром является секретный код skey. С помощью секретного кода происходит аутентификация пользователя. Свой секретный код вы можете узнать в разделе "Личный кабинет". Все остальные параметры не являются обязательными.

Общие параметры запроса

Параметр Описание Пример
skey Секретный код f08a0d853553be3d5d133cfda7ed4a5a
keyword Кейворд John Doe
lang Язык базы (ru или en) ru
limit Количество кейвордов, максимум 50000, по умолчанию 100 100
offset Сдвиг кейвордов, максимум 49999, по умолчанию 0 0
sortBy Поле, по которому будет происходить сортировка keyword
sortOrder Направление сортировки (ASC или DESC, по умлочанию ASC) ASC
skip_attrs Параметр, при использовании которого в выдаче будут присутствовать только кейворды, без атрибутов (true или false, по умолчанию false) true

Параметры запроса к русской базе кейвордов

Параметр Описание
keywordкейворд
showsКоличество запросов ключевого слова в месяц (Яндекс)
ctrCTR определяется как отношение числа кликов на рекламное объявление к числу показов, измеряется в процентах. Подробнее Справка Яндекс.Директ
fp_ctrCTR определяется как отношение числа кликов на рекламное объявление к числу показов, измеряется в процентах. Подробнее Справка Яндекс.Директ
p_ctrCTR определяется как отношение числа кликов на рекламное объявление к числу показов, измеряется в процентах. Подробнее о CTR Справка Яндекс.Директ
minЦена "входа в гарантированные показы" обеспечит объявлению гарантированные статические показы на одной из 4-х первых позиций справа. Объявления, у которых цена указана ниже цены "входа в гарантированные показы", могут показываться на позициях ниже 4-ой. Цены действительны при точном совпадении ключевой фразы (без стоп-слов) с запросом пользователя. Справка Яндекс.Директ
maxЦена "1-го места" обеспечит вашему объявлению первую позицию справа. Справка Яндекс.Директ
pminЦена "входа в спецразмещение" обеспечит вашему объявлению показы на позиции слева непосредственно над результатами поиска. Цены действительны при точном совпадении ключевой фразы (без стоп-слов) с запросом пользователя. Справка Яндекс.Директ

Параметры запроса к английской базе кейвордов

Параметр Описание
keywordкейворд
sitesОтносительное количество сайтов в выдаче поисковиков по данному кейворду, от 0 до 100.
popularityОтносительная частота запроса кейворда в поисковых системах, от 0 до 100
competitionОтносительная оценка количества рекламных объявлений для кейворда в основных поисковых системах, от 0 до 100

Формат выдачи

Выдача представляет собой xml документ, содержащий данные статистики текущего запроса, кейворды и их параметры. Пример выдачи:

<?xml version='1.0'?>
<!-- http://keytoday.net api xml output v1.0-->
<document>
	<statistic>
		<time>0.046</time>
		<totalFound>36</totalFound>
		<keywordsCount>1</keywordsCount>
	</statistic>
	<keywords>
		<keyword>a test-tube baby</keyword>
		<keywrod_sortable>4244</keywrod_sortable>
		<shows>31</shows>
		<ctr>3.22</ctr>
		<fp_ctr>3.54</fp_ctr>
		<p_ctr>6.45</p_ctr>
		<min>0</min>
		<max>0</max>
		<pmin>0.72</pmin>
	</keywords>
</document>

Описание полей выдачи

Выдача русской базы кейвордов

Смотри Параметры запроса к русской базе кейвордов.

Выдача английской базы кейвордов

Смотри Параметры запроса к английской базе кейвордов.

Ограничения

Минимальная пауза между запросами 5 секунд
Максимальное число запросов в сутки 10000
Максимальное число кейвордов в выдаче 50000