Quais os comandos da API Socket?

SQT

Utilizado para solicitar o recebimento das informações sobre um determinado ativo. São informações de LEVEL I. 

– Sintaxe 

sqt <ativo> 

sqt <ativo> N 

Mensagens 

As mensagens recebidas decorrentes da utilização deste comando seguem o seguinte formato: 

– Cabeçalho funcional: “T:<ativo>:<hora>” 

– Corpo da mensagem: Este é composto de um ou mais pares de informação que é enviada da seguinte forma: “:<índice>:<valor>” e finaliza com o caractere “!”. Os índices possuem a seguinte correspondência: 

 

USQ – UNSUBSCRIBE QUOTE

Utilizado para cancelar o recebimento do sinal SQT. 

– Sintaxe 

           usq <ativo> 

– Exemplo 

       > usq petr4 

 

MDC – MARKET DATA CONFLATED

Utilizado para transformar o sinal SQT em Conflated. Uma vez ativado, o SQT será enviado a cada 250ms. O sinal SQT é o mesmo, com os mesmos campos.  

Ideal para quem quer mostrar o sinal em tela, pois reduz drasticamente o consumo de banda e processamento. 

Para ativar, basta enviar o comando abaixo, logo após realizar a conexão com o servidor, e antes de assinar os ativos pelo SQT: 

– Sintaxe 

       mdc 1 

 

BQT – SUBSCRIBE BOOK QUOTE

 Utilizado para solicitar o recebimento do livro de ofertas de um determinado ativo. 

– Sintaxe 

        bqt <ativo> 

– Mensagens 

As mensagens recebidas decorrentes da utilização deste comando seguem o seguinte formato: 

– Cabeçalho funcional: “B:<ativo>” 

– Corpo da mensagem

 

UBQ – UNSUBSCRIBE BOOK QUOTE

Utilizado para cancelar o recebimento do livro de ofertas de um determinado ativo 

– Sintaxe 

         ubq <ativo> 

– Exemplo 

        > ubq petr4 

 

MDC – MARKET DATA CONFLATED

Utilizado para transformar o sinal SQT em Conflated. Uma vez ativado, o SQT será enviado a cada 250ms. O sinal SQT é o mesmo, com os mesmos campos.  

Ideal para quem quer mostrar o sinal em tela, pois reduz drasticamente o consumo de banda e processamento. 

Para ativar, basta enviar o comando abaixo, logo após realizar a conexão com o servidor, e antes de assinar os ativos pelo SQT: 

– Sintaxe 

      mdc 1

 

BQT – SUBSCRIBE BOOK QUOTE

 Utilizado para solicitar o recebimento do livro de ofertas de um determinado ativo. 

– Sintaxe 

             bqt <ativo> 

– Mensagens 

As mensagens recebidas decorrentes da utilização deste comando seguem o seguinte formato: 

– Cabeçalho funcional: “B:<ativo>” 

– Corpo da mensagem

 

UBQ – UNSUBSCRIBE BOOK QUOTE

Utilizado para cancelar o recebimento do livro de ofertas de um determinado ativo 

– Sintaxe 

            ubq <ativo> 

– Exemplo 

          > ubq petr4

 

GPN – GET PLAYER NAMES

Utilizado para requisitar o nome e o código das corretoras em um determinado mercado. Ao final da lista de corretoras é enviada uma mensagem com a letra “E” no lugar do código da corretora. 

– Sintaxe 

          gpn <Nome do Mercado > <Parâmetro Opcional> 

Lista de parâmetros opcionais: 

1 – Retorna as corretoras ordenadas por nome 

Por Padrão – Retorna as corretoras ordenadas pelo código no mercado (ordenação em formato string) 

– Mensagens 

As mensagens recebidas decorrentes da utilização deste comando seguem o seguinte formato. 

– Cabeçalho funcional: “G:<Nome do Mercado>” 

– Corpo da mensagem

 

GNA – GET NEWS AGENCY

Utilizado para recuperar as agências de notícias existentes 

– Sintaxe 

            GNA 

– Mensagens 

As mensagens recebidas decorrentes da utilização deste comando seguem o seguinte formato: 

– Cabeçalho funcional: “GNA” 

 

NEW – NEWS

Utilizado para solicitar o recebimento de notícias. 

– Sintaxe 

– Subscribe:  

           NEM A <agencia> 

– Últimas notícias: 

           NEM L <identificação da requisição> <quantidade> <agencia> 

– Requisição do corpo de uma notícia:  

           NEM N <identificação da requisição> <agencia> <código> 

O título e corpo das notícias são passados em UTF-8. 

– Mensagens 

As mensagens recebidas decorrentes da utilização deste comando seguem o seguinte formato. 

– Cabeçalho funcional: “O:” 

– Corpo da mensagem:

 

UNE – UNSUBSCRIBE NEWS

 

Utilizado para parar o recebimento de notícias. 

– Sintaxe 

          UNE <agencia> 

– Significado dos Campos: 

 

SAB – SUBSCRIBE AGGREGATED BOOK

Utilizado para solicitar o recebimento do livro de ofertas agregado (por preço) de um determinado ativo. 

– Sintaxe 

         sab <ativo> [N] 

– Mensagens 

As mensagens recebidas decorrentes da utilização deste comando seguem o seguinte formato. 

        – Cabeçalho funcional: “Z:<ativo>” 

        – Corpo da mensagem 

 

UAB – UNSUBSCRIBE AGGREGATED BOOK

Utilizado para parar o recebimento do livro de ofertas agregado de um determinado ativo. 

– Sintaxe 

       uab <ativo>

 

GQT – GET QUOTE TRADE

Utilizado para solicitar o recebimento dos negócios realizados (Times & Trades) no dia para um determinado ativo. 

– Sintaxe 

– Subscribe 

           GQT <ativo> S [<quantidade negócios>] [<identificador do negócio>] 

 

Obs: para solicitar por <identificador do negócio> deve-se especificar a <quantidade negócios> 

– Snapshot 

            GQT <ativo> N <quantidade negócios> <offset> <identificador requisição> 

– Mensagens 

As mensagens recebidas decorrentes da utilização deste comando seguem o seguinte formato. 

– Cabeçalho funcional: “V:<ativo>” 

– Corpo da mensagem

 

UQT – UNSUBSCRIBE QUOTE TRADE

Utilizado para cancelar o recebimento dos negócios realizados no dia para um determinado ativo. 

– Sintaxe 

           uqt <Símbolo do ativo> 

– Exemplo 

uqt PETR4

 

VAP – VOLUME AT PRICE

Utilizado para apontamento de volume negociado por um ativo em determinado valor.  

Atenção: este comando só retorna o snapshot no momento da solicitação. O usuário deverá assinar o GQT caso deseje manter os dados atualizados.

– Sintaxe 

         vap <ativo> [<período>]

– Exemplo 

       > vap petr4

 

GTC – GET TIME CRYSTAL

Utilizado para solicitar o horário corrente do servidor. 

– Sintaxe 

         GTC 

– Mensagens 

As mensagens recebidas decorrentes da utilização deste comando seguem o seguinte formato. 

– Corpo da mensagem: “GTC:<data><hora>” 

– Exemplo 

        > GTC 

        GTC:20170308145946 

 

QUIT

Utilizado para encerrar a conexão com o sistema. 

– Sintaxe 

         > quit 

 

Artigos relacionados