Última actualización
Cuenta
Plan, límites y uso de créditos del espacio de trabajo de la clave.
Cada operación se autentica con una clave de API (Authorization: Bearer <key>) y los errores usan el sobre compartido que se describe en Errores. Generado a partir del documento OpenAPI de la API.
Obtener el plan y los límites
/v1/entitlementsEl plan, los módulos, los límites de ritmo y la cartera de créditos del workspace en un periodo de facturación: limits.watchlistMax, limits.requestsPerMinute (solicitudes con clave de API por minuto entre todas las claves del workspace), credits.hardCap (los créditos del plan más las recargas del periodo), credits.resetAt (cuándo se reinician los créditos del periodo), exports (exportaciones en la app hoy; perDay es 0 en free y null, sin límite, en los planes de pago) y money (1 diamante en USD brutos estimados, la parte del creador y el tipo de cambio mensual a VND: estimaciones para mostrar, nunca el pago de TikTok).
Parámetros de consulta
| Name | Type | Description |
|---|---|---|
periodOptional | string | Inicio del periodo de facturación, YYYY-MM-01; de forma predeterminada, el actual. |
Solicitud
curl "https://api.next.toktokdata.live/v1/entitlements" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Respuesta
{ "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" } }}Errores
400Parámetro o cuerpo no válido;codeindica el problema.401Clave de API ausente o desconocida.403La clave no tiene el alcance, o el plan no incluye la función.429Se superó el ritmo de solicitudes (por segundo, por minuto o por día); respetaRetry-After.
Obtener el uso de créditos
/v1/usageCréditos gastados por operación en un periodo de facturación.
Parámetros de consulta
| Name | Type | Description |
|---|---|---|
periodOptional | string | Inicio del periodo de facturación, YYYY-MM-01; de forma predeterminada, el actual. |
limitOptional | integer | Máximo de filas. |
Solicitud
curl "https://api.next.toktokdata.live/v1/usage" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Respuesta
{ "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" } }}Errores
400Parámetro o cuerpo no válido;codeindica el problema.401Clave de API ausente o desconocida.403La clave no tiene el alcance, o el plan no incluye la función.429Se superó el ritmo de solicitudes (por segundo, por minuto o por día); respetaRetry-After.