Última atualização
Conta
Plano, limites e uso de créditos do espaço de trabalho da chave.
Toda operação se autentica com uma chave de API (Authorization: Bearer <key>) e os erros usam o envelope comum descrito em Erros. Gerado a partir do documento OpenAPI da API.
Obter plano e limites
/v1/entitlementsO plano, os módulos, os limites de ritmo e a carteira de créditos do workspace em um período de cobrança: limits.watchlistMax, limits.requestsPerMinute (requisições com chave de API por minuto somando todas as chaves do workspace), credits.hardCap (os créditos do plano mais as recargas do período), credits.resetAt (quando os créditos do período reiniciam), exports (exportações no app hoje; perDay é 0 no free e null, ilimitado, nos planos pagos) e money (1 diamante em USD bruto estimado, a parte do criador e a cotação mensal em VND: estimativas para exibição, nunca o pagamento do TikTok).
Parâmetros de query
| Name | Type | Description |
|---|---|---|
periodOptional | string | Início do período de cobrança, YYYY-MM-01; o padrão é o período atual. |
Requisição
curl "https://api.next.toktokdata.live/v1/entitlements" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Resposta
{ "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" } }}Erros
400Parâmetro ou corpo inválido;codeindica o problema.401Chave de API ausente ou desconhecida.403A chave não tem o escopo, ou o plano não inclui o recurso.429Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeiteRetry-After.
Obter o uso de créditos
/v1/usageCréditos gastos por operação em um período de cobrança.
Parâmetros de query
| Name | Type | Description |
|---|---|---|
periodOptional | string | Início do período de cobrança, YYYY-MM-01; o padrão é o período atual. |
limitOptional | integer | Número máximo de linhas. |
Requisição
curl "https://api.next.toktokdata.live/v1/usage" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Resposta
{ "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" } }}Erros
400Parâmetro ou corpo inválido;codeindica o problema.401Chave de API ausente ou desconhecida.403A chave não tem o escopo, ou o plano não inclui o recurso.429Ritmo de requisições excedido (por segundo, por minuto ou por dia); respeiteRetry-After.