Hive のエンドポイント

Storelift のネットワークが計測しているあらゆるアプリと市場。あなたが追跡しているかどうかは問いません。Hive Explorer の一部です。

認証 · クレジット · 共通パラメータ · エラーコード · openapi.json

GET `/rank-check`

1つのストアフロントで、任意の検索語に対する自分のアプリのライブ順位を、ストアがいま表示しているとおりに返します。その語を追跡している必要はありません。状態で場合を区別します。ranked は順位とすぐ上のアプリ、absent は上位の結果（アプリはそこで販売されていて、その結果の外にいます）、not_in_store はアプリがそのストアフロントで販売されていないことを示します。

スコープ: apps:read
クレジット: 10
プラン: Free

パラメータ	場所	型	説明
`app`必須	query	string	App StoreのリンクまたはID、あるいはGoogle Playのリンクまたはパッケージ名
`term`必須	query	string	検索語。例：habit tracker
`cc`	query	string	ストアフロントコード。例：us
`platform`	query	ios \| android	省略可。アプリのリンクから読み取ります

curl "https://storelift.net/v1/rank-check?app=us&term=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET `/keyword-difficulty`

1つのストアフロントにおける、App Storeの検索語1つの需要と難易度の入力値です。需要（demand）と関連する検索、評価数とタイトルにその語があるかどうかを添えた上位の結果、その中で最大の評価数と評価数の中央値、結果の深さを返します。thin は結果が10件未満の語、zayifEslesme はストアがゆるく一致させる語を示します。Freeはアカウントがそのストアフロントで追跡している語を、Pro以上は任意の語を読めます。

スコープ: apps:read
クレジット: 10
プラン: Free

パラメータ	場所	型	説明
`term`必須	query	string	検索語。例：habit tracker
`cc`	query	string	ストアフロントコード。例：us

curl "https://storelift.net/v1/keyword-difficulty?term=us" \
  -H "Authorization: Bearer $STORELIFT_API_KEY"

GET `/hive/find`

Storeliftが計測しているランキング全体からアプリを探します。カテゴリ、ストアフロント、ランキング（トップ売上、トップ無料、トップ有料、トップiPad）、順位の範囲、初めて見つかった日、名前またはパブリッシャー、さらに月間収益、月間ダウンロード、30日間の成長率で絞り込めます。estimates: true を渡すと、各行の月間収益とダウンロードをHiveから、それぞれ1つの数値で、その数値の日付とともに取得できます。収益、ダウンロード、成長率のフィルターを設定すると、Hiveにまだ数値がないアプリは除かれ、noEstimate に件数が入ります。一覧は20クレジットです。数値付き、または収益・ダウンロード・成長率のフィルター付きの場合は、返した行ごとにさらに50クレジットかかります。応答には coverage（初回検出インデックスの開始日）が含まれるため、読み取る日付はすべてインデックス済みの日です。

スコープ: hive:read
クレジット: 20
プラン: Hive Explorer

パラメータ	場所	型	説明
`genre`	query	string	AppleのジャンルIDを最大3つ。カンマ区切り。例：6007,6012
`country`	query	string	ストアフロントコードを最大5つ。カンマ区切り。例：us,gb
`kind`	query	string	grossing、free、paid、ipad のいずれか（アプリが載っているランキング）
`released`	query	number	直近Nか月以内に初めて見つかったもの
`rankMin`	query	number	最高ランキング順位がこの値以上
`rankMax`	query	number	最高ランキング順位がこの値以下
`revenueMin`	query	number	月間総収益がこの値以上（USD）
`revenueMax`	query	number	月間総収益がこの値以下（USD）
`downloadsMin`	query	number	月間ダウンロードがこの値以上
`downloadsMax`	query	number	月間ダウンロードがこの値以下
`growthMin`	query	number	30日間の変化がこの値以上（パーセント。例：20）
`growthMax`	query	number	30日間の変化がこの値以下（パーセント）
`text`	query	string	アプリ名またはパブリッシャー名で照合
`publisher`	query	string	market_publisher で得たパブリッシャーID
`estimates`	query	boolean	true にすると、すべての行に月間収益とダウンロードを加えます（1行あたり50クレジット）
`limit`	query	number	1ページあたりの行数。既定は50、最大200
`page`	query	number	結果のページ。既定は1

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

GET `/hive/charts`

Storeliftが最後に計測した時点のランキング1つです。ストアフロント、リストの種類、任意のカテゴリについて、順位順のアプリIDを読み取った日とともに返します。estimates: true を渡すと、各順位の月間の値（トップ売上では収益、トップ無料ではダウンロード）と、10位・50位・100位に入るために必要な水準を返します。一覧は10クレジットです。estimates: true を指定した場合は、返した行ごとにさらに50クレジットかかります。App Storeのみが対象です。Google Playには公開のランキングがないため、数値を出せば作り物になります。

スコープ: hive:read
クレジット: 10
プラン: Hive Explorer

パラメータ	場所	型	説明
`kind`	query	string	free、paid、grossing のいずれか
`genre`	query	string	AppleのジャンルID。例：6007。総合ランキングの場合は省略
`limit`	query	number	行数。最大100

ほかに受け付けるもの: country

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

サンドボックスで開く

サンプルレスポンス

GET `/hive/movers`

1つのランキングで、N日前の同じランキングと比べて、誰が上がり、誰が下がり、誰が入り、誰が外れたかを返します。measured は比較対象の日のデータがそろっていることを示すため、読み取る差分はすべて計測済みの2日間の差です。外れたアプリは今日ランキング外にいるため、差分ではなく最後の順位を返します。

スコープ: hive:read
クレジット: 10
プラン: Hive Explorer

パラメータ	場所	型	説明
`kind`	query	string	free、paid、grossing のいずれか
`genre`	query	string	AppleのジャンルID。総合ランキングの場合は省略
`days`	query	number	N日前と比較。最大90
`limit`	query	number	方向ごとの行数。最大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

パラメータ	場所	型	説明
`days`	query	number	さかのぼる日数N。最大30
`country`	query	string	ストアフロントコード。全ストアフロントの場合は省略
`limit`	query	number	行数。最大200

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

GET `/hive/publisher/{publisherId}`

1つのパブリッシャーのアプリのうち、ランキングで確認できたものすべてを、それぞれが初めて見つかった日とともに返します。そのパブリッシャーの、一度もランキングに入っていないアプリは含みません。返すのは計測したものであり、存在するものすべてではありません。

スコープ: hive:read
クレジット: 10
プラン: Hive Explorer

パラメータ	場所	型	説明
`publisherId`必須	path	string	パブリッシャーID。例：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のリンク、App Store IDそのもの、パッケージ名から探せます。名前しか分からないときに、hive_app_details、hive_similar_apps、hive_app_reviews の前に使ってください。

スコープ: hive:read
クレジット: 10
プラン: Hive Explorer

パラメータ	場所	型	説明
`q`必須	query	string	アプリ名、デベロッパ名、ストアのリンク、App Store ID、またはパッケージ名
`limit`	query	number	結果の数。最大25（既定は10）

ほかに受け付けるもの: country

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

GET `/hive/similar/{appId}`

任意のアプリについて、ストア自身の類似アプリの棚（Appleの「You Might Also Like」、Googleの「Similar apps」）を棚の並び順で返します。各アプリのカテゴリ、名前、パブリッシャーと、棚を読み取った日が付きます。棚に並ぶカテゴリから、ストアがそのアプリをどの層に位置づけているかが分かります。

スコープ: hive:read
クレジット: 10
プラン: Hive Explorer

パラメータ	場所	型	説明
`appId`必須	path	string	App Store ID（例：570060128）またはGoogle Playのパッケージ名
`country`	query	string	ストアフロントコード。例：us（空 = いずれかのストアフロントで読み取った最新の棚）

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

GET `/hive/reviews/{appId}`

1つのストアフロントにおける任意のアプリの最近のレビューを新しい順に返します。星、タイトル、本文、バージョン、日付に加え、返した行の星の分布が付きます。レビュアー名は含みません。Hiveにまだないアプリは、最初の呼び出しで追加されます。

スコープ: hive:read
クレジット: 10
プラン: Hive Explorer

パラメータ	場所	型	説明
`appId`必須	path	string	App Store ID（例：570060128）またはGoogle Playのパッケージ名
`limit`	query	number	レビュー数。最大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`

保存済みの値がない、または古い場合に、1つのストアフロントにおける1つのキーワードの人気度と難易度（またはその一方）の計測を開始します。新しい値、または確認済みの不在は、新たな処理なしで返します。すでに実行中のジョブに合流するリクエストは、1日の計測単位を使いません。新たな処理を開始するリクエストは、ワークスペースの1日のHive計測利用枠から1単位を使います。2つの指標は独立しており、片方のソースが失敗しても、もう一方の有効な指標は応答に残ります。wait（0〜20秒）は、結果が保存されるまで呼び出しを開いたままにします。202はまだ実行中であることを意味します。あとで hive_keyword_metrics で読み取ってください。オプトインの hive:measure スコープが必要です。APIキーで選ぶか、OAuthで接続するときに別途承認します。iOSのみ。

スコープ: hive:measure
クレジット: 50
プラン: Hive Explorer

パラメータ	場所	型	説明
`term`必須	path	string	キーワードそのもの。例：habit tracker
`country`	body	string	ストアフロントコード。例：us（既定は us）
`platform`	body	string
`metrics`	body	array	計測する指標（既定は両方）
`wait`	body	number	保存済みの結果を待つ秒数。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★）、開催中と今後の App 内イベント、プロモーションテキスト、おすすめのアプリ内課金が独自の measuredAt とともに入ります。未計測なら null です。not_measured は、そのアプリを追加すべきストアフロントを示します。

スコープ: hive:read
クレジット: 10
プラン: Hive Explorer

パラメータ	場所	型	説明
`id`必須	path	string	App Store ID（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`

ネットワークが計測している任意のキーワードの上位の結果を、日ごとに返します。1回の呼び出しが1,000行に収まるよう、top が大きいと days は短くなります。7日までは10クレジット、30日までは20、90日までは40です。

スコープ: hive:read
クレジット: 10
プラン: Hive Explorer

パラメータ	場所	型
`term`必須	path	string
`top`	query	integer
`days`	query	integer

ほかに受け付けるもの: country · platform

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

サンドボックスで開く

サンプルレスポンス

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

1つのキーワード（完全一致）とストアフロントについて、既存のHiveの観測値を読み取ります。人気度は1〜100の整数、難易度は0〜100のスコアです。データがない場合は null のままです。各指標には、それぞれの根拠、ソースの時刻、鮮度、最後の試行のステータスが付きます。このGETがソースへのリクエストや計測ジョブを開始することはありません。Hive Explorerの製品一式が必要です。Androidは明示的に非対応です。

スコープ: hive:read
クレジット: 10
プラン: Hive Explorer

パラメータ	場所	型	説明
`term`必須	path	string	NFC正規化し、前後の空白を除き、小文字にした値。語中の空白は区別されます。
`platform`	query	ios	既定は 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の人気度です。過去の難易度は記録時の値のまま変わりません。失敗した日や不完全な日はその旨が示されます。保存済みのレコードがない日は、ゼロでも確認済みの不在でもありません。同じ keyword、storefront、days で pagination.nextCursor をたどってください。各系列は個別にページ分けされ、1ページあたり最大200件です。このGETは保存済みの履歴を読むだけで、計測を開始することはありません。Hive Explorerの製品一式が必要です。Androidは明示的に非対応です。7日までは10クレジット、30日までは20、90日までは40です。

スコープ: hive:read
クレジット: 20
プラン: Hive Explorer

パラメータ	場所	型	説明
`term`必須	path	string	NFC正規化し、前後の空白を除き、小文字にした値。語中の空白は区別されます。
`platform`	query	ios	既定は ios
`days`	query	integer	今日を含むUTCの暦日数。人気度リビジョンは、ソースの週の開始日がこの範囲に入るものが選ばれます。
`cursor`	query	string	このクエリそのものの 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`必須	path	string	App Store ID（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アプリの、全世界の月間収益とダウンロードです。それぞれ1つの数値（value。その金額に満たないアプリは under）と、対象となる市場の数を返します。どのアプリにも答えが返ります。Hiveはすでに知っています。あるアプリへの最初のリクエストは読み取りを開始し、eta 秒を添えて202を返します。数値は500クレジット、保留中の応答は1クレジットです。

スコープ: hive:estimate
クレジット: 500
プラン: Hive Explorer

パラメータ	場所	型	説明
`id`必須	path	string	App Store ID。

ほかに受け付けるもの: country

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

サンドボックスで開く

サンプルレスポンス

GET `/hive/gap`

最大5つのアプリのキーワード一覧を、キーワードごとに1行で並べて返します。各アプリの順位、順位を持つアプリの数、欠けているアプリが分かります。比較するアプリ1つにつき200クレジットです。インデックスにないアプリは課金されません。Explorerに含まれます。

スコープ: hive:spy
クレジット: 400
プラン: Hive Explorer

パラメータ	場所	型	説明
`ids`必須	query	string	アプリIDをカンマ区切りで。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`必須	query	string	シードとなるキーワード。
`compare`	query	string	追加のストアフロントを最大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

パラメータ	場所	型	説明
`genre`	query	string	App StoreのジャンルID（例：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"

Hive のエンドポイント

GET /rank-check

GET /keyword-difficulty

GET /hive/find

GET /hive/charts

GET /hive/movers

GET /hive/new

GET /hive/publisher/{publisherId}

GET /hive/resolve

GET /hive/similar/{appId}

GET /hive/reviews/{appId}

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

GET /hive/apps/{id}

GET /hive/keywords/{term}/ranks

GET /hive/keywords/{term}/metrics

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

GET /hive/spy/{id}

GET /hive/estimate/{id}

GET /hive/gap

GET /hive/research

GET /hive/landscape

GET `/rank-check`

GET `/keyword-difficulty`

GET `/hive/find`

GET `/hive/charts`

GET `/hive/movers`

GET `/hive/new`

GET `/hive/publisher/{publisherId}`

GET `/hive/resolve`

GET `/hive/similar/{appId}`

GET `/hive/reviews/{appId}`

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

GET `/hive/apps/{id}`

GET `/hive/keywords/{term}/ranks`

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

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

GET `/hive/spy/{id}`

GET `/hive/estimate/{id}`

GET `/hive/gap`

GET `/hive/research`

GET `/hive/landscape`