Get Realtime Status

📖 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

Campo	Tipo	Descrição
`enabled`	boolean	`true` se o fluxo WebSocket foi iniciado
`handlers`	array	Lista com o status de cada handler registrado
`handlers[].exchange`	string	Nome da exchange
`handlers[].connected`	boolean	`true` se o WebSocket está conectado no momento
`handlers[].lastUpdate`	string (ISO 8601)	Timestamp do último tick recebido
`totalConnected`	integer	Número de handlers com conexão ativa
`cacheSize`	integer	Total de entradas de preços no cache em memória

⚠️ Códigos de Status HTTP

Código	Descrição
`200 OK`	Requisiçã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.

API Documentation

Endpoint Examples

📖 Descrição

🛠️ Requisição

Método

URL

Parâmetros

Exemplo de Requisição

📤 Resposta

Exemplo de Resposta — WebSocket habilitado

Exemplo de Resposta — WebSocket desabilitado

Campos da Resposta

⚠️ Códigos de Status HTTP

​📖 Descrição

​🛠️ Requisição

​Método

​URL

​Parâmetros

​Exemplo de Requisição

​📤 Resposta

​Exemplo de Resposta — WebSocket habilitado

​Exemplo de Resposta — WebSocket desabilitado

​Campos da Resposta

​⚠️ Códigos de Status HTTP

📖 Descrição

🛠️ Requisição

Método

URL

Parâmetros

Exemplo de Requisição

📤 Resposta

Exemplo de Resposta — WebSocket habilitado

Exemplo de Resposta — WebSocket desabilitado

Campos da Resposta

⚠️ Códigos de Status HTTP