RoomScope

最終更新

ランキング

ランキングの種類、地域、期間ごとの公式ランキング。

すべての操作は API キーで認証します (Authorization: Bearer <key>) 。エラーには共通のエンベロープを使用します。詳しくは次のページを参照してください： エラー. このページは API の OpenAPI ドキュメントから生成しています。

ランキングの過去の期間を一覧表示

GET/v1/rankings/history

1 つのランキングの完了した期間を、プランの履歴保持期間の範囲内で新しい順に返します。

スコープrank:readクレジットキャッシュの閲覧

クエリパラメーター

クエリパラメーター · GET /v1/rankings/history
NameTypeDescription
boardRequired
stringランキングのキー：daily、hourly、popular_live、gaming_daily、gaming_weekly、shopping_daily、shopping_weekly（shop:read が必要）、またはリーグランキング league_a1 … league_d5。
regionOptional
stringISO 3166-1 alpha-2 の地域コード。
Default: VN
cursorOptional
string前のページの nextCursor から得た不透明なカーソル。
limitOptional
integer1 ページあたりの期間数。 範囲 1–24.
Default: 24
leagueTierOptional
stringリーグのティアで絞り込み（A1 … D5）。

リクエスト

curl "https://api.toktokdata.live/v1/rankings/history?board=daily" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

レスポンス

200 OK
{  "data": {    "board": "daily",    "region": "VN",    "periods": [      {        "periodKey": "2026-10-31",        "observedAt": "2026-11-01T10:46:44.935Z",        "coverageStatus": "observed",        "publishable": true,        "entries": [          {            "rank": 1,            "creatorUid": "990000000000000001",            "uniqueId": "linh.live",            "nickname": "Linh Live",            "avatarUrl": null,            "isLive": false,            "roomId": null,            "score": 99000,            "leagueClass": null,            "leagueClassSource": null,            "leagueClassAsOf": null,            "movement": "same",            "previousRank": null,            "masked": false,            "unmaskTier": null          },          {            "rank": 2,            "creatorUid": "990000000000000102",            "uniqueId": "creator.02",            "nickname": "Creator 02",            "avatarUrl": null,            "isLive": false,            "roomId": null,            "score": 98000,            "leagueClass": null,            "leagueClassSource": null,            "leagueClassAsOf": null,            "movement": "same",            "previousRank": null,            "masked": false,            "unmaskTier": null          }        ]      }    ],    "nextCursor": null,    "hasMore": false,    "historyWindowDays": 365,    "historyTruncated": false  },  "provenance": {    "observedAt": "2026-11-01T10:46:44.935Z",    "freshness": "historical",    "source": "tiktok_observed_rank_board",    "sourceKind": "official",    "coverageStatus": "observed",    "methodologyVersion": "rankings-official-v1",    "window": null  }}

エラー

  • 400 パラメーターまたはボディが不正です。問題の内容は code で示されます。
  • 401 API キーがないか、不明なキーです。
  • 402 ワークスペースのクレジットウォレットでこの呼び出しをまかなえません。クレジットがリセットされる日時は resetAt で示されます。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。

公式ランキングを取得

GET/v1/rankings/official

1 つの地域の 1 つのランキングを、TikTok が公開しているとおりに返します。ランキングはカバー率が基準を満たした後にのみ再現されます。エントリーを表示する前に publishable と coverage を確認してください。プランで名前を表示できる範囲を超えるエントリーは、rank と score は保持したまま masked: true で返され、身元情報は含まれず、名前を表示できるプランが unmaskTier に入ります。現在の期間では、すべてのエントリーに sparkline が付きます。これは直近 7 つの完了した期間それぞれのスコアで、古い順に並び、ランキングに入っていなかった期間は null です。

スコープrank:readクレジットキャッシュの閲覧

クエリパラメーター

クエリパラメーター · GET /v1/rankings/official
NameTypeDescription
boardRequired
stringランキングのキー：daily、hourly、popular_live、gaming_daily、gaming_weekly、shopping_daily、shopping_weekly（shop:read が必要）、またはリーグランキング league_a1 … league_d5。
regionOptional
stringISO 3166-1 alpha-2 の地域コード。
Default: VN
periodOptional
"current" | "history"current は進行中の期間、history は直近の完了した期間です。
Default: current
limitOptional
integer最大エントリー数。 範囲 1–200.
Default: 200
liveOnlyOptional
"true" | "false"現在配信中のクリエイターのみ。
Default: false
leagueTierOptional
stringリーグのティアで絞り込み（A1 … D5）。

リクエスト

curl "https://api.toktokdata.live/v1/rankings/official?board=daily" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

レスポンス

200 OK
{  "data": {    "board": {      "kind": "official",      "board": "daily",      "region": "VN",      "periodKey": "2026-10-31",      "resetAt": null,      "publishable": true,      "coverage": {        "completeBoards": 1,        "expectedBoards": 22,        "ratio": 0.045454545454545456,        "threshold": 0.8      },      "entries": [        {          "rank": 1,          "creatorUid": "990000000000000001",          "uniqueId": "linh.live",          "nickname": "Linh Live",          "avatarUrl": null,          "isLive": true,          "roomId": "7990000000000000001",          "score": 99000,          "leagueClass": null,          "leagueClassSource": null,          "leagueClassAsOf": null,          "movement": "new",          "previousRank": null,          "masked": false,          "unmaskTier": null,          "sparkline": [            null,            812000,            846500,            901200,            955000,            1010300,            99000          ]        },        {          "rank": 2,          "creatorUid": "990000000000000102",          "uniqueId": "creator.02",          "nickname": "Creator 02",          "avatarUrl": null,          "isLive": false,          "roomId": null,          "score": 98000,          "leagueClass": null,          "leagueClassSource": null,          "leagueClassAsOf": null,          "movement": "new",          "previousRank": null,          "masked": false,          "unmaskTier": null,          "sparkline": [            null,            803880,            838035,            892188,            945450,            1000197,            97020          ]        }      ]    }  },  "provenance": {    "observedAt": "2026-11-01T10:46:44.935Z",    "freshness": "historical",    "source": "tiktok_observed_rank_board",    "sourceKind": "official",    "coverageStatus": "observed",    "methodologyVersion": "rankings-official-v1",    "window": {      "from": null,      "to": null,      "label": "daily"    }  }}

エラー

  • 400 パラメーターまたはボディが不正です。問題の内容は code で示されます。
  • 401 API キーがないか、不明なキーです。
  • 402 ワークスペースのクレジットウォレットでこの呼び出しをまかなえません。クレジットがリセットされる日時は resetAt で示されます。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。

対応地域を一覧表示

GET/v1/rankings/regions

観測済みのランキングが現在ある地域を、表示用のラベル付きで返します。1 日キャッシュしてください。

スコープrank:readクレジットキャッシュの閲覧

リクエスト

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

レスポンス

200 OK
{  "data": {    "regions": [      {        "region": "VN",        "label": "VN · Vietnam",        "coverage": {          "completeBoards": 1,          "expectedBoards": 22,          "ratio": 0.045454545454545456,          "threshold": 0.8        },        "boards": [          "daily"        ],        "notOfferedBoards": []      }    ]  },  "provenance": {    "observedAt": "2026-11-01T10:46:44.935Z",    "freshness": "historical",    "source": "tiktok_observed_rank_board",    "sourceKind": "official",    "coverageStatus": "observed",    "methodologyVersion": "rankings-official-v1",    "window": null  }}

エラー

  • 400 パラメーターまたはボディが不正です。問題の内容は code で示されます。
  • 401 API キーがないか、不明なキーです。
  • 402 ワークスペースのクレジットウォレットでこの呼び出しをまかなえません。クレジットがリセットされる日時は resetAt で示されます。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。
このページは役に立ちましたか？