RoomScope

最後更新

帳號

金鑰所屬工作區的方案、限制與點數用量。

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

取得方案與限制

GET/v1/entitlements

工作區在某個計費週期的方案、模組、速率限制與點數錢包：limits.watchlistMax、credits.resetAt（本期點數重置的時間）、exports（目前為應用程式內匯出；未套用每日上限時 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。
這個頁面對你有幫助嗎？