Документация для разработчиков › Справочник API

Эндпоинты Hive

Любое приложение или рынок, которые измеряет сеть Storelift, отслеживаете вы их или нет. Часть Hive Explorer.

Аутентификация · Кредиты · Общие параметры · Коды ошибок · openapi.json

GET /rank-check

Текущая позиция одного из ваших приложений по любому поисковому запросу в одной витрине, в том виде, как магазин показывает её прямо сейчас; запрос не обязательно отслеживать. Состояние различает случаи: ranked — с позицией и приложениями непосредственно выше, absent — с верхними результатами (приложение там продаётся, но находится за пределами этих результатов), not_in_store (приложение не продаётся в этой витрине).

Права
apps:read
Кредиты
10
Тариф
Free
ПараметрГдеТипОписание
appобязательныйquerystringссылка или id App Store либо ссылка или имя пакета Google Play
termобязательныйquerystringпоисковый запрос, например habit tracker
ccquerystringкод витрины, например us
platformqueryios | androidнеобязательно; определяется по ссылке на приложение
curl "https://storelift.net/v1/rank-check?app=us&term=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /keyword-difficulty

Данные о спросе и сложности для одного поискового запроса App Store в одной витрине: спрос (demand) и связанные запросы, верхние результаты с числом оценок и признаком, есть ли запрос в их названии, наибольшее и медианное число оценок среди них и глубина результатов. thin отмечает запрос, по которому меньше десяти результатов; zayifEslesme — запрос, который магазин сопоставляет нестрого. Free читает запросы, которые аккаунт отслеживает в этой витрине; Pro и выше — любой запрос.

Права
apps:read
Кредиты
10
Тариф
Free
ПараметрГдеТипОписание
termобязательныйquerystringпоисковый запрос, например habit tracker
ccquerystringкод витрины, например us
curl "https://storelift.net/v1/keyword-difficulty?term=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/find

Поиск приложений по топ-чартам, которые мы измеряем: фильтруйте по категории, витрине, чарту (Топ кассовых, Топ бесплатных, Топ платных или Топ iPad), диапазону позиций, дате первого появления, названию или издателю, а также по месячному доходу, месячным загрузкам или росту за 30 дней. Передайте estimates: true, чтобы получить из Hive месячный доход и загрузки по каждой строке — по одной цифре на показатель, с днём этой цифры. Если задан фильтр по доходу, загрузкам или росту, приложения, по которым у Hive ещё нет цифры, не попадают в список и учитываются в noEstimate. 20 кредитов за список; с цифрами или с фильтром по доходу, загрузкам или росту — ещё 50 за каждую возвращённую строку. В ответе есть coverage — день, с которого начинается индекс первых появлений, так что каждая дата, которую вы читаете, — это день, который мы проиндексировали.

Права
hive:read
Кредиты
20
Тариф
Hive Explorer
ПараметрГдеТипОписание
genrequerystringдо 3 id жанров Apple через запятую, например 6007,6012
countryquerystringдо 5 кодов витрин через запятую, например us,gb
kindquerystringgrossing, free, paid или ipad (в каком чарте находится приложение)
releasedquerynumberпервое появление за последние N месяцев
rankMinquerynumberлучшая позиция в чарте не меньше этой
rankMaxquerynumberлучшая позиция в чарте не больше этой
revenueMinquerynumberмесячный валовой доход не меньше этого (USD)
revenueMaxquerynumberмесячный валовой доход не больше этого (USD)
downloadsMinquerynumberмесячные загрузки не меньше этого
downloadsMaxquerynumberмесячные загрузки не больше этого
growthMinquerynumberизменение за 30 дней не меньше этого, в процентах (например 20)
growthMaxquerynumberизменение за 30 дней не больше этого, в процентах
textquerystringсовпадение по названию приложения или имени издателя
publisherquerystringid издателя из market_publisher
estimatesquerybooleantrue добавляет месячный доход и загрузки в каждую строку (50 кредитов за строку)
limitquerynumberстрок на странице, по умолчанию 50, до 200
pagequerynumberстраница результатов, по умолчанию 1
curl "https://storelift.net/v1/hive/find?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/charts

Один топ-чарт в том виде, в каком мы измерили его последний раз: id приложений по порядку для витрины, типа списка и необязательной категории, с днём чтения. Передайте estimates: true, чтобы получить месячное значение для каждого места (доход в Топе кассовых, загрузки в Топе бесплатных) и то, что нужно для входа на места 10, 50 и 100. 10 кредитов за список; с estimates — ещё 50 за каждую возвращённую строку. Только App Store: у Google Play нет публичного топа, и цифра там была бы выдуманной.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
kindquerystringfree, paid или grossing
genrequerystringid жанра Apple, например 6007; не указывайте для общего чарта
limitquerynumberсколько строк, до 100

Также принимает: country

curl "https://storelift.net/v1/hive/charts?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Открыть в песочнице

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

GET /hive/movers

Кто поднялся, кто упал, кто вошёл и кто покинул один топ-чарт по сравнению с тем же чартом N дней назад. measured сообщает, что день сравнения есть в данных, так что каждое изменение, которое вы читаете, лежит между двумя измеренными днями; у выбывших приложений вместо изменения указана последняя позиция, поскольку сегодня их в чарте нет.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
kindquerystringfree, paid или grossing
genrequerystringid жанра Apple; не указывайте для общего чарта
daysquerynumberсравнить с данными N дней назад, до 90
limitquerynumberстрок на каждое направление, до 100

Также принимает: country

curl "https://storelift.net/v1/hive/movers?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/new

Приложения, впервые замеченные в топ-чарте, сначала новые, с издателем каждого. daysCovered показывает, сколько из запрошенных дней есть в индексе, так что каждая дата первого появления, которую вы читаете, — это день, который мы проиндексировали.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
daysquerynumberза сколько последних дней смотреть (N), до 30
countryquerystringкод витрины; не указывайте для всех витрин
limitquerynumberстроки, до 200
curl "https://storelift.net/v1/hive/new?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/publisher/{publisherId}

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

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
publisherIdобязательныйpathstringid издателя, например из market_new_apps
curl "https://storelift.net/v1/hive/publisher/1000000900" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/resolve

Находит id любого приложения: по названию или разработчику (лучшие совпадения в этой витрине, с издателем, категорией, рейтингом и числом оценок) либо по ссылке App Store / Google Play, id App Store или имени пакета. Используйте перед hive_app_details, hive_similar_apps или hive_app_reviews, когда у вас есть только название.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
qобязательныйquerystringназвание приложения, имя разработчика, ссылка на магазин, id App Store или имя пакета
limitquerynumberрезультаты, до 25 (по умолчанию 10)

Также принимает: country

curl "https://storelift.net/v1/hive/resolve?q=sleep&country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/similar/{appId}

Блок похожих приложений самого магазина для любого приложения (You Might Also Like у Apple, Similar apps у Google) в порядке блока, с категорией, названием и издателем каждого приложения и днём чтения блока. Категории в блоке показывают, в какой круг приложений магазин помещает это приложение.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
appIdобязательныйpathstringid App Store (например 570060128) или имя пакета Google Play
countryquerystringкод витрины, например us (пусто = самый свежий блок, прочитанный в любой витрине)
curl "https://storelift.net/v1/hive/similar/sbx-lumen?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/reviews/{appId}

Недавние отзывы любого приложения в одной витрине, сначала новые: звёзды, заголовок, текст, версия и дата, а также распределение звёзд по возвращённым строкам. Имена авторов отзывов не включаются. Приложение, которого ещё нет в Hive, добавляется при первом вызове.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
appIdобязательныйpathstringid App Store (например 570060128) или имя пакета Google Play
limitquerynumberотзывы, до 200 (по умолчанию 50)

Также принимает: country

curl "https://storelift.net/v1/hive/reviews/sbx-lumen?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

POST /hive/keywords/{term}/metrics/measure

Запускает измерение популярности и/или сложности одного ключевого слова в одной витрине, когда сохранённого значения нет или оно устарело. Свежее значение или подтверждённое отсутствие возвращается без новой работы; запрос, который присоединяется к уже идущему заданию, не расходует дневную единицу измерений; запрос, который запускает новую работу, расходует одну единицу из дневного лимита измерений Hive рабочего пространства. Две метрики независимы: если один источник дал сбой, другая, корректная метрика остаётся в ответе. wait (0–20 секунд) держит вызов открытым, пока результат не сохранится; 202 означает, что измерение ещё идёт, — прочитайте его позже через hive_keyword_metrics. Нужна отдельно включаемая область доступа hive:measure: её выбирают в ключе API или отдельно подтверждают при подключении через OAuth. Только iOS.

Права
hive:measure
Кредиты
50
Тариф
Hive Explorer
ПараметрГдеТипОписание
termобязательныйpathstringточное ключевое слово, например habit tracker
countrybodystringкод витрины, например us (по умолчанию us)
platformbodystring
metricsbodyarrayкакие метрики измерять (по умолчанию обе)
waitbodynumberсколько секунд ждать сохранённого результата, 0–20 (если не указано, этот инструмент отправляет 15; в HTTP API по умолчанию 0)

Запуск новой работы расходует один замер из дневной квоты Hive рабочего пространства, поэтому команды для копирования здесь нет.

Тело запроса

{"country":"us","platform":"ios","metrics":["popularity","difficulty"],"wait":15}

GET /hive/apps/{id}

Данные магазина, которые сеть измерила для любого приложения в его последний день: название, число оценок, рейтинг, версия, цена, распространение, значок и число покупок в приложении. Для приложений App Store listingExtras добавляет поддерживаемые языки, распределение оценок по звёздам (от 1★ до 5★), текущие и предстоящие события в приложении, рекламный текст и продвигаемые покупки в приложении со своим measuredAt; без измерения — null. not_measured указывает витрины, в которые нужно добавить приложение.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
idобязательныйpathstringId App Store (5–12 цифр) или имя пакета Google Play.

Также принимает: country

curl "https://storelift.net/v1/hive/apps/1000000001?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Открыть в песочнице

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

GET /hive/keywords/{term}/ranks

Верхние результаты по любому ключевому слову, которое измеряет сеть, по дням. days уменьшается, когда top велик, чтобы один вызов не превышал 1000 строк. 10 кредитов за период до 7 дней, 20 — до 30, 40 — до 90.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
termобязательныйpathstring
topqueryinteger
daysqueryinteger

Также принимает: country · platform

curl "https://storelift.net/v1/hive/keywords/sleep/ranks?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Открыть в песочнице

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

GET /hive/keywords/{term}/metrics

Читает имеющиеся наблюдения Hive для одного точного ключевого слова и витрины. Популярность — целое число от 1 до 100; сложность — оценка от 0 до 100. Отсутствующие данные остаются null. У каждой метрики свои подтверждающие данные, время источника, актуальность и статус последней попытки. Этот GET никогда не запускает запрос к источнику или задание измерения. Нужен полный продукт Hive Explorer; Android явно не поддерживается.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
termобязательныйpathstringНормализовано по NFC, без пробелов по краям, в нижнем регистре. Пробелы внутри остаются значимыми.
platformqueryiosпо умолчанию ios

Также принимает: country

curl "https://storelift.net/v1/hive/keywords/sleep/metrics?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Открыть в песочнице

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

GET /hive/keywords/{term}/metrics/history

Читает сохранённую ежедневную историю ключевого слова: результаты поиска, оценку сложности и популярность Apple, записанные за каждый день. Прошлые значения сложности остаются такими, какими были записаны. Дни со сбоем и неполные дни так и помечены; день без сохранённой записи — это не ноль и не подтверждённое отсутствие. Следуйте по pagination.nextCursor с теми же ключевым словом, витриной и днями. Каждый ряд разбивается на страницы отдельно, до 200 записей на страницу. Этот GET читает только сохранённую историю и никогда не запускает измерение. Нужен полный продукт Hive Explorer; Android явно не поддерживается. 10 кредитов за период до 7 дней, 20 — до 30, 40 — до 90.

Права
hive:read
Кредиты
20
Тариф
Hive Explorer
ПараметрГдеТипОписание
termобязательныйpathstringНормализовано по NFC, без пробелов по краям, в нижнем регистре. Пробелы внутри остаются значимыми.
platformqueryiosпо умолчанию ios
daysqueryintegerКалендарные дни по UTC, включая сегодня. Версии популярности выбираются по началу их исходной недели в пределах этого диапазона.
cursorquerystringНепрозрачный маркер продолжения из pagination.nextCursor этого же запроса.

Также принимает: country

curl "https://storelift.net/v1/hive/keywords/sleep/metrics/history?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Открыть в песочнице

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

GET /hive/spy/{id}

Все ключевые слова, по которым сеть измерила приложение, с позицией. Каждый вызов оплачивается кредитами; приложение, по которому нечего показать, стоит 1.

Права
hive:spy
Кредиты
200
Тариф
Hive Explorer
ПараметрГдеТипОписание
idобязательныйpathstringId App Store (5–12 цифр) или имя пакета Google Play.

Также принимает: country · platform

curl "https://storelift.net/v1/hive/spy/1000000104?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Открыть в песочнице

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

GET /hive/estimate/{id}

Месячный доход и загрузки любого приложения App Store по всему миру: по одной цифре на показатель (value или under, когда приложение ниже этой суммы) и число охваченных рынков. Ответ есть по каждому приложению. Hive уже знает их. Первый запрос по приложению запускает чтение и отвечает 202 с eta в секундах. 500 кредитов за цифры; ответ со статусом ожидания стоит 1.

Права
hive:estimate
Кредиты
500
Тариф
Hive Explorer
ПараметрГдеТипОписание
idобязательныйpathstringId App Store.

Также принимает: country

curl "https://storelift.net/v1/hive/estimate/1000000001?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

Открыть в песочнице

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

GET /hive/gap

Списки ключевых слов до 5 приложений рядом, по строке на ключевое слово: позиция каждого приложения, у скольких оно есть и у каких отсутствует. 200 кредитов за каждое сравниваемое приложение; за приложение вне индекса плата не взимается. Входит в Explorer.

Права
hive:spy
Кредиты
400
Тариф
Hive Explorer
ПараметрГдеТипОписание
idsобязательныйquerystringId приложений через запятую, минимум 2.

Также принимает: country · platform

curl "https://storelift.net/v1/hive/gap?ids=1000000001,1000000104&country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/research

Введите исходное ключевое слово и получите связанные поисковые запросы App Store, каждый с популярностью Apple (1–100, когда она наблюдалась; отсутствующие значения остаются null), сложностью (0–100), числом приложений, которые ранжируются по нему, и топ-10 приложений. Подтверждающие данные метрики различают измеренное значение, подтверждённое отсутствие, работу в ожидании и ошибки источника. Строки с активным измерением содержат state: "pending"; повторите запрос, чтобы прочитать результат. Если App Store исправляет написание термина, строка содержит spell с исправленным запросом. Приложение не требуется. Входит в Explorer.

Права
hive:read
Кредиты
50
Тариф
Hive Explorer
ПараметрГдеТипОписание
seedобязательныйquerystringИсходное ключевое слово.
comparequerystringДо 5 дополнительных витрин через запятую (например de,fr): популярность, сложность и число приложений по тем же запросам в каждой.

Также принимает: country

curl "https://storelift.net/v1/hive/research?seed=us&country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/landscape

Картина категорий витрины по её списку бесплатных приложений: «стена» оценок топ-10, медианный рейтинг, длина названия, свежесть релизов и обновлений, языки, размер и издатели с несколькими приложениями. У каждой категории свой день измерения.

Права
hive:read
Кредиты
10
Тариф
Hive Explorer
ПараметрГдеТипОписание
genrequerystringId жанра App Store (например 6014) или ключ категории (all, games, entertainment, photo-video, productivity, health-fitness, education, lifestyle, finance, social-networking). Не указывайте, чтобы получить все измеренные категории.

Также принимает: country

curl "https://storelift.net/v1/hive/landscape?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"