Last updated
Account
Plan, limits and credit usage of the key's workspace.
Every operation authenticates with an API key (Authorization: Bearer <key>) and errors use the shared envelope described in Errors. Generated from the API’s OpenAPI document.
Get plan and limits
/v1/entitlementsThe workspace's plan, modules, rate limits and credit wallet for a billing period: limits.watchlistMax, limits.requestsPerMinute (API-key requests per minute across the workspace's keys), credits.hardCap (the plan's credits plus the period's top-ups), credits.resetAt (when the period's credits reset), exports (in-app exports today; perDay is 0 on free and null, unlimited, on paid plans) and money (1 diamond in estimated gross USD, the creator's share and the monthly VND rate: estimates for display, never TikTok's payout).
Query parameters
| Name | Type | Description |
|---|---|---|
periodOptional | string | Billing period start, YYYY-MM-01; defaults to the current one. |
Request
curl "https://api.next.toktokdata.live/v1/entitlements" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Response
{ "data": { "workspaceId": "4388fdb0-ef68-5d01-ac84-b683b2b355e8", "planCode": "agency", "tier": "agency", "modules": [ "live", "lookup" ], "limits": { "requestsPerWindow": 150, "rateWindowMs": 1000, "apiRequestsPerSecond": 150, "requestsPerDay": 1200000, "requestsPerMinute": 9000, "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" } }}Errors
400Invalid parameter or body;codenames the problem.401Missing or unknown API key.403The key lacks the scope, or the plan does not include the feature.429Request rate exceeded (per second, per minute or per day); honourRetry-After.
Get credit usage
/v1/usageCredits spent per operation in a billing period.
Query parameters
| Name | Type | Description |
|---|---|---|
periodOptional | string | Billing period start, YYYY-MM-01; defaults to the current one. |
limitOptional | integer | Maximum rows. |
Request
curl "https://api.next.toktokdata.live/v1/usage" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Response
{ "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" } }}Errors
400Invalid parameter or body;codenames the problem.401Missing or unknown API key.403The key lacks the scope, or the plan does not include the feature.429Request rate exceeded (per second, per minute or per day); honourRetry-After.