エージェンシーにできること
tiktok-live-agencyは、TikTok LIVEエージェンシー(Creator Networks、TCN、MCN)向けに作られた型付きクライアントでtik.tools APIをラップしています。npmとPyPIで同じパッケージ名を使い、どちらのクライアントも同じメソッド一覧を共有しています。
- スカウトするクリエイターを探す。 エージェンシーに参加する候補となる地域別のランキング入りクリエイター、スカウト候補に新しく加わったクリエイター、リーグから落ちていくクリエイターを取得できます。
- 所属クリエイターの配信状況とダイヤモンド。 所属クリエイターの誰が今配信中かを確認し、配信中に記録されたギフトからクリエイター別・所属リスト別のダイヤモンドを取得できます。
- Webhook。 署名付きの配信開始・配信終了アラートをあなたのサーバーに送信。Node、Edge、Workers、Python用の検証ツール付きです。
- カスタムダッシュボード。 APIと同じフィールド名を使ったシンプルなJSONなので、Next.jsのページ、ノートブック、スプレッドシートへのエクスポートにそのまま使えます。
インストール
JavaScript・TypeScript
npm install tiktok-live-agencyPython
pip install tiktok-live-agency
# optional, for the real-time big gifts stream
pip install "tiktok-live-agency[realtime]"キーはサーバーのTIKTOOLS_API_KEY環境変数に設定してください。ブラウザには絶対に含めないでください。TypeScriptクライアントはブラウザのページでは起動しません。キーは料金ページで取得できます。
コード例
所属クリエイターの誰が配信中か(TypeScript)
import { AgencyClient } from 'tiktok-live-agency'
const tt = new AgencyClient() // reads TIKTOOLS_API_KEY
const { live, offline, unknown } = await tt.whoIsLive(['creator_one', 'creator_two', 'creator_three'])
console.log(live.map((r) => r.unique_id))Next.jsのRoute Handlerで配信開始Webhookを検証する(TypeScript)
// app/api/webhooks/tiktools/route.ts
import { verifyWebhook } from 'tiktok-live-agency/webhooks'
export async function POST(req: Request) {
const raw = await req.text() // raw body, verify before parsing
try {
const event = await verifyWebhook(raw, req.headers, process.env.TIKTOOLS_WEBHOOK_SECRET!)
console.log(event.event, event.creator.unique_id)
} catch {
return new Response('bad signature', { status: 400 })
}
return new Response('ok')
}スカウト候補のクリエイターと所属リストのダイヤモンド(Python)
from tiktok_live_agency import AgencyClient, is_free_to_join
tt = AgencyClient() # reads TIKTOOLS_API_KEY
rows = list(tt.iter_creators_to_recruit("UK", max_pages=5))
free = [r for r in rows if is_free_to_join(r)]
roster = tt.list_rosters()["lists"][0]
week = tt.roster_diamonds(roster["id"], days=7)
print(len(free), week["totalDiamonds"])ご利用のプランに含まれない呼び出しは、必要なプランとアップグレードリンクを含むPlanRequiredErrorをスローします。そのため、ダッシュボードはクラッシュせずにアップグレードカードを表示できます。Webhookのペイロードと署名についてはAPIリファレンスをご覧ください。
メソッドグループ
findCreatorsToRecruititerCreatorsToRecruitisFreeToJoinnewCreatorsleagueMembersleagueDropoutsdroppedOutCreatorsleaderboardglobalLeaderboardclubRankingsgamingRankingspopularLiveliveCountstopGiftersgetCreatorgetCreatorProfilefindRenamedCreatorresolveUserIdsgetCreatorSummarygetDailyDiamondsgetCreatorGiftsgetCreatorGiftersgetCreatorBattlesgetCreatorChatcreateRosterlistRostersgetRosteraddToRosterremoveFromRosterrosterDiamondsisLivewhoIsLivewatchLivestreamBigGiftsgetEligibilitygetEligibilityAccountscreateWebhooklistWebhooksupdateWebhooktestWebhookdeleteWebhookverifyWebhookgetAccountlistRegionsPythonでは同じ名前をsnake_caseで使います(例: who_is_live、find_creators_to_recruit)。すべてのメソッドと対応プランは、各パッケージのREADMEに記載されています。
AIアシスタント向け
すべてのメソッドの機械可読な概要はtik.tools/sdk/agency/llms.txtにあります。Cursor、Claude、ChatGPTなどのAIビルダーにこれを読み込ませ、パッケージ名にtiktok-live-agencyを指定すれば、生成されたコードがAPIの実データを使うようになります。
ソースとパッケージ
- TypeScript: github.com/tiktool/tiktok-live-agency、npm
- Python: github.com/tiktool/tiktok-live-agency-python、PyPI
- ライセンス: MIT
非公式であり、TikTokおよびByteDanceとは提携していません。tiktok-live-agencyはtik.tools API用の独立したSDKです。TikTokは各所有者の商標であり、ここでは互換性の説明のためにのみ使用しています。