RoomScope API · v1
Build on LIVE intelligence
The same rankings, LIVE sessions, creators and alerts as the dashboard, through scoped API keys and metered from the same credit wallet. Base URL https://api.toktokdata.live.
Tài liệu kỹ thuật hiện chỉ có bằng tiếng Anh.
Get startedCreate an API key and make your first request in five minutes.ReadAuthenticationBearer keys, scopes and rotation.ReadRankings APIOfficial boards per region with coverage and provenance.ReadWebhooksSigned deliveries for gifts, envelopes and LIVE starts.Read
Popular endpoints
- GET
/v1/rankings/officialOfficial leaderboard - GET
/v1/rankings/regionsCovered regions - GET
/v1/creators/{uid}Creator profile - GET
/v1/live/sessionsLIVE session history - POST
/v1/alerts/rulesCreate an alert rule
What’s new
Full changelog →- ChangedWebhook headers renamedWebhook deliveries now carry x-roomscope-signature, x-roomscope-timestamp, x-roomscope-alert-id and x-roomscope-schema-version. The signing scheme and payload are unchanged; read the new header names when verifying.
- FixedDocs match the APIErrors, Credits, Rate limits, Authentication and Webhooks now describe the live behaviour: real error codes, per-key rate limits with X-RateLimit headers, credit costs and monthly allotments, and the signed webhook scheme. The reference adds creator insights, best time and presence. Docs search is on (⌘K).
- AddedAPI docs templateGet started, Authentication, Errors, Rate limits, the Rankings reference and Webhooks. Reference pages for the remaining resources follow once they are generated from the OpenAPI document.