npm Trends API

npm パッケージのダウンロード動向 API

Trends API を使った npm のダウンロード関心度です。正確なパッケージ名の履歴と成長率を、0～100 に正規化して表示します。

キー：trendsapi.ai/#get-key。HTTP の仕様とすべてのデータソース：trendsapi-ai/trendsapi。

認証

pip install trendsapi-npm
export TRENDSAPI_KEY=your_key

Python 3.9 以降。HTTP API と同じキーを使用します。

from trendsapi_npm import TrendsAPI

client = TrendsAPI()                    # TRENDSAPI_KEY
# client = TrendsAPI(api_key="YOUR_KEY")

キーワード用ヘルパーの既定値は source: "npm" です。同じクライアントでほかのプラットフォームを利用するには、source= を渡します。公式の完全版クライアント（すべてのデータソース、プリセットなし）：trendsapi。

メソッド

メソッド	REST の mode	戻り値
get_time_series(keyword, source=, data_mode=)	get_time_series	list[TrendsDataPoint]
get_growth(keyword, percent_growth=, source=, data_mode=)	get_growth	GetGrowthResponse
get_top_trends(type=, ...)	get_top_trends	GetTopTrendsResponse

source は小文字（npm）です。type は完全一致（Google Trends）です。混在させると 400 エラーになります。

from trendsapi_npm import TrendsAPI

client = TrendsAPI()                    # TRENDSAPI_KEY
# client = TrendsAPI(api_key="YOUR_KEY")

series = client.get_time_series("vite")
print(series[-1].date, series[-1].value)

growth = client.get_growth("vite", percent_growth=["3M", "12M"])
print(growth.results[0].growth, growth.results[0].direction)

get_time_series

points = client.get_time_series("vite")

各ポイントの内容：

フィールド	常に含まれる	意味
date	はい	YYYY-MM-DD
value	はい	この系列の 0～100 の指数
keyword	はい	エコー
volume	いいえ	利用可能な場合の絶対量
source or datatype	いいえ	パイプラインのラベル

Python では list[TrendsDataPoint] が返されます。["date"] ではなく .date と .value を使用してください。 JS では同じフィールドがオブジェクトのプロパティとして返されます。

get_growth

g = client.get_growth("vite", percent_growth=["12M", "3M", "YTD"])
print(g.results[0].growth, g.results[0].direction)

percent_growth の既定値：["12M"]。プリセット：7D 14D 30D 1M 2M 3M 6M 9M 12M/1Y 18M 24M/2Y 36M/3Y 48M 60M/5Y MTD QTD YTD。カスタム指定：{"name": "Launch", "recent": "2024-06-01", "baseline": "2024-01-01"}。

フィールド	意味
search_term	キーワード
data_source	データソース
results	期間ごとに 1 つのオブジェクト（period、growth、direction、日付、値）
metadata	件数／成功フラグ

複数の期間を指定しても、リクエスト数は 1 件です。Python：growth.results[0].growth。JS：growth.results[0].growth。

非同期処理

import asyncio
from trendsapi_npm import AsyncTrendsAPI

async def main():
    c = AsyncTrendsAPI()
    return await asyncio.gather(
        c.get_time_series("vite"),
        c.get_time_series("vite", source="google search"),
    )

asyncio.run(main())

200 の応答 1 件につき、課金対象リクエストは 1 件です。

Pandas

from dataclasses import asdict
import pandas as pd
from trendsapi_npm import TrendsAPI

df = pd.DataFrame(asdict(p) for p in TrendsAPI().get_time_series("vite"))
df["date"] = pd.to_datetime(df["date"])
print(df.set_index("date")["value"].resample("ME").mean().tail())

呼び出し（curl）

フィールド	値
エンドポイント	POST https://api.trendsapi.ai/api
認証	Authorization: Bearer $TRENDSAPI_KEY
履歴	get_time_series または get_growth と source: npm を指定
キーワード	正確なパッケージ名。大文字と小文字を区別します：vite、@tanstack/react-query
ライブの type	該当なし

curl -sS -X POST https://api.trendsapi.ai/api \
  -H "Authorization: Bearer $TRENDSAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mode":"get_time_series","source":"npm","keyword":"vite"}'

データソースに関する注意

• JSON 内の @ や / は URL エンコードしないでください。
• 1 リクエストにつきパッケージは 1 つです。
• 正確な整数の件数が必要な場合は、api.npmjs.org/downloads を使用してください。

エラー

HTTP	クライアント
200	ペイロードを解析します。Python のデータクラス／JS の型付きオブジェクト
400	例外が発生します。source または type のスペルを修正してください
401	例外が発生します。TRENDSAPI_KEY を確認してください
404	例外が発生します。そのキーワードの系列がありません。再試行しないでください
429	例外が発生します。クォータ超過です
5xx	クライアントが再試行した後、例外が発生します

HTTP の body フィールドは JSON 文字列です。SDK はデコードします。生の curl では、body をもう一度解析する必要があります。

サイト：https://trendsapi.ai/trends/npm-trends。

ライセンス

MIT。LICENSE を参照してください。