RoomScope

Última atualização

Primeiros passos

Três passos: criar uma chave, chamar um endpoint e ler a procedência. Cada requisição é cobrada da carteira de créditos do seu espaço de trabalho, a mesma que o painel usa.

Pré-requisitos

  • Um espaço de trabalho na RoomScope. Comece grátis se ainda não tiver um; o plano Free pode ler rankings em cache pela API.
  • Uma função que permita gerenciar chaves (keys:manage). Os proprietários do espaço de trabalho têm essa permissão por padrão.

1. Crie uma chave de API

No painel, abra Settings → API keys → Create key, dê um nome à chave e escolha os escopos de que ela precisa. O segredo é exibido uma única vez; guarde-o no seu gerenciador de segredos. Depois disso, só o prefixo da chave fica visível.

2. Faça sua primeira requisição

Busque o ranking oficial diário de hoje do Vietnã. Antes, defina ROOMSCOPE_API_KEY no seu ambiente.

curl "https://api.toktokdata.live/v1/rankings/official?board=daily&region=VN&period=current&limit=10" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY" \  -H "Accept: application/json"

3. Leia a resposta

Toda resposta bem-sucedida tem um objeto data e um objeto provenance. A procedência informa quando o sinal foi observado e o quanto a cobertura estava completa; trate-a como parte do resultado, não como metadado.

200 OK
{  "data": {    "board": {      "publishable": true,      "periodKey": "2026-11-01",      "resetAt": "2026-11-02T00:00:00Z",      "coverage": { "completeBoards": 24, "expectedBoards": 24 },      "entries": [        {          "rank": 1,          "creatorUid": "7123456789012345678",          "uniqueId": "room.one",          "nickname": "Room One",          "score": 2410000,          "isLive": true,          "leagueClass": null,          "movement": "same",          "masked": false,          "unmaskTier": null        }      ]    }  },  "provenance": { "coverageStatus": "observed", "observedAt": "2026-11-01T09:58:12Z" }}

Se o ranking ainda não puder ser publicado (publishable: false), a lista de entradas vem vazia e provenance.coverageStatus explica o motivo. Entradas com nomes ocultos (masked: true) trazem em unmaskTier o plano que as revela.

Próximos passos

Esta página foi útil?