TikTokライブルームAPI

POST

APIの稼働状況

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

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

正常

過去24時間

過去30日間

ハンドルを指定して、TikTokアカウントが現在ライブ配信中かどうかを確認します。配信中の場合は、ルームID、タイトル、リンク、現在の視聴者数、ピーク時と累計の視聴者数、いいね数、シェア数、商品数、開始時刻、カバー画像、有効期限付きの配信リンクを取得できます。配信中でないアカウントの場合は、is_liveがfalseの行が1件返ります。

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

AIプロンプト

EveryInfraのTikTok ライブルームエンドポイント（tiktok/live_room）を使ったデータ収集スクリプトの作成を手伝ってください。

エンドポイントの仕組み：
- リクエスト：ヘッダーにAuthorization: Bearer <API key>を指定して、https://api.everyinfra.com/api/v1/socialにPOSTします。APIキーは環境変数EVERYINFRA_API_KEYから読み込み、ハードコードしないでください。
- リクエストボディでplatformにtiktok、actionにlive_roomを指定し、パラメータはparamsの中に入れます。
- 必須パラメータ：
  - username: 確認するTikTokハンドルです（例：tiktoklive_latam）。先頭の@は削除されます。プロフィールのリンクも使用できます。
- 1つのオブジェクトを返します。主なフィールド: username、display_name、user_id、is_live、room_id、url、title、viewer_count、peak_viewer_count、total_viewer_count、like_count、share_count。フィールドは全部で16個です。一覧はhttps://api.everyinfra.com/api/v1/social/catalog?platform=tiktokを参照してください。.
- リクエストボディの例：
{
  "platform": "tiktok",
  "action": "live_room",
  "params": {
    "username": "nasa"
  }
}
- 料金：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`	はい	`live_room`	機能の識別子です。値は固定です。
`username`	body.params	`string`	はい	-	確認するTikTokハンドルです（例：tiktoklive_latam）。先頭の@は削除されます。プロフィールのリンクも使用できます。

コードサンプル

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": "live_room",
  "params": {
    "username": "nasa"
  }
}'

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

レスポンス例

フィールドプレビュー

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

json

{
  "id": "req_…",
  "platform": "tiktok",
  "action": "live_room",
  "results": {
    "username": …,
    "display_name": …,
    "user_id": …,
    "is_live": …,
    "room_id": …,
    "url": …,
    "title": …,
    "viewer_count": …,
    "peak_viewer_count": …,
    "total_viewer_count": …,
    "like_count": …,
    "share_count": …,
    "product_count": …,
    "started_at": …,
    "cover_image_url": …,
    "stream_url": …,
    "platform": …
  },
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

レスポンスフィールド

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

フィールド	意味
`username`	ユーザー名（@ハンドル）です。
`display_name`	表示名です。usernameとは異なる場合があります。
`user_id`	プラットフォーム上でのユーザーの一意なIDです。
`is_live`	プラットフォーム上の意味のまま
`room_id`	プラットフォーム上の意味のまま
`url`	プラットフォーム上のレコードへのリンクです。
`title`	タイトルです。プラットフォームにタイトルがない場合（テキストのみの投稿など）はnullになります。
`viewer_count`	プラットフォーム上の意味のまま
`peak_viewer_count`	プラットフォーム上の意味のまま
`total_viewer_count`	プラットフォーム上の意味のまま
`like_count`	いいね数です。nullはプラットフォームまたはこの機能が公開していないことを示し、0ではありません。
`share_count`	シェア数です。nullは非公開を示し、0ではありません。
`product_count`	プラットフォーム上の意味のまま
`started_at`	プラットフォーム上の意味のまま
`cover_image_url`	プラットフォーム上の意味のまま
`stream_url`	プラットフォーム上の意味のまま
`platform`	取得元プラットフォームの識別子で、リクエストのplatformと同じです（例：xiaohongshu、tiktok）。

エラーと課金

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

エラー