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.roomscope.io.
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 →- 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.
- ChangedError envelopeEvery error now returns { code, message, requestId, retryable }. Clients should branch on code and retry only when retryable is true.
- AddedRankings: provenance blockGET /v1/rankings/official returns a provenance object (coverageStatus, observedAt) next to data.