TikTokショップの売れ筋商品API

POST

APIの稼働状況

24時間の稼働状況: 正常
24時間の平均応答時間: —

良好／正常
利用可能
制限あり
ほぼ停止

正常

過去24時間

過去30日間

東南アジアまたはアジアの1市場について、TikTok Shopのベストセラーリストを取得します。対象市場はID、JP、MX、MY（デフォルト）、PH、SG、TH、VNです。各商品には、rank、ID、リンク、名前、価格、元の価格、通貨、販売数、評価、レビュー数、ショップ名、shop_idが含まれます。米国、英国、ブラジルにはベストセラーリストがありません。

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

AIプロンプト

EveryInfraのTikTok ショップの売れ筋商品エンドポイント（tiktok/shop_hot_products）を使ったデータ収集スクリプトの作成を手伝ってください。

エンドポイントの仕組み：
- リクエスト：ヘッダーにAuthorization: Bearer <API key>を指定して、https://api.everyinfra.com/api/v1/socialにPOSTします。APIキーは環境変数EVERYINFRA_API_KEYから読み込み、ハードコードしないでください。
- リクエストボディでplatformにtiktok、actionにshop_hot_productsを指定し、パラメータはparamsの中に入れます。
- 必須パラメータはありません。
- 任意パラメータ：
  - country: TikTok Shopのマーケットです。ID、JP、MX、MY（デフォルト）、PH、SG、TH、VNのいずれかを指定します。米国、英国、ブラジルにはベストセラーリストがないため、課金前にリクエストが拒否されます。
  - limit: この呼び出しで返す最大行数で、1〜100の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。最大値を超える値も受け付けますが、最大値に切り詰められます。（デフォルト：20）
- レコードのリストを返します。各レコードの主なフィールド: rank、id、url、name、price、original_price、currency、sold_count、rating、rating_scale、review_count、shop_name。フィールドは全部で14個です。一覧はhttps://api.everyinfra.com/api/v1/social/catalog?platform=tiktokを参照してください。.
- リクエストボディの例：
{
  "platform": "tiktok",
  "action": "shop_hot_products",
  "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`	はい	`tiktok`	プラットフォームの識別子です。値は固定です。
`action`	body	`string`	はい	`shop_hot_products`	機能の識別子です。値は固定です。
`country`	body.params	`string`	いいえ	-	TikTok Shopのマーケットです。ID、JP、MX、MY（デフォルト）、PH、SG、TH、VNのいずれかを指定します。米国、英国、ブラジルにはベストセラーリストがないため、課金前にリクエストが拒否されます。
`limit`	body.params	`integer (1–100)`	いいえ	`20`	この呼び出しで返す最大行数で、1〜100の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。最大値を超える値も受け付けますが、最大値に切り詰められます。

コードサンプル

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": "tiktok",
  "action": "shop_hot_products",
  "params": {}
}'

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

レスポンス例

フィールドプレビュー

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

json

{
  "id": "req_…",
  "platform": "tiktok",
  "action": "shop_hot_products",
  "results": [
    {
      "rank": …,
      "id": …,
      "url": …,
      "name": …,
      "price": …,
      "original_price": …,
      "currency": …,
      "sold_count": …,
      "rating": …,
      "rating_scale": …,
      "review_count": …,
      "shop_name": …,
      "shop_id": …,
      "image_url": …,
      "platform": …
    }
  ],
  "count": …,
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

レスポンスフィールド

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

フィールド	意味
`rank`	プラットフォーム上の意味のまま
`id`	プラットフォーム上でのレコードの一意なIDです。一意性は1つのプラットフォーム内に限られ、プラットフォームが異なるとIDが重複する場合があります。
`url`	プラットフォーム上のレコードへのリンクです。
`name`	対象そのものの名前です（アカウント・商品・ビジネス系の機能で使用）。
`price`	通貨記号を含まない数値で表した価格です。通貨についてはcurrencyを参照してください。
`original_price`	プラットフォーム上の意味のまま
`currency`	価格の通貨コードです（例：CNY、USD）。priceフィールドが存在してもcurrencyがnullの場合は、通貨を推測しないでください。
`sold_count`	プラットフォーム上の意味のまま
`rating`	評価です。スケールはプラットフォームによって異なります。最大値は同じ行のrating_scaleで示されます（通常は5。Booking、Douban、iQIYI、NAVERは10）。プラットフォーム間で比較する前にrating_scaleで換算してください。換算しないと比較結果が逆転することがあります。
`rating_scale`	同じ行のratingの最大値です。5段階評価では5、10点満点では10になります。行にratingがある場合のみ含まれます。
`review_count`	レビュー数です（商品・ビジネス系の機能で使用）。nullは非公開を示し、0ではありません。
`shop_name`	プラットフォーム上の意味のまま
`shop_id`	プラットフォーム上の意味のまま
`image_url`	画像のリンクです。複数の画像を返す機能では、image_urls配列が返される場合があります。
`platform`	取得元プラットフォームの識別子で、リクエストのplatformと同じです（例：xiaohongshu、tiktok）。

エラーと課金

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

エラー