Pular para o conteúdo principal

Subscribe

Inscreve-se em um canal para receber atualizações em tempo real.

Estrutura da Mensagem

Campos

  • type (obrigatório): Deve ser "subscribe";
  • channel (obrigatório): Tipo de canal ("user", "market" ou "event");
  • auth (obrigatório apenas para channel: "user"): Chave de API (X-Api-Key) do usuário;
  • markets (obrigatório para channel: "market"): Array de IDs de mercado;
  • events (obrigatório para channel: "event"): Array de IDs de evento;
  • filter (opcional para channel: "market" e channel: "event"): Tipo de atualização desejada
    • "" ou "all": Todas as atualizações (padrão)
    • "orderbook": Apenas atualizações de orderbook
    • "trades": Apenas atualizações de trades

Exemplos

Subscribe no Canal User

Subscribe no Canal Market

Subscribe no Canal Event

Múltiplas Inscrições

Você pode se inscrever em múltiplos canais e múltiplos recursos na mesma conexão WebSocket:

Unsubscribe

Cancela a inscrição de um canal para parar de receber atualizações.

Estrutura da Mensagem

Campos

  • type (obrigatório): Deve ser "unsubscribe";
  • channel (obrigatório): Tipo de canal ("user", "market" ou "event");
  • markets (obrigatório para channel: "market"): Array de IDs de mercado para cancelar inscrição;
  • events (obrigatório para channel: "event"): Array de IDs de evento para cancelar inscrição.

Exemplos

Unsubscribe do Canal User

Unsubscribe de Mercados Específicos

Unsubscribe de Eventos Específicos

Exemplo Completo

Notas Importantes

  • Inscrições Persistem: Uma vez inscrito, você continuará recebendo atualizações até cancelar a inscrição ou desconectar;
  • Múltiplas Inscrições no Mesmo Recurso: Você pode se inscrever no mesmo mercado/evento múltiplas vezes sem problemas;
  • Cancelamento Parcial: Para canais market e event, você pode cancelar a inscrição de recursos específicos sem afetar outros;
  • Reconexão: Em caso de reconexão, você precisará se inscrever novamente em todos os canais desejados.