Skip to main content

​
📖 Descrição

Retorna informações sobre o estado atual do fluxo WebSocket: se está habilitado, quais handlers estão conectados e quantas entradas existem no cache de preços em tempo real.
Este endpoint só retorna dados significativos quando o serviço foi iniciado com ENABLED_WEBSOCKET=1. Caso contrário, enabled será false e handlers estará vazio.

​
🛠️ Requisição

​
Método

GET

​
URL

/v1/realtime/status

​
Parâmetros

Nenhum.

​
Exemplo de Requisição

curl --location 'localhost:8080/v1/realtime/status'

​
📤 Resposta

​
Exemplo de Resposta — WebSocket habilitado

{
  "enabled": true,
  "handlers": [
    {
      "exchange": "Binance",
      "connected": true,
      "lastUpdate": "2025-03-18T12:00:00Z"
    }
  ],
  "totalConnected": 1,
  "cacheSize": 847
}

​
Exemplo de Resposta — WebSocket desabilitado

{
  "enabled": false,
  "handlers": [],
  "totalConnected": 0,
  "cacheSize": 0
}

​
Campos da Resposta

CampoTipoDescrição
enabledbooleantrue se o fluxo WebSocket foi iniciado
handlersarrayLista com o status de cada handler registrado
handlers[].exchangestringNome da exchange
handlers[].connectedbooleantrue se o WebSocket está conectado no momento
handlers[].lastUpdatestring (ISO 8601)Timestamp do último tick recebido
totalConnectedintegerNúmero de handlers com conexão ativa
cacheSizeintegerTotal de entradas de preços no cache em memória

​
⚠️ Códigos de Status HTTP

CódigoDescrição
200 OKRequisição bem-sucedida
O endpoint sempre retorna 200. Use o campo enabled para determinar se o fluxo WebSocket está ativo, e connected por exchange para verificar saúde individual.