RoomScope

最終更新

アカウント

キーが属するワークスペースのプラン、制限、クレジットの使用量。

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

プランと制限を取得

GET/v1/entitlements

請求期間におけるワークスペースのプラン、モジュール、レート制限、クレジットウォレット：limits.watchlistMax、credits.resetAt（その期間のクレジットがリセットされる日時）、exports（本日のアプリ内エクスポート数。1 日あたりの上限がない間は perDay は null）、money（1 ダイヤモンドの推定総額（USD）、クリエイターの取り分、月次の VND レート。表示用の推定値であり、TikTok の支払額ではありません）。

スコープkeys:manageクレジット無料

クエリパラメーター

クエリパラメーター · GET /v1/entitlements
NameTypeDescription
periodOptional
string請求期間の開始日（YYYY-MM-01）。デフォルトは現在の期間です。

リクエスト

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

レスポンス

200 OK
{  "data": {    "workspaceId": "4388fdb0-ef68-5d01-ac84-b683b2b355e8",    "planCode": "agency",    "tier": "agency",    "modules": [      "live",      "lookup"    ],    "limits": {      "requestsPerWindow": 150,      "rateWindowMs": 1000,      "apiRequestsPerSecond": 150,      "requestsPerDay": 1200000,      "maxApiKeys": 0,      "wsConcurrencyCap": 200,      "maxRoomMinutesPerMonth": 800000,      "historyWindowDays": 365,      "maxSeats": 10,      "seatsUsed": 2,      "exportFormats": [        "csv",        "xlsx"      ],      "watchlistMax": 25    },    "credits": {      "period": "2026-11-01",      "monthlyAllotment": 36000000,      "hardCap": 36000000,      "spent": 0,      "remaining": 0,      "resetAt": "2026-12-01T00:00:00.000Z"    },    "money": {      "diamondUsdGross": 0.01,      "creatorShare": 0.5,      "vndPerUsd": 25500,      "rateLabel": "estimate · 2026-11"    },    "exports": {      "perDay": null,      "usedToday": 1    }  },  "provenance": {    "observedAt": "2026-11-01T11:19:24.411834Z",    "freshness": "near_realtime",    "source": "plan_entitlement",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "entitlements-v1",    "window": {      "from": "2026-11-01",      "to": "2026-12-01",      "label": "2026-11"    }  }}

エラー

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

クレジットの使用量を取得

GET/v1/usage

請求期間内に操作ごとに消費したクレジット。

スコープkeys:manageクレジット無料

クエリパラメーター

クエリパラメーター · GET /v1/usage
NameTypeDescription
periodOptional
string請求期間の開始日（YYYY-MM-01）。デフォルトは現在の期間です。
limitOptional
integer最大行数。

リクエスト

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

レスポンス

200 OK
{  "period": "2026-11-01",  "balance": {    "remaining": 0,    "spent": 0  },  "items": [],  "provenance": {    "observedAt": "2026-11-01T10:00:00.000Z",    "freshness": "near_realtime",    "source": "credit_ledger",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "usage-v1",    "window": {      "from": "2026-11-01",      "to": "2026-12-01",      "label": "2026-11"    }  }}

エラー

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