> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voxfi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> Visão geral do WebSocket VoxFi

## 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-dev.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;

<Info>
  Saiba mais sobre autenticação e gerenciamento de chaves de API no [guia de Autenticação](/pt/authentication).
</Info>

## Canais Disponíveis

O WebSocket oferece três tipos de canais:

* **[Canal User](/pt/websockets/user-channel)** - Receba atualizações sobre suas próprias ordens e transações;
* **[Canal Market](/pt/websockets/market-channel)** - Receba atualizações sobre mercados específicos (orderbook e trades);
* **[Canal Event](/pt/websockets/event-channel)** - 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](/pt/websockets/connection)** - Como conectar ao WebSocket, ping/pong, canais disponíveis, casos de uso e boas práticas;
* **[Subscribe e Unsubscribe](/pt/websockets/sub-unsub)** - Como se inscrever e cancelar inscrições em canais;
* **[Canal User](/pt/websockets/user-channel)** - Documentação completa do canal de usuário;
* **[Canal Market](/pt/websockets/market-channel)** - Documentação completa do canal de mercado;
* **[Canal Event](/pt/websockets/event-channel)** - Documentação completa do canal de evento;
* **[Erros](/pt/websockets/errors)** - Tratamento de erros e códigos de erro.

## Começando

1. Obtenha sua chave de API em [Perfil → Segurança](https://staging.voxfi.com.br/profile) (necessária apenas para o canal user);
2. Leia a [documentação de conexão](/pt/websockets/connection) para entender como conectar;
3. Aprenda como [se inscrever em canais](/pt/websockets/sub-unsub);
4. Explore a documentação dos canais específicos que você precisa usar;
5. Consulte a [documentação de erros](/pt/websockets/errors) para tratamento adequado de erros.

## Exemplo Rápido

```javascript theme={null}
const ws = new WebSocket('wss://data-ws-dev.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);
};
```