Douyin検索候補API

POST

APIの稼働状況

このAPIのステータスデータを一時的に取得できないため、最近の状態は不明です。停止しているという意味ではありません。

keywordに対してDouyinの検索ボックスに表示されるオートコンプリート候補を、Douyinの表示順で、1から始まるrank付きで取得します。1回の呼び出しで最大10件ですが、Douyinが表示するのは通常5件程度で、ページングはありません。候補に検索ボリュームは含まれません。

料金は1,000リクエストあたり$8（1回あたり$0.008）です。失敗した呼び出しと空の結果には課金されません。同期処理です。時間のかかるジョブでは、ボディに"mode": "async"を追加し、job_idを取得してポーリングしてください。

AIプロンプト

EveryInfraのDouyin 検索候補エンドポイント（douyin/search_suggest）を使ったデータ収集スクリプトの作成を手伝ってください。

エンドポイントの仕組み：
- リクエスト：ヘッダーにAuthorization: Bearer <API key>を指定して、https://api.everyinfra.com/api/v1/socialにPOSTします。APIキーは環境変数EVERYINFRA_API_KEYから読み込み、ハードコードしないでください。
- リクエストボディでplatformにdouyin、actionにsearch_suggestを指定し、パラメータはparamsの中に入れます。
- 必須パラメータ：
  - keyword: Douyinの検索ボックスに入力するテキストです（例：artificial intelligence）。候補はDouyinでの表示順で返されます。
- 任意パラメータ：
  - limit: この呼び出しで返す最大行数で、1〜10の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。最大値を超える値を指定すると、課金前に422が返されます。（デフォルト：10）
- レコードのリストを返します。各レコードの主なフィールド: rank（1から始まる順位です）、keyword（キーワードです）.
- リクエストボディの例：
{
  "platform": "douyin",
  "action": "search_suggest",
  "params": {
    "keyword": "美食"
  }
}
- 料金：1,000リクエストあたり$8。失敗時および結果が空の場合は課金されません。
- 対象が数十〜数百件ある場合は、ボディに"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`	はい	`search_suggest`	機能の識別子です。値は固定です。
`keyword`	body.params	`string`	はい	-	Douyinの検索ボックスに入力するテキストです（例：`artificial intelligence`）。候補はDouyinでの表示順で返されます。
`limit`	body.params	`integer (1–10)`	いいえ	`10`	この呼び出しで返す最大行数で、1〜10の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。最大値を超える値を指定すると、課金前に422が返されます。

コードサンプル

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": "search_suggest",
  "params": {
    "keyword": "美食"
  }
}'

OpenAPI定義（JSON）サンプルは環境変数EVERYINFRA_API_KEYからAPIキーを読み込みます。コピーしたコードにAPIキーが含まれることはありません。

レスポンス例

フィールドプレビュー

このパラメータのサンプルレスポンスはまだありません。このプレビューはAPI定義に基づくレスポンスの構造とフィールドを示したもので、値は…で表しています。実際の呼び出し結果ではありません。

json

{
  "id": "req_…",
  "platform": "douyin",
  "action": "search_suggest",
  "results": [
    {
      "rank": …,
      "keyword": …,
      "platform": …
    }
  ],
  "count": …,
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

レスポンスフィールド

業務データはresultsに含まれます。この表はレコードに含まれうるフィールドの一覧です。プラットフォームに表示されない値を作り出すことはありません。

フィールド	意味
`rank`	1から始まる順位です。trendingではトレンド順位、xingtu_creator_rankingsではXingtuランキングでの順位、billboard_search_hotでは検索ランキングでの順位、search_suggestではDouyinの検索ボックスでの候補の表示位置です。
`keyword`	キーワードです。trendingではトレンドのフレーズ、billboard_search_hotでは検索語、search_suggestでは検索候補です。
`platform`	取得元プラットフォームの識別子で、リクエストのplatformと同じです（例：xiaohongshu、tiktok）。

エラーと課金

401: キーが未指定か無効です。
402: 残高が不足しています。先にチャージしてください。
422: パラメータ名または値が無効です。エラーに含まれる候補を参考に修正してください。課金はされません。
429: 1分あたりのリクエスト上限に達しました。Retry-Afterの指定に従って待ってから再試行してください。
503: 処理を完了できませんでした。保留中の請求額は残高に戻されます。結果が不明な場合は、再試行する前に確認してください。
200（空）: データがありません。課金はされません。

エラー