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).
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
appobrigatório | query | string | link ou id da App Store, ou link ou nome do pacote do Google Play |
termobrigatório | query | string | termo de busca, ex.: habit tracker |
cc | query | string | código da loja, ex.: us |
platform | query | ios | android | opcional; 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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
termobrigatório | query | string | termo de busca, ex.: habit tracker |
cc | query | string | có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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
genre | query | string | até 3 ids de gênero da Apple, separados por vírgula, ex.: 6007,6012 |
country | query | string | até 5 códigos de loja, separados por vírgula, ex.: us,gb |
kind | query | string | grossing, free, paid ou ipad (em qual parada o app está) |
released | query | number | primeira aparição nos últimos N meses |
rankMin | query | number | melhor posição na parada no mínimo esta |
rankMax | query | number | melhor posição na parada no máximo esta |
revenueMin | query | number | receita bruta mensal no mínimo esta (USD) |
revenueMax | query | number | receita bruta mensal no máximo esta (USD) |
downloadsMin | query | number | downloads mensais no mínimo este valor |
downloadsMax | query | number | downloads mensais no máximo este valor |
growthMin | query | number | variação em 30 dias no mínimo esta, em porcentagem (ex.: 20) |
growthMax | query | number | variação em 30 dias no máximo esta, em porcentagem |
text | query | string | corresponde ao nome do app ou do desenvolvedor |
publisher | query | string | id do desenvolvedor, de market_publisher |
estimates | query | boolean | true adiciona a receita e os downloads mensais a cada linha (50 créditos por linha) |
limit | query | number | linhas por página, 50 por padrão, até 200 |
page | query | number | pá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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
kind | query | string | free, paid ou grossing |
genre | query | string | id de gênero da Apple, ex.: 6007; omita para a parada geral |
limit | query | number | quantas linhas, até 100 |
Também aceita: country
curl "https://storelift.net/v1/hive/charts?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
kind | query | string | free, paid ou grossing |
genre | query | string | id de gênero da Apple; omita para a parada geral |
days | query | number | comparar com N dias atrás, até 90 |
limit | query | number | linhas 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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
days | query | number | voltar N dias, até 30 |
country | query | string | código da loja; omita para todas as lojas |
limit | query | number | linhas, 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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
publisherIdobrigatório | path | string | id 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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
qobrigatório | query | string | nome do app, nome do desenvolvedor, link da loja, id da App Store ou nome do pacote |
limit | query | number | resultados, 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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
appIdobrigatório | path | string | id da App Store (ex.: 570060128) ou nome do pacote do Google Play |
country | query | string | có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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
appIdobrigatório | path | string | id da App Store (ex.: 570060128) ou nome do pacote do Google Play |
limit | query | number | avaliaçõ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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
termobrigatório | path | string | palavra-chave exata, ex.: habit tracker |
country | body | string | código da loja, ex.: us (padrão us) |
platform | body | string | |
metrics | body | array | quais métricas medir (padrão: as duas) |
wait | body | number | segundos 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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
idobrigatório | path | string | Id 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"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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
termobrigatório | path | string | |
top | query | integer | |
days | query | integer |
Também aceita: country · platform
curl "https://storelift.net/v1/hive/keywords/sleep/ranks?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
termobrigatório | path | string | Normalizada em NFC, sem espaços nas pontas e em minúsculas. Os espaços internos continuam significativos. |
platform | query | ios | padrão: ios |
Também aceita: country
curl "https://storelift.net/v1/hive/keywords/sleep/metrics?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
termobrigatório | path | string | Normalizada em NFC, sem espaços nas pontas e em minúsculas. Os espaços internos continuam significativos. |
platform | query | ios | padrão: ios |
days | query | integer | Dias corridos em UTC, incluindo hoje. As revisões de popularidade são selecionadas pelo início da semana de origem dentro deste intervalo. |
cursor | query | string | Continuaçã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"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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
idobrigatório | path | string | Id 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"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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
idobrigatório | path | string | Id da App Store. |
Também aceita: country
curl "https://storelift.net/v1/hive/estimate/1000000001?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
idsobrigatório | query | string | Ids 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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
seedobrigatório | query | string | Palavra-chave semente. |
compare | query | string | Até 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.
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
genre | query | string | Id 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"