Cập nhật lần cuối
Credits
Every workspace has a credit wallet that refills each billing period. API calls and dashboard reads draw from the same wallet; the reference lists the class of each operation.
What an operation costs
| Class | Credits per call | Covers |
|---|---|---|
| Cached read | 1 | Every read of stored data: rankings, creators, insights, videos, comments, trends, LIVE sessions. Listing API keys (GET /v1/api-keys) is a cached read too. |
| Follow list | 4,000 | GET /v1/creators/{uid}/following or /followers when the list has to be collected fresh (instead of 1). |
| Comments | 500 | GET /v1/videos/{id}/comments when the comments have to be collected fresh (instead of 1). |
| Profile resolve | 1,250 | GET /v1/creators/{uid} when a stale profile is resolved again, on top of the read. Charged only if a profile comes back. |
| Live refresh | 1,250 | POST /v1/live/creators/{uid}/refresh: ask the workers to check a creator now. |
| Export | 2,500 | POST /v1/exports: build a CSV or Excel file. |
| Webhook delivery | 1 | Each webhook an alert rule delivers, including the one a rule test sends. |
| Free | 0 | Managing alert rules, listing and downloading exports, creating and revoking keys, entitlements and usage. |
Each operation in the reference shows its class next to its scope. A 202 answer (collection still running) is charged as a cached read.
Monthly allotment
Each calendar month (UTC) the workspace’s plan grants its allotment, on the first metered call or wallet read of the month. Spending in a month cannot go past the allotment. See pricing for the plans.
| Plan | Credits per month |
|---|---|
| Free | 150,000 |
| Starter | 450,000 |
| Pro | 3,000,000 |
| Scale | 12,000,000 |
| Agency / Enterprise | 36,000,000 |
When the wallet is empty
A metered call that would go past the cap answers 402 with code credit_cap_exceeded in the usual error envelope. Free operations keep working. The wallet refills at the start of the next month; upgrading mid-month raises the cap.
4xx or 5xx answer costs nothing. A 2xx or 3xx is charged.Read the wallet
GET /v1/entitlements returns the plan, limits and the wallet of the current period; GET /v1/usage breaks spending down by operation. Both are free and need the keys:manage scope.
curl "https://api.toktokdata.live/v1/entitlements" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY" # data.credits: { "period": "2026-11-01", "monthlyAllotment": …, "hardCap": …, "spent": …, "remaining": … }