Documentação para desenvolvedores › Referência da API

Endpoints do Hive

Qualquer app ou mercado que a rede do Storelift mede, quer você o acompanhe ou não. Faz parte do Hive Explorer.

Autenticação · Créditos · Parâmetros comuns · Códigos de erro · openapi.json

GET /rank-check

A posição ao vivo de um dos seus apps para qualquer termo de busca em uma loja, do jeito que a loja mostra agora mesmo; o termo não precisa ser acompanhado. O estado separa os casos: ranked, com a posição e os apps logo acima; absent, com os primeiros resultados (o app é vendido ali e fica fora desses resultados); not_in_store (o app não é vendido nessa loja).

Escopo
apps:read
Créditos
10
Plano
Free
ParâmetroLocalTipoDescrição
appobrigatórioquerystringlink ou id da App Store, ou link ou nome do pacote do Google Play
termobrigatórioquerystringtermo de busca, ex.: habit tracker
ccquerystringcódigo da loja, ex.: us
platformqueryios | androidopcional; lido do link do app
curl "https://storelift.net/v1/rank-check?app=us&term=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /keyword-difficulty

Dados de demanda e dificuldade de um termo de busca da App Store em uma loja: a demanda (demand) e as buscas relacionadas, os primeiros resultados com o número de notas de cada um e se o termo está no título, o maior número de notas e a mediana entre eles, e até onde os resultados vão. thin marca um termo com menos de dez resultados; zayifEslesme marca um termo que a loja associa de forma aproximada. O Free lê os termos que a conta acompanha nessa loja; o Pro e acima leem qualquer termo.

Escopo
apps:read
Créditos
10
Plano
Free
ParâmetroLocalTipoDescrição
termobrigatórioquerystringtermo de busca, ex.: habit tracker
ccquerystringcódigo da loja, ex.: us
curl "https://storelift.net/v1/keyword-difficulty?term=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/find

Encontre apps nas paradas que medimos: filtre por categoria, loja, parada (Maior faturamento, Top gratuitos, Top pagos ou Top iPad), faixa de posições, data da primeira aparição, nome ou desenvolvedor, e por receita mensal, downloads mensais ou crescimento em 30 dias. Envie estimates: true para receber a receita e os downloads mensais de cada linha a partir do Hive, um número para cada, com o dia do número. Quando há um filtro de receita, downloads ou crescimento, os apps para os quais o Hive ainda não tem número ficam de fora e são contados em noEstimate. 20 créditos pela lista; com números, ou com um filtro de receita, downloads ou crescimento, mais 50 por linha retornada. A resposta traz coverage, o dia em que o índice de primeiras aparições começa, então toda data que você lê é um dia que indexamos.

Escopo
hive:read
Créditos
20
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
genrequerystringaté 3 ids de gênero da Apple, separados por vírgula, ex.: 6007,6012
countryquerystringaté 5 códigos de loja, separados por vírgula, ex.: us,gb
kindquerystringgrossing, free, paid ou ipad (em qual parada o app está)
releasedquerynumberprimeira aparição nos últimos N meses
rankMinquerynumbermelhor posição na parada no mínimo esta
rankMaxquerynumbermelhor posição na parada no máximo esta
revenueMinquerynumberreceita bruta mensal no mínimo esta (USD)
revenueMaxquerynumberreceita bruta mensal no máximo esta (USD)
downloadsMinquerynumberdownloads mensais no mínimo este valor
downloadsMaxquerynumberdownloads mensais no máximo este valor
growthMinquerynumbervariação em 30 dias no mínimo esta, em porcentagem (ex.: 20)
growthMaxquerynumbervariação em 30 dias no máximo esta, em porcentagem
textquerystringcorresponde ao nome do app ou do desenvolvedor
publisherquerystringid do desenvolvedor, de market_publisher
estimatesquerybooleantrue adiciona a receita e os downloads mensais a cada linha (50 créditos por linha)
limitquerynumberlinhas por página, 50 por padrão, até 200
pagequerynumberpágina de resultados, 1 por padrão
curl "https://storelift.net/v1/hive/find?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/charts

Uma parada como a medimos pela última vez: os ids dos apps em ordem para uma loja, um tipo de lista e uma categoria opcional, com o dia em que foi lida. Envie estimates: true para receber o valor mensal de cada posição (receita em Maior faturamento, downloads em Top gratuitos) e o que é preciso para entrar em #10, #50 e #100. 10 créditos pela lista; com estimates, mais 50 por linha retornada. Só App Store: o Google Play não tem uma parada pública, e um número ali seria inventado.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
kindquerystringfree, paid ou grossing
genrequerystringid de gênero da Apple, ex.: 6007; omita para a parada geral
limitquerynumberquantas linhas, até 100

Também aceita: country

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

Abrir no sandbox

Resposta de exemplo

GET /hive/movers

Quem subiu, quem caiu, quem entrou e quem saiu de uma parada, em comparação com a mesma parada de N dias atrás. measured informa que o dia de comparação está disponível, então toda variação que você lê fica entre dois dias medidos; os apps que saíram trazem a última posição em vez de uma variação, já que hoje estão fora da parada.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
kindquerystringfree, paid ou grossing
genrequerystringid de gênero da Apple; omita para a parada geral
daysquerynumbercomparar com N dias atrás, até 90
limitquerynumberlinhas por direção, até 100

Também aceita: country

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

GET /hive/new

Apps vistos em uma parada pela primeira vez, do mais recente para o mais antigo, com o desenvolvedor de cada um. daysCovered informa quantos dos dias pedidos o índice contém, então toda data de primeira aparição que você lê é um dia que indexamos.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
daysquerynumbervoltar N dias, até 30
countryquerystringcódigo da loja; omita para todas as lojas
limitquerynumberlinhas, até 200
curl "https://storelift.net/v1/hive/new?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/publisher/{publisherId}

Todos os apps de um desenvolvedor que já vimos em uma parada, com o dia em que cada um foi visto pela primeira vez. Os apps do desenvolvedor que nunca entraram em uma parada não estão aqui: listamos o que medimos, não tudo o que existe.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
publisherIdobrigatóriopathstringid do desenvolvedor, ex.: de market_new_apps
curl "https://storelift.net/v1/hive/publisher/1000000900" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/resolve

Encontre o id de qualquer app: por nome ou desenvolvedor (os melhores resultados nessa loja, com desenvolvedor, categoria, nota e número de notas), ou a partir de um link da App Store / Google Play, de um id da App Store ou de um nome de pacote. Use antes de hive_app_details, hive_similar_apps ou hive_app_reviews quando você só tiver um nome.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
qobrigatórioquerystringnome do app, nome do desenvolvedor, link da loja, id da App Store ou nome do pacote
limitquerynumberresultados, até 25 (padrão 10)

Também aceita: country

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

GET /hive/similar/{appId}

A seção de apps semelhantes da própria loja para qualquer app (You Might Also Like da Apple, Similar apps do Google), na ordem da seção, com a categoria, o nome e o desenvolvedor de cada app e o dia em que a seção foi lida. As categorias da seção mostram em que grupo a loja coloca o app.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
appIdobrigatóriopathstringid da App Store (ex.: 570060128) ou nome do pacote do Google Play
countryquerystringcódigo da loja, ex.: us (vazio = a seção mais recente lida em qualquer loja)
curl "https://storelift.net/v1/hive/similar/sbx-lumen?country=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET /hive/reviews/{appId}

As avaliações recentes de qualquer app em uma loja, da mais recente para a mais antiga: estrelas, título, texto, versão e data, além da distribuição de estrelas das linhas retornadas. Os nomes de quem avaliou ficam de fora. Um app que o Hive ainda não tem é incluído na primeira chamada.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
appIdobrigatóriopathstringid da App Store (ex.: 570060128) ou nome do pacote do Google Play
limitquerynumberavaliações, até 200 (padrão 50)

Também aceita: country

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

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

Inicia uma medição da popularidade e/ou da dificuldade de uma palavra-chave em uma loja quando o valor guardado está ausente ou desatualizado. Um valor recente ou uma ausência verificada é retornado sem trabalho novo; uma solicitação que se junta a um trabalho já em andamento não consome nenhuma unidade de medição diária; a solicitação que inicia um trabalho novo consome uma da cota diária de medições do Hive do espaço de trabalho. As duas métricas são independentes: se uma fonte falha, a outra métrica válida continua na resposta. wait (0–20 segundos) mantém a chamada aberta até o resultado ser guardado; 202 significa que ainda está em andamento: leia depois com hive_keyword_metrics. Precisa do escopo opcional hive:measure: escolhido na chave de API ou aprovado à parte ao conectar via OAuth. Só iOS.

Escopo
hive:measure
Créditos
50
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
termobrigatóriopathstringpalavra-chave exata, ex.: habit tracker
countrybodystringcódigo da loja, ex.: us (padrão us)
platformbodystring
metricsbodyarrayquais métricas medir (padrão: as duas)
waitbodynumbersegundos de espera pelo resultado guardado, 0–20 (esta ferramenta envia 15 quando omitido; o padrão da API HTTP é 0)

Iniciar um trabalho novo usa uma medição da cota diária de medições do Hive do workspace, então não há comando para copiar aqui.

Corpo da requisição

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

GET /hive/apps/{id}

Os dados da loja que a rede mediu para qualquer app no dia mais recente: nome, número de notas, nota, versão, preço, distribuição, selo e número de compras no app. Em apps da App Store, listingExtras acrescenta os idiomas suportados, a distribuição de estrelas (de 1★ a 5★), os eventos no app em andamento e futuros, o texto promocional e as compras no app em destaque, com seu próprio measuredAt; é null quando não foi medido. not_measured indica as lojas às quais adicionar o app.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
idobrigatóriopathstringId da App Store (5–12 dígitos) ou nome do pacote do Google Play.

Também aceita: country

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

Abrir no sandbox

Resposta de exemplo

GET /hive/keywords/{term}/ranks

Os primeiros resultados de qualquer palavra-chave que a rede mede, por dia. days diminui quando top é grande, para que uma chamada fique abaixo de 1.000 linhas. 10 créditos para até 7 dias, 20 para até 30 e 40 para até 90.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
termobrigatóriopathstring
topqueryinteger
daysqueryinteger

Também aceita: country · platform

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

Abrir no sandbox

Resposta de exemplo

GET /hive/keywords/{term}/metrics

Lê as observações existentes do Hive para uma palavra-chave exata e uma loja. A popularidade é um inteiro de 1 a 100; a dificuldade é uma pontuação de 0 a 100. Dados ausentes continuam null. Cada métrica traz sua própria evidência, o horário da fonte, a atualidade e o status da última tentativa. Este GET nunca inicia uma solicitação à fonte nem um trabalho de medição. Exige o produto Hive Explorer completo; o Android é explicitamente não compatível.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
termobrigatóriopathstringNormalizada em NFC, sem espaços nas pontas e em minúsculas. Os espaços internos continuam significativos.
platformqueryiospadrão: ios

Também aceita: country

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

Abrir no sandbox

Resposta de exemplo

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

Lê o histórico diário guardado de uma palavra-chave: os resultados de busca, a pontuação de dificuldade e a popularidade da Apple registrados em cada dia. Os valores de dificuldade anteriores ficam como foram registrados. Dias com falha ou incompletos são marcados como tais; um dia sem registro guardado não é um zero nem uma ausência verificada. Siga pagination.nextCursor com a mesma palavra-chave, loja e dias. Cada série é paginada separadamente, com até 200 registros por página. Este GET lê apenas o histórico guardado e nunca inicia uma medição. Exige o produto Hive Explorer completo; o Android é explicitamente não compatível. 10 créditos para até 7 dias, 20 para até 30 e 40 para até 90.

Escopo
hive:read
Créditos
20
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
termobrigatóriopathstringNormalizada em NFC, sem espaços nas pontas e em minúsculas. Os espaços internos continuam significativos.
platformqueryiospadrão: ios
daysqueryintegerDias corridos em UTC, incluindo hoje. As revisões de popularidade são selecionadas pelo início da semana de origem dentro deste intervalo.
cursorquerystringContinuação opaca vinda de pagination.nextCursor desta mesma consulta.

Também aceita: country

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

Abrir no sandbox

Resposta de exemplo

GET /hive/spy/{id}

Todas as palavras-chave em que a rede mediu um app, com a posição. Toda chamada é paga em créditos; um app sem palavras-chave para mostrar custa 1.

Escopo
hive:spy
Créditos
200
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
idobrigatóriopathstringId da App Store (5–12 dígitos) ou nome do pacote do Google Play.

Também aceita: country · platform

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

Abrir no sandbox

Resposta de exemplo

GET /hive/estimate/{id}

Receita e downloads mensais de qualquer app da App Store, no mundo inteiro: um número para cada (value, ou under quando o app está abaixo desse valor) e quantos mercados ele cobre. Todo app recebe uma resposta. O Hive já conhece todos. A primeira solicitação para um app inicia a leitura e responde 202 com eta segundos. 500 créditos pelos números; uma resposta pendente custa 1.

Escopo
hive:estimate
Créditos
500
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
idobrigatóriopathstringId da App Store.

Também aceita: country

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

Abrir no sandbox

Resposta de exemplo

GET /hive/gap

As listas de palavras-chave de até 5 apps lado a lado, uma linha por palavra-chave: a posição de cada app, quantos a têm e quais estão faltando. 200 créditos por app comparado; um app fora do índice não é cobrado. Parte do Explorer.

Escopo
hive:spy
Créditos
400
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
idsobrigatórioquerystringIds de apps separados por vírgula, pelo menos 2.

Também aceita: country · platform

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

GET /hive/research

Digite uma palavra-chave semente e receba termos de busca relacionados da App Store, cada um com a popularidade da Apple (1–100 quando observada; valores ausentes continuam null), a dificuldade (0–100), quantos apps ranqueiam para ele e os 10 primeiros apps. A evidência de cada métrica distingue um valor medido, uma ausência verificada, um trabalho pendente e erros da fonte. Linhas com medição ativa trazem state: "pending"; repita a solicitação para ler o resultado. Quando a App Store corrige a grafia de um termo, a linha traz spell com a busca corrigida. Não precisa de app. Parte do Explorer.

Escopo
hive:read
Créditos
50
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
seedobrigatórioquerystringPalavra-chave semente.
comparequerystringAté mais 5 lojas, separadas por vírgula (ex.: de,fr): popularidade, dificuldade e número de apps dos mesmos termos em cada uma.

Também aceita: country

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

GET /hive/landscape

O panorama de categorias de uma loja a partir da lista de gratuitos: a barreira de notas do top 10, a mediana de nota, o tamanho do nome, a atualidade de lançamentos e atualizações, os idiomas, o tamanho e os desenvolvedores com vários apps. Cada categoria traz seu próprio dia de medição.

Escopo
hive:read
Créditos
10
Plano
Hive Explorer
ParâmetroLocalTipoDescrição
genrequerystringId de gênero da App Store (ex.: 6014) ou uma chave de categoria (all, games, entertainment, photo-video, productivity, health-fitness, education, lifestyle, finance, social-networking). Omita para todas as categorias medidas.

Também aceita: country

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