Douyin人気チャレンジランキングAPI
POST
APIの稼働状況
このAPIのステータスデータを一時的に取得できないため、最近の状態は不明です。停止しているという意味ではありません。
Douyin独自のトレンドツールであるHot Spot Treasureのチャレンジランキングを読み取ります。1回の呼び出しで、ランキング全体の50件のトレンドを取得できます。各トレンドには順位、タイトル、ID、熱度、関連動画数、作成日時、約10分ごとにサンプリングされた熱度の推移が含まれます。limitは件数を減らす方向にしか使えず、ページングはありません。
料金は1,000リクエストあたり$0.81(1回あたり$0.000806)です。失敗した呼び出しと空の結果には課金されません。 同期処理です。時間のかかるジョブでは、ボディに"mode": "async"を追加し、job_idを取得してポーリングしてください。
AIプロンプト
EveryInfraのDouyin 人気チャレンジランキングエンドポイント(douyin/billboard_challenge_hot)を使ったデータ収集スクリプトの作成を手伝ってください。
エンドポイントの仕組み:
- リクエスト:ヘッダーにAuthorization: Bearer <API key>を指定して、https://api.everyinfra.com/api/v1/socialにPOSTします。APIキーは環境変数EVERYINFRA_API_KEYから読み込み、ハードコードしないでください。
- リクエストボディでplatformにdouyin、actionにbillboard_challenge_hotを指定し、パラメータはparamsの中に入れます。
- 必須パラメータはありません。
- 任意パラメータ:
- limit: この呼び出しで返す最大行数で、1〜50の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。最大値を超える値も受け付けますが、最大値に切り詰められます。(デフォルト:50)
- レコードのリストを返します。各レコードの主なフィールド: rank(1から始まる順位です)、title、topic_id(トレンドのHot Spot Treasure ID(billboard_ris…)、hot_value(熱度値です)、video_count(動画数です)、created_at、hot_trend(トレンドの直近の熱度).
- リクエストボディの例:
{
"platform": "douyin",
"action": "billboard_challenge_hot",
"params": {}
}
- 料金:1,000リクエストあたり$0.81。失敗時および結果が空の場合は課金されません。
- 対象が数十〜数百件ある場合は、ボディに"mode": "async"を追加します。すぐにjob_idが返されるので、GET https://api.everyinfra.com/api/v1/jobs/{job_id}をポーリングして結果を取得します。
- 422の場合は、エラーに含まれる推奨パラメータ名と指定可能な値を使ってリクエストを修正します。429または503の場合は、Retry-Afterの指定に従って待ってから再試行します。
コードを書く前に、必要な対象とその件数、必要なフィールド、希望する出力形式を私に質問してください。そのうえで、計画と概算費用を私に確認してください。リクエストパラメータ
| 名前 | 場所 | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|---|
Authorization | header | string | はい | - | Bearerの後にAPIキーを続けます。APIキーはコンソールで作成してください。URLやコードリポジトリには絶対に含めないでください。 |
platform | body | string | はい | douyin | プラットフォームの識別子です。値は固定です。 |
action | body | string | はい | billboard_challenge_hot | 機能の識別子です。値は固定です。 |
limit | body.params | integer (1–50) | いいえ | 50 | この呼び出しで返す最大行数で、1〜50の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。最大値を超える値も受け付けますが、最大値に切り詰められます。 |
コードサンプル
bash
curl -X POST 'https://api.everyinfra.com/api/v1/social' \
-H "Authorization: Bearer $EVERYINFRA_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"platform": "douyin",
"action": "billboard_challenge_hot",
"params": {}
}'OpenAPI定義(JSON)サンプルは環境変数EVERYINFRA_API_KEYからAPIキーを読み込みます。コピーしたコードにAPIキーが含まれることはありません。
レスポンス例
フィールドプレビュー
このパラメータのサンプルレスポンスはまだありません。このプレビューはAPI定義に基づくレスポンスの構造とフィールドを示したもので、値は…で表しています。実際の呼び出し結果ではありません。
json
{
"id": "req_…",
"platform": "douyin",
"action": "billboard_challenge_hot",
"results": [
{
"rank": …,
"title": …,
"topic_id": …,
"hot_value": …,
"video_count": …,
"created_at": …,
"hot_trend": …,
"platform": …
}
],
"count": …,
"billing": {
"charged": …,
"charged_usd": …,
"balance_after_usd": …,
…
},
"quota": { … }
}レスポンスフィールド
業務データはresultsに含まれます。この表はレコードに含まれうるフィールドの一覧です。プラットフォームに表示されない値を作り出すことはありません。
| フィールド | 意味 |
|---|---|
rank | 1から始まる順位です。trendingではトレンド順位、xingtu_creator_rankingsではXingtuランキングでの順位、billboard_search_hotでは検索ランキングでの順位、search_suggestではDouyinの検索ボックスでの候補の表示位置です。 |
title | タイトルです。プラットフォームにタイトルがない場合(テキストのみの投稿など)はnullになります。 |
topic_id | トレンドのHot Spot Treasure ID(billboard_rise_list、billboard_challenge_hot)。同じトレンドはスナップショットをまたいで同じIDを保持します。 |
hot_value | 熱度値です。Douyin独自の指標で、同じランキング・同じ期間内でのみ比較できます。trendingではエントリの熱度(ホットスポットランキングでは空のことが多い)、Hot Spot Treasureの動画ランキングではランキングの熱度スコアで、行は高い順に並びます。billboard_search_hotでは期間内のその語の検索熱度です。 |
video_count | 動画数です。profileとbillboard_account_searchではアカウントの動画数、trendingではエントリに関連する動画数です。 |
created_at | 作成日時です。形式はposted_atと同じです。 |
hot_trend | トレンドの直近の熱度。billboard_rise_listでは1時間ごと、billboard_challenge_hotでは約10分ごとの値で、[{time(UTC、ISO 8601), hot_value}]の形式で古い順に並びます。 |
platform | 取得元プラットフォームの識別子で、リクエストのplatformと同じです(例:xiaohongshu、tiktok)。 |
エラーと課金
- 401
- キーが未指定か無効です。
- 402
- 残高が不足しています。先にチャージしてください。
- 422
- パラメータ名または値が無効です。エラーに含まれる候補を参考に修正してください。課金はされません。
- 429
- 1分あたりのリクエスト上限に達しました。Retry-Afterの指定に従って待ってから再試行してください。
- 503
- 処理を完了できませんでした。保留中の請求額は残高に戻されます。結果が不明な場合は、再試行する前に確認してください。
- 200(空)
- データがありません。課金はされません。