SDK

TikTok LIVE Agency SDK

找出可招募的直播主、看旗下名單誰正在直播、追蹤鑽石、接收開播 Webhook,打造你自己的公會儀表板。一組 API 金鑰,支援 JavaScript、TypeScript 和 Python。

能為公會做什麼

tiktok-live-agency 把 tik.tools API 包成型別化的用戶端,專為 TikTok LIVE 公會(Creator Networks、TCN、MCN)打造。npm 和 PyPI 上的套件名稱相同,兩個用戶端共用同一份方法清單。

  • 找出可招募的直播主。 各地區有機會加入公會的排名直播主、招募池中的新面孔,以及跌出聯賽的直播主。
  • 旗下名單直播狀態和鑽石。 查看你的直播主現在誰正在直播,並依直播期間記錄到的禮物,讀取每位直播主和整份名單的鑽石數。
  • Webhook。 已簽章的開播和下播通知直接送到你的伺服器,並提供 Node、Edge、Workers 和 Python 的驗證工具。
  • 自訂儀表板。 純 JSON,沿用 API 本身的欄位名稱,資料可以直接放進 Next.js 頁面、notebook 或試算表匯出。

安裝

JavaScript 和 TypeScript

npm install tiktok-live-agency

Python

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 payload 和簽章說明請見API 參考文件。

方法群組

群組方法
找出可招募的直播主findCreatorsToRecruititerCreatorsToRecruitisFreeToJoinnewCreatorsleagueMembersleagueDropoutsdroppedOutCreators
排名與市場leaderboardglobalLeaderboardclubRankingsgamingRankingspopularLiveliveCountstopGifters
查核直播主getCreatorgetCreatorProfilefindRenamedCreatorresolveUserIds
直播主數據getCreatorSummarygetDailyDiamondsgetCreatorGiftsgetCreatorGiftersgetCreatorBattlesgetCreatorChat
旗下名單createRosterlistRostersgetRosteraddToRosterremoveFromRosterrosterDiamonds
直播狀態isLivewhoIsLivewatchLive
大禮物串流streamBigGifts
資格判定getEligibilitygetEligibilityAccounts
WebhookcreateWebhooklistWebhooksupdateWebhooktestWebhookdeleteWebhookverifyWebhook
帳號getAccountlistRegions

Python 使用相同名稱的 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 的真實資料。

原始碼與套件

非官方,與 TikTok 或 ByteDance 無關。tiktok-live-agency 是 tik.tools API 的獨立 SDK。TikTok 是其所有者的商標,在此僅用於說明相容性。