Documentation développeur › Référence de l'API
Endpoints Hive
N'importe quelle app ou n'importe quel marché que mesure le réseau Storelift, que vous les suiviez ou non. Fait partie de Hive Explorer.
Authentification · Crédits · Paramètres communs · Codes d'erreur · openapi.json
GET /rank-check
La position en direct de l’une de vos apps pour n’importe quel terme de recherche dans un pays, telle que le store l’affiche à l’instant — le terme n’a pas besoin d’être suivi. L’état distingue les cas : ranked avec la position et les apps juste au-dessus, absent avec les premiers résultats (l’app y est vendue et se trouve hors de ces résultats), not_in_store (l’app n’est pas vendue dans ce pays).
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
appobligatoire | query | string | lien ou identifiant App Store, ou lien ou nom de paquet Google Play |
termobligatoire | query | string | terme de recherche, p. ex. habit tracker |
cc | query | string | code pays, p. ex. us |
platform | query | ios | android | facultatif ; lu à partir du lien de l’app |
curl "https://storelift.net/v1/rank-check?app=us&term=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /keyword-difficulty
Données de demande et de difficulté pour un terme de recherche App Store dans un pays : sa demande (demand) et les recherches associées, les premiers résultats avec leur nombre de notes et la présence ou non du terme dans leur titre, le nombre de notes le plus élevé et le nombre médian parmi eux, et la profondeur des résultats. thin signale un terme avec moins de dix résultats ; zayifEslesme signale un terme que le store associe de façon approximative. Free lit les termes que le compte suit dans ce pays ; à partir de Pro, n’importe quel terme.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
termobligatoire | query | string | terme de recherche, p. ex. habit tracker |
cc | query | string | code pays, p. ex. us |
curl "https://storelift.net/v1/keyword-difficulty?term=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /hive/find
Trouve des apps dans les classements que nous mesurons : filtrez par catégorie, pays, classement (Top Grossing, Top Free, Top Paid ou Top iPad), plage de positions, date de première apparition, nom ou éditeur, et par revenus mensuels, téléchargements mensuels ou croissance sur 30 jours. Passez estimates: true pour obtenir les revenus et téléchargements mensuels de chaque ligne depuis Hive, un chiffre pour chacun, avec le jour du chiffre. Lorsqu’un filtre de revenus, de téléchargements ou de croissance est défini, les apps pour lesquelles Hive n’a pas encore de chiffre sont exclues et comptées dans noEstimate. 20 crédits pour la liste ; avec les chiffres, ou avec un filtre de revenus, de téléchargements ou de croissance, 50 de plus par ligne renvoyée. La réponse contient coverage, le jour où commence l’index des premières apparitions ; chaque date que vous lisez est donc un jour que nous avons indexé.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
genre | query | string | jusqu’à 3 identifiants de genre Apple, séparés par des virgules, p. ex. 6007,6012 |
country | query | string | jusqu’à 5 codes pays, séparés par des virgules, p. ex. us,gb |
kind | query | string | grossing, free, paid ou ipad (le classement où figure l’app) |
released | query | number | vue pour la première fois au cours des N derniers mois |
rankMin | query | number | meilleure position au classement d’au moins cette valeur |
rankMax | query | number | meilleure position au classement d’au plus cette valeur |
revenueMin | query | number | revenus bruts mensuels d’au moins cette valeur (USD) |
revenueMax | query | number | revenus bruts mensuels d’au plus cette valeur (USD) |
downloadsMin | query | number | téléchargements mensuels d’au moins cette valeur |
downloadsMax | query | number | téléchargements mensuels d’au plus cette valeur |
growthMin | query | number | variation sur 30 jours d’au moins cette valeur, en pourcentage (p. ex. 20) |
growthMax | query | number | variation sur 30 jours d’au plus cette valeur, en pourcentage |
text | query | string | correspondance sur le nom de l’app ou le nom de l’éditeur |
publisher | query | string | identifiant d’éditeur issu de market_publisher |
estimates | query | boolean | true ajoute les revenus et téléchargements mensuels à chaque ligne (50 crédits par ligne) |
limit | query | number | lignes par page, 50 par défaut, jusqu’à 200 |
page | query | number | page de résultats, 1 par défaut |
curl "https://storelift.net/v1/hive/find?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /hive/charts
Un classement tel que nous l’avons mesuré en dernier : les identifiants d’apps classés pour un pays, un type de liste et une catégorie facultative, avec le jour de la lecture. Passez estimates: true pour la valeur mensuelle de chaque position (revenus sur Top Grossing, téléchargements sur Top Free) et ce qu’il faut pour entrer à la 10e, la 50e et la 100e place. 10 crédits pour la liste ; avec estimates, 50 de plus par ligne renvoyée. App Store uniquement — Google Play n’a pas de classement public, et un chiffre y serait inventé.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
kind | query | string | free, paid ou grossing |
genre | query | string | identifiant de genre Apple, p. ex. 6007 ; omettre pour le classement général |
limit | query | number | nombre de lignes, jusqu’à 100 |
Accepte aussi: country
curl "https://storelift.net/v1/hive/charts?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Exemple de réponse
GET /hive/movers
Qui a monté, qui a baissé, qui est entré et qui est sorti d’un classement, par rapport au même classement il y a N jours. measured vous indique que le jour de comparaison est disponible ; chaque écart que vous lisez se situe donc entre deux jours mesurés. Les apps sorties portent leur dernière position plutôt qu’un écart, puisqu’elles sont aujourd’hui hors du classement.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
kind | query | string | free, paid ou grossing |
genre | query | string | identifiant de genre Apple ; omettre pour le classement général |
days | query | number | comparer avec il y a N jours, jusqu’à 90 |
limit | query | number | lignes par sens, jusqu’à 100 |
Accepte aussi: country
curl "https://storelift.net/v1/hive/movers?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /hive/new
Apps vues pour la première fois dans un classement, de la plus récente à la plus ancienne, avec l’éditeur derrière chacune. daysCovered indique combien des jours demandés l’index contient ; chaque date de première apparition que vous lisez est donc un jour que nous avons indexé.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
days | query | number | remonter de N jours, jusqu’à 30 |
country | query | string | code pays ; omettre pour tous les pays |
limit | query | number | lignes, jusqu’à 200 |
curl "https://storelift.net/v1/hive/new?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /hive/publisher/{publisherId}
Toutes les apps d’un éditeur que nous avons vues dans un classement, avec le jour où chacune a été vue pour la première fois. Les apps de l’éditeur qui n’ont jamais été classées n’y figurent pas — nous listons ce que nous avons mesuré, pas ce qui existe.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
publisherIdobligatoire | path | string | identifiant d’éditeur, p. ex. issu de market_new_apps |
curl "https://storelift.net/v1/hive/publisher/1000000900" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /hive/resolve
Trouve l’identifiant de n’importe quelle app : par nom ou développeur (les meilleurs résultats dans ce pays, avec éditeur, catégorie, note et nombre de notes), ou à partir d’un lien App Store / Google Play, d’un simple identifiant App Store ou d’un nom de paquet. À utiliser avant hive_app_details, hive_similar_apps ou hive_app_reviews quand vous n’avez qu’un nom.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
qobligatoire | query | string | nom de l’app, nom du développeur, lien de store, identifiant App Store ou nom de paquet |
limit | query | number | résultats, jusqu’à 25 (10 par défaut) |
Accepte aussi: country
curl "https://storelift.net/v1/hive/resolve?q=sleep&country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /hive/similar/{appId}
Le rayon d’apps similaires du store pour n’importe quelle app (You Might Also Like d’Apple, Similar apps de Google), dans l’ordre du rayon, avec la catégorie, le nom et l’éditeur de chaque app et le jour où le rayon a été lu. Les catégories du rayon montrent dans quel ensemble le store range l’app.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
appIdobligatoire | path | string | identifiant App Store (p. ex. 570060128) ou nom de paquet Google Play |
country | query | string | code pays, p. ex. us (vide = le rayon le plus récent lu dans n’importe quel pays) |
curl "https://storelift.net/v1/hive/similar/sbx-lumen?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /hive/reviews/{appId}
Les avis récents de n’importe quelle app dans un pays, du plus récent au plus ancien : étoiles, titre, texte, version et date, plus la répartition des étoiles des lignes renvoyées. Les noms des auteurs sont omis. Une app que Hive n’a pas encore est ajoutée au premier appel.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
appIdobligatoire | path | string | identifiant App Store (p. ex. 570060128) ou nom de paquet Google Play |
limit | query | number | avis, jusqu’à 200 (50 par défaut) |
Accepte aussi: country
curl "https://storelift.net/v1/hive/reviews/sbx-lumen?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"POST /hive/keywords/{term}/metrics/measure
Lance une mesure de la popularité et/ou de la difficulté d’un mot-clé dans un pays lorsque la valeur stockée est absente ou périmée. Une valeur fraîche ou une absence vérifiée est renvoyée sans nouveau travail ; une demande qui rejoint une tâche déjà en cours ne consomme aucune unité de mesure quotidienne ; la demande qui lance un nouveau travail en consomme une sur le quota quotidien de mesures Hive de l’espace de travail. Les deux métriques sont indépendantes : une source en échec laisse l’autre métrique valide dans la réponse. wait (0–20 secondes) garde l’appel ouvert jusqu’à l’enregistrement du résultat ; 202 signifie que la mesure est encore en cours — lisez-la plus tard avec hive_keyword_metrics. Nécessite la portée hive:measure, à activer explicitement : choisie sur la clé API, ou approuvée séparément lors de la connexion via OAuth. iOS uniquement.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
termobligatoire | path | string | mot-clé exact, p. ex. habit tracker |
country | body | string | code pays, p. ex. us (us par défaut) |
platform | body | string | |
metrics | body | array | métriques à mesurer (les deux par défaut) |
wait | body | number | secondes d’attente du résultat stocké, 0–20 (cet outil envoie 15 si rien n’est indiqué ; la valeur par défaut de l’API HTTP est 0) |
Lancer un nouveau travail consomme une unité du quota quotidien de mesures Hive de l'espace de travail ; il n'y a donc pas de commande à copier ici.
Corps de la requête
{"country":"us","platform":"ios","metrics":["popularity","difficulty"],"wait":15}GET /hive/apps/{id}
Les détails de store que le réseau a mesurés pour n’importe quelle app à son dernier jour : nom, nombre de notes, note, version, prix, répartition, badge et nombre d’achats intégrés. Pour les apps de l’App Store, listingExtras ajoute les langues prises en charge, la répartition des étoiles (de 1★ à 5★), les événements dans l’app en cours et à venir, le texte promotionnel et les achats intégrés mis en avant, avec son propre measuredAt ; il vaut null sans mesure. not_measured indique les pays auxquels ajouter l’app.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string | Identifiant App Store (5 à 12 chiffres) ou nom de paquet Google Play. |
Accepte aussi: country
curl "https://storelift.net/v1/hive/apps/1000000001?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Exemple de réponse
GET /hive/keywords/{term}/ranks
Les premiers résultats de n’importe quel mot-clé mesuré par le réseau, par jour. days se réduit quand top est grand afin qu’un appel reste sous 1 000 lignes. 10 crédits jusqu’à 7 jours, 20 jusqu’à 30, 40 jusqu’à 90.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
termobligatoire | path | string | |
top | query | integer | |
days | query | integer |
Accepte aussi: country · platform
curl "https://storelift.net/v1/hive/keywords/sleep/ranks?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Exemple de réponse
GET /hive/keywords/{term}/metrics
Lit les observations Hive existantes pour un mot-clé exact et un pays. La popularité est un entier de 1 à 100 ; la difficulté est un score de 0 à 100. Les données manquantes restent null. Chaque métrique porte ses propres éléments de preuve, l’heure de sa source, sa fraîcheur et l’état de la dernière tentative. Ce GET ne lance jamais de requête vers une source ni de tâche de mesure. Nécessite le produit Hive Explorer complet ; Android n’est explicitement pas pris en charge.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
termobligatoire | path | string | Normalisé en NFC, sans espaces en début et en fin, et en minuscules. Les espaces internes restent significatifs. |
platform | query | ios | ios par défaut |
Accepte aussi: country
curl "https://storelift.net/v1/hive/keywords/sleep/metrics?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Exemple de réponse
GET /hive/keywords/{term}/metrics/history
Lit l’historique quotidien stocké d’un mot-clé : les résultats de recherche, le score de difficulté et la popularité Apple enregistrés chaque jour. Les valeurs de difficulté passées restent telles qu’elles ont été enregistrées. Les jours en échec ou incomplets sont signalés comme tels ; un jour sans enregistrement stocké n’est ni un zéro ni une absence vérifiée. Suivez pagination.nextCursor avec les mêmes keyword, storefront et days. Chaque série est paginée séparément, avec jusqu’à 200 enregistrements par page. Ce GET lit uniquement l’historique stocké et ne lance jamais de mesure. Nécessite le produit Hive Explorer complet ; Android n’est explicitement pas pris en charge. 10 crédits jusqu’à 7 jours, 20 jusqu’à 30, 40 jusqu’à 90.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
termobligatoire | path | string | Normalisé en NFC, sans espaces en début et en fin, et en minuscules. Les espaces internes restent significatifs. |
platform | query | ios | ios par défaut |
days | query | integer | Jours calendaires UTC, aujourd’hui inclus. Les révisions de popularité sont sélectionnées selon le début de semaine de leur source dans cette plage. |
cursor | query | string | Valeur de continuation opaque issue du pagination.nextCursor de cette requête exacte. |
Accepte aussi: country
curl "https://storelift.net/v1/hive/keywords/sleep/metrics/history?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Exemple de réponse
GET /hive/spy/{id}
Tous les mots-clés sur lesquels le réseau a mesuré une app, avec sa position. Chaque appel est payé en crédits ; une app sans mot-clé à afficher coûte 1.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string | Identifiant App Store (5 à 12 chiffres) ou nom de paquet Google Play. |
Accepte aussi: country · platform
curl "https://storelift.net/v1/hive/spy/1000000104?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Exemple de réponse
GET /hive/estimate/{id}
Revenus et téléchargements mensuels de n’importe quelle app de l’App Store, dans le monde entier : un chiffre pour chacun (value, ou under lorsque l’app est sous ce montant) et le nombre de marchés couverts. Chaque app obtient une réponse. Hive les connaît déjà. La première demande pour une app lance la lecture et répond 202 avec eta secondes. 500 crédits pour les chiffres ; une réponse en attente coûte 1.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string | Identifiant App Store. |
Accepte aussi: country
curl "https://storelift.net/v1/hive/estimate/1000000001?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"Exemple de réponse
GET /hive/gap
Les listes de mots-clés de jusqu’à 5 apps côte à côte, une ligne par mot-clé : la position de chaque app, combien le détiennent et lesquelles ne l’ont pas. 200 crédits par app comparée ; une app hors de l’index n’est pas facturée. Fait partie d’Explorer.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
idsobligatoire | query | string | Identifiants d’apps séparés par des virgules, au moins 2. |
Accepte aussi: country · platform
curl "https://storelift.net/v1/hive/gap?ids=1000000001,1000000104&country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /hive/research
Saisissez un mot-clé de départ et obtenez des termes de recherche App Store associés, chacun avec la popularité Apple (1–100 lorsqu’elle est observée ; les valeurs manquantes restent null), la difficulté (0–100), le nombre d’apps classées dessus et les 10 premières apps. Les éléments de preuve d’une métrique distinguent une valeur mesurée, une absence vérifiée, un travail en attente et des erreurs de source. Les lignes en cours de mesure portent state: "pending" ; répétez la demande pour lire le résultat. Quand l’App Store corrige l’orthographe d’un terme, la ligne porte spell avec la recherche corrigée. Aucune app requise. Fait partie d’Explorer.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
seedobligatoire | query | string | Mot-clé de départ. |
compare | query | string | Jusqu’à 5 pays supplémentaires, séparés par des virgules (p. ex. de,fr) : popularité, difficulté et nombre d’apps des mêmes termes dans chacun. |
Accepte aussi: country
curl "https://storelift.net/v1/hive/research?seed=us&country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"GET /hive/landscape
Le paysage des catégories d’un pays d’après sa liste des meilleures apps gratuites : le mur de notes du top 10, la note médiane, la longueur des noms, la fraîcheur des sorties et des mises à jour, les langues, la taille et les éditeurs ayant plusieurs apps. Chaque catégorie porte son propre jour de mesure.
| Paramètre | Emplacement | Type | Description |
|---|---|---|---|
genre | query | string | Identifiant de genre App Store (p. ex. 6014) ou clé de catégorie (all, games, entertainment, photo-video, productivity, health-fitness, education, lifestyle, finance, social-networking). Omettre pour toutes les catégories mesurées. |
Accepte aussi: country
curl "https://storelift.net/v1/hive/landscape?country=us" \
-H "Authorization: Bearer $STORELIFT_API_KEY"