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
integer1 ページあたりのエントリー数。

リクエスト

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
integer1 ページあたりのエントリー数。

リクエスト

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 に従ってください。

LIVE 配信に最適な時間帯を取得

GET/v1/insights/best-time

過去 windowDays 日間に記録した地域の LIVE セッションのダイヤモンドとギフター時間を、曜日（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

地域で追跡しているランクイン済みクリエイターのうち、何人が配信中だったかを 1 時間ごとに古い順で返します。

スコープ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 に従ってください。
このページは役に立ちましたか？