RoomScope

最後更新

創作者

已儲存的創作者檔案、變化、追蹤關係與分析。

所有操作都以 API 金鑰進行身分驗證 (Authorization: Bearer <key>) ；錯誤一律使用共通的錯誤格式，說明請見 錯誤. 本頁由 API 的 OpenAPI 文件產生。

搜尋創作者

GET/v1/creators

以帳號名稱或顯示名稱的部分字串搜尋，不分大小寫，粉絲數最多者優先。q 為空時會瀏覽已儲存的全部資料。

權限範圍creator:read點數快取讀取

查詢參數

查詢參數 · GET /v1/creators
NameTypeDescription
qOptional
string帳號名稱（可含或不含 @）或顯示名稱的一部分。
limitOptional
integer最多結果數。 範圍 1–100.
Default: 20

請求

curl "https://api.toktokdata.live/v1/creators" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "query": "linh.live",    "results": [      {        "tiktokUserId": "990000000000000001",        "uniqueId": "linh.live",        "displayName": "Linh Live",        "region": "VN",        "avatarUrl": null,        "followerCount": 123456,        "verified": true      }    ]  },  "provenance": {    "observedAt": "2026-11-01T10:36:44.935Z",    "freshness": "near_realtime",    "source": "public_creator_profile",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "creators-v1",    "window": null  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。

取得創作者檔案

GET/v1/creators/{uid}

已儲存的公開檔案及其各項計數的近期歷史紀錄。

權限範圍creator:read點數快取讀取

路徑參數

路徑參數 · GET /v1/creators/{uid}
NameTypeDescription
uidRequired
string不含 @ 的創作者帳號名稱（linh.live）或數字形式的 TikTok 使用者 ID。

請求

curl "https://api.toktokdata.live/v1/creators/linh.live" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "creator": {      "tiktokUserId": "990000000000000001",      "uniqueId": "linh.live",      "secUid": null,      "displayName": "Linh Live",      "region": "VN",      "language": null,      "signature": "Daily LIVE from Hanoi",      "avatarUrl": null,      "followerCount": 123456,      "followingCount": 321,      "awemeCount": 3,      "totalFavorited": 9876543,      "favoritingCount": null,      "verified": true,      "customVerify": null,      "enterpriseVerifyReason": null,      "instagramId": null,      "youtubeChannelId": null,      "twitterId": null,      "firstSeenAt": "2026-10-02T10:51:44.935Z",      "lastRefreshedAt": "2026-11-01T10:36:44.935Z",      "history": []    }  },  "provenance": {    "observedAt": "2026-11-01T10:36:44.935Z",    "freshness": "near_realtime",    "source": "public_creator_profile",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "creators-v1",    "window": null  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。

分析創作者的影片

GET/v1/creators/{uid}/analysis

僅根據已儲存的影片計算的互動報告：總計、中位數與發文頻率。

權限範圍creator:read點數快取讀取

路徑參數

路徑參數 · GET /v1/creators/{uid}/analysis
NameTypeDescription
uidRequired
string不含 @ 的創作者帳號名稱（linh.live）或數字形式的 TikTok 使用者 ID。

請求

curl "https://api.toktokdata.live/v1/creators/linh.live/analysis" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "creator": {      "tiktokUserId": "990000000000000001",      "uniqueId": "linh.live",      "displayName": "Linh Live",      "avatarUrl": null,      "region": "VN",      "verified": true,      "followerCount": 123456,      "followingCount": 321,      "awemeCount": 3,      "totalFavorited": 9876543,      "firstSeenAt": "2026-10-02T10:51:44.935Z",      "lastRefreshedAt": "2026-11-01T10:36:44.935Z"    },    "sample": {      "videosAnalyzed": 3,      "oldestVideoAt": "2026-10-29T10:51:44.935Z",      "newestVideoAt": "2026-10-31T10:51:44.935Z",      "spanDays": 2,      "shareOfCatalog": 1    },    "engagement": {      "totalPlays": 60000,      "totalLikes": 6000,      "totalComments": 600,      "totalShares": 0,      "avgPlays": 20000,      "medianPlays": 20000,      "avgLikes": 2000,      "avgComments": 200,      "avgShares": 0,      "engagementRate": 0.11,      "likeRate": 0.1,      "commentRate": 0.01,      "shareRate": 0,      "viewsPerFollower": 0.162    },    "cadence": {      "postsPerWeek": 7,      "avgDaysBetweenPosts": 1,      "longestGapDays": 1,      "busiestWeekday": 4,      "postsByWeekday": [        0,        0      ]    },    "topByPlays": [      {        "videoId": "7990000000000000003",        "description": "Video 3",        "createTime": "2026-10-29T10:51:44.935Z",        "playCount": 30000,        "diggCount": 3000,        "commentCount": 300,        "shareCount": null,        "engagementRate": 0.11      },      {        "videoId": "7990000000000000002",        "description": "Video 2",        "createTime": "2026-10-30T10:51:44.935Z",        "playCount": 20000,        "diggCount": 2000,        "commentCount": 200,        "shareCount": null,        "engagementRate": 0.11      }    ],    "topByEngagement": [      {        "videoId": "7990000000000000001",        "description": "Video 1",        "createTime": "2026-10-31T10:51:44.935Z",        "playCount": 10000,        "diggCount": 1000,        "commentCount": 100,        "shareCount": null,        "engagementRate": 0.11      },      {        "videoId": "7990000000000000002",        "description": "Video 2",        "createTime": "2026-10-30T10:51:44.935Z",        "playCount": 20000,        "diggCount": 2000,        "commentCount": 200,        "shareCount": null,        "engagementRate": 0.11      }    ],    "audience": null,    "growth": null,    "limits": [      {        "code": "thin-video-sample",        "message": "Only 3 video(s) analysed — too few to describe the account's typical performance."      },      {        "code": "single-observation",        "message": "This account has been observed only once, so no follower growth can be shown yet."      }    ]  },  "provenance": {    "observedAt": "2026-11-01T10:36:44.935Z",    "freshness": "near_realtime",    "source": "derived_creator_analysis",    "sourceKind": "derived",    "coverageStatus": "partial",    "methodologyVersion": "analysis-v1",    "window": null  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。

列出檔案變化

GET/v1/creators/{uid}/changes

隨時間觀測到的帳號名稱、名稱、簡介與認證狀態變化，由新到舊排列。

權限範圍creator:read點數快取讀取

路徑參數

路徑參數 · GET /v1/creators/{uid}/changes
NameTypeDescription
uidRequired
string不含 @ 的創作者帳號名稱（linh.live）或數字形式的 TikTok 使用者 ID。

查詢參數

查詢參數 · GET /v1/creators/{uid}/changes
NameTypeDescription
limitOptional
integer最多變化筆數。 範圍 1–200.
Default: 50

請求

curl "https://api.toktokdata.live/v1/creators/linh.live/changes" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "tiktokUserId": "990000000000000001",    "uniqueId": "linh.live",    "changes": []  },  "provenance": {    "observedAt": "2026-10-02T10:51:44.935Z",    "freshness": "stale",    "source": "public_creator_profile",    "sourceKind": "derived",    "coverageStatus": "partial",    "methodologyVersion": "creators-v1",    "window": null  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。

列出創作者的粉絲

GET/v1/creators/{uid}/followers

已儲存的粉絲，格式與追蹤中名單相同。

權限範圍creator:read點數快取讀取

路徑參數

路徑參數 · GET /v1/creators/{uid}/followers
NameTypeDescription
uidRequired
string不含 @ 的創作者帳號名稱（linh.live）或數字形式的 TikTok 使用者 ID。

查詢參數

查詢參數 · GET /v1/creators/{uid}/followers
NameTypeDescription
cursorOptional
string來自上一頁 nextCursor 的不透明游標。
limitOptional
integer每頁項目數。

請求

curl "https://api.toktokdata.live/v1/creators/linh.live/followers" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "tiktokUserId": "990000000000000001",    "uniqueId": "linh.live",    "direction": "following",    "entries": [],    "nextCursor": null,    "hasMore": false,    "totalReported": null,    "storedCount": 0,    "isPrivate": false  },  "provenance": {    "observedAt": "2026-11-01T11:18:49.084Z",    "freshness": "stale",    "source": "public_follow_graph",    "sourceKind": "derived",    "coverageStatus": "not-covered",    "methodologyVersion": "follow-list-v1",    "window": null  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。

列出創作者追蹤的帳號

GET/v1/creators/{uid}/following

已儲存的追蹤關係。私人帳號會回傳 isPrivate: true 且不含任何項目。

權限範圍creator:read點數快取讀取

路徑參數

路徑參數 · GET /v1/creators/{uid}/following
NameTypeDescription
uidRequired
string不含 @ 的創作者帳號名稱（linh.live）或數字形式的 TikTok 使用者 ID。

查詢參數

查詢參數 · GET /v1/creators/{uid}/following
NameTypeDescription
cursorOptional
string來自上一頁 nextCursor 的不透明游標。
limitOptional
integer每頁項目數。

請求

curl "https://api.toktokdata.live/v1/creators/linh.live/following" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "tiktokUserId": "990000000000000001",    "uniqueId": "linh.live",    "direction": "following",    "entries": [],    "nextCursor": null,    "hasMore": false,    "totalReported": null,    "storedCount": 0,    "isPrivate": false  },  "provenance": {    "observedAt": "2026-11-01T11:18:49.084Z",    "freshness": "stale",    "source": "public_follow_graph",    "sourceKind": "derived",    "coverageStatus": "not-covered",    "methodologyVersion": "follow-list-v1",    "window": null  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。

取得創作者的熱門送禮者

GET/v1/creators/{uid}/gifters

過去 7 天或 30 天內在創作者 LIVE 直播間送禮的送禮者，依鑽石數排序：禮物數、場次、最後一次送禮，以及其最後送禮之直播間的創作者。資料讀取自 RoomScope 記錄的場次，因此覆蓋率一律為 partial。需要 Pro 方案以上。

權限範圍gifter:read點數快取讀取

路徑參數

路徑參數 · GET /v1/creators/{uid}/gifters
NameTypeDescription
uidRequired
string不含 @ 的創作者帳號名稱（linh.live）或數字形式的 TikTok 使用者 ID。

查詢參數

查詢參數 · GET /v1/creators/{uid}/gifters
NameTypeDescription
windowOptional
"7d" | "30d"7d 或 30d。
Default: 7d
limitOptional
integer最多列數。 範圍 …–100.
Default: 20

請求

curl "https://api.toktokdata.live/v1/creators/linh.live/gifters" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "creatorUid": "7012345678901234567",    "uniqueId": "linh.live",    "window": "7d",    "gifters": [      {        "gifterUserId": "6987001122334455667",        "gifterUniqueId": "minh.fan",        "gifterNickname": "Minh",        "avatarUrl": null,        "diamondTotal": 18450,        "giftCount": 312,        "sessions": 4,        "lastGiftAt": "2026-11-02T15:41:07.512Z",        "lastRoomCreator": "linh.live"      }    ]  },  "provenance": {    "observedAt": "2026-11-02T15:41:07.512Z",    "freshness": "historical",    "source": "platform_observed_gifter_events",    "sourceKind": "derived",    "coverageStatus": "partial",    "methodologyVersion": "gifters-observed-v1",    "window": {      "from": "2026-10-27T04:00:00.000Z",      "to": "2026-11-03T04:00:00.000Z",      "label": "7d"    }  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。

取得創作者的洞察

GET/v1/creators/{uid}/insights

帳號名稱歷史、最近 30 天的每日鑽石（由新到舊）、每日聯賽快照，以及創作者的 LIVE 直播間。當天的分數若是在榜單重置時讀取，liveExact 為 true；否則 liveScore 為當天讀取到的最高分數。observedCoins 計算 RoomScope 在創作者 LIVE 場次中記錄到的鑽石。已變更的帳號名稱仍可透過別名歷史解析。

權限範圍creator:read點數快取讀取

路徑參數

路徑參數 · GET /v1/creators/{uid}/insights
NameTypeDescription
uidRequired
string不含 @ 的創作者帳號名稱（linh.live）或數字形式的 TikTok 使用者 ID。

請求

curl "https://api.toktokdata.live/v1/creators/linh.live/insights" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "creator": {      "uid": "6990000000000000001",      "uniqueId": "linh.live"    },    "aliases": [      {        "uniqueId": "linh.live",        "firstSeenAt": "2026-10-12T09:15:02.118Z",        "lastSeenAt": "2026-11-01T14:02:41.530Z"      },      {        "uniqueId": "linh.official",        "firstSeenAt": "2026-09-30T11:40:19.004Z",        "lastSeenAt": "2026-10-12T08:55:47.912Z"      }    ],    "daily": [      {        "boardDay": "2026-10-31",        "countryCode": "VN",        "tiktokScore": 184250,        "observedCoins": 171932,        "liveScore": 184250,        "liveExact": true,        "leagueClass": "B2"      },      {        "boardDay": "2026-10-30",        "countryCode": "VN",        "tiktokScore": 97410,        "observedCoins": null,        "liveScore": 97410,        "liveExact": false,        "leagueClass": "B2"      }    ],    "league": [      {        "day": "2026-10-31",        "leagueClass": "B2",        "leagueRank": 14,        "leagueCountry": "VN",        "followers": 412880      }    ],    "roomOwner": {      "roomId": "7432000000000000001",      "ownerUid": "6990000000000000001",      "ownerUniqueId": "linh.live",      "claimantUid": null,      "reason": "claim_confirmed",      "checkedAt": "2026-11-01T14:00:03.221Z"    }  },  "provenance": {    "observedAt": "2026-11-01T14:02:41.530Z",    "freshness": "near_realtime",    "source": "creator_analytics",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "creator-analytics-v1",    "window": {      "from": "2026-10-02T14:02:41.530Z",      "to": "2026-11-01T14:02:41.530Z",      "label": "30d"    }  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。

取得最佳開播時間

GET/v1/insights/best-time

某地區已記錄的 LIVE 場次在最近 windowDays 天內的鑽石與送禮者時數，依星期（0 = 星期一）與 UTC 小時分組。每日重新計算；該地區尚無任何紀錄時，cells 為空。

權限範圍creator:read點數快取讀取

查詢參數

查詢參數 · GET /v1/insights/best-time
NameTypeDescription
regionOptional
stringISO 3166-1 alpha-2 地區代碼。
Default: VN

請求

curl "https://api.toktokdata.live/v1/insights/best-time" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "region": "VN",    "windowDays": 28,    "computedAt": "2026-11-01T01:00:04.870Z",    "cells": [      {        "weekday": 0,        "hour": 12,        "diamonds": 418230,        "gifterHours": 1874      },      {        "weekday": 0,        "hour": 13,        "diamonds": 652910,        "gifterHours": 2410      },      {        "weekday": 0,        "hour": 14,        "diamonds": 701455,        "gifterHours": 2689      }    ]  },  "provenance": {    "observedAt": "2026-11-01T01:00:04.870Z",    "freshness": "near_realtime",    "source": "creator_analytics",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "creator-analytics-v1",    "window": {      "from": "2026-10-04T01:00:04.870Z",      "to": "2026-11-01T01:00:04.870Z",      "label": "28d"    }  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。

取得每小時 LIVE 上線狀態

GET/v1/insights/presence

每小時該地區追蹤中的上榜創作者有多少人正在直播，由舊到新排列。

權限範圍creator:read點數快取讀取

查詢參數

查詢參數 · GET /v1/insights/presence
NameTypeDescription
regionOptional
stringISO 3166-1 alpha-2 地區代碼。
Default: VN
hoursOptional
integer往回查詢的小時數。 範圍 1–168.
Default: 48

請求

curl "https://api.toktokdata.live/v1/insights/presence" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

回應

200 OK
{  "data": {    "region": "VN",    "hours": 48,    "points": [      {        "hourStart": "2026-11-01T12:00:00.000Z",        "liveCreators": 214,        "trackedCreators": 1630      },      {        "hourStart": "2026-11-01T13:00:00.000Z",        "liveCreators": 251,        "trackedCreators": 1642      },      {        "hourStart": "2026-11-01T14:00:00.000Z",        "liveCreators": 268,        "trackedCreators": 1655      }    ]  },  "provenance": {    "observedAt": "2026-11-01T14:05:01.402Z",    "freshness": "near_realtime",    "source": "creator_analytics",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "creator-analytics-v1",    "window": {      "from": "2026-10-30T14:05:01.402Z",      "to": "2026-11-01T14:05:01.402Z",      "label": "48h"    }  }}

錯誤

  • 400 參數或請求主體無效；code 會指出問題所在。
  • 401 API 金鑰缺少或不存在。
  • 402 工作區的點數錢包不足以支付此呼叫；resetAt 表示點數重置的時間。
  • 403 金鑰缺少該權限範圍，或方案未包含此功能。
  • 429 超過請求速率；請遵守 Retry-After。
這個頁面對你有幫助嗎？