Pular para o conteúdo principal

​
O que é o WebSocket?

O WebSocket da VoxFi permite receber atualizações em tempo real sobre ordens, orderbooks e trades sem precisar fazer polling constante. É a forma recomendada de monitorar mudanças no mercado e nas suas ordens.

​
Por que usar WebSocket?

  • Tempo Real: Receba atualizações instantaneamente quando ocorrem mudanças;
  • Eficiência: Evite polling constante e reduza o número de requisições HTTP;
  • Baixa Latência: Comunicação bidirecional com latência mínima;
  • Economia de Recursos: Menos carga no servidor e no cliente.

​
URL do WebSocket

Todas as conexões WebSocket devem ser feitas para: 
wss://data-ws.voxfi.com.br

​
Autenticação

A conexão WebSocket não requer autenticação inicial, mas alguns canais requerem autenticação ao se inscrever:
  • Canais Market e Event: Não requerem autenticação.
  • Canal User: Requer chave de API (X-Api-Key) no campo auth da mensagem de subscribe;
Saiba mais sobre autenticação e gerenciamento de chaves de API no guia de Autenticação.

​
Canais Disponíveis

O WebSocket oferece três tipos de canais:
  • Canal User - Receba atualizações sobre suas próprias ordens e transações;
  • Canal Market - Receba atualizações sobre mercados específicos (orderbook e trades);
  • Canal Event - Receba atualizações sobre eventos específicos (inclui todos os mercados do evento).

​
Tipos de Atualizações

Você pode filtrar o tipo de atualização que deseja receber:
  • Orderbook: Atualizações de preços e profundidade do mercado;
  • Trades: Notificações de novas trades executadas;
  • All: Todas as atualizações (padrão).

​
Documentação

  • Conexão - Como conectar ao WebSocket, ping/pong, canais disponíveis, casos de uso e boas práticas;
  • Subscribe e Unsubscribe - Como se inscrever e cancelar inscrições em canais;
  • Canal User - Documentação completa do canal de usuário;
  • Canal Market - Documentação completa do canal de mercado;
  • Canal Event - Documentação completa do canal de evento;
  • Erros - Tratamento de erros e códigos de erro.

​
Começando

  1. Obtenha sua chave de API em Perfil → Segurança (necessária apenas para o canal user);
  2. Leia a documentação de conexão para entender como conectar;
  3. Aprenda como se inscrever em canais;
  4. Explore a documentação dos canais específicos que você precisa usar;
  5. Consulte a documentação de erros para tratamento adequado de erros.

​
Exemplo Rápido

const ws = new WebSocket('wss://data-ws.voxfi.com.br');

ws.onopen = () => {
  // Inscrever-se em um mercado
  ws.send(JSON.stringify({
    type: 'subscribe',
    channel: 'market',
    markets: ['market-id-1'],
    filter: 'orderbook'
  }));
};

ws.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Atualização recebida:', data);
};