Início rápido

A API WebSocket do finlight.me permite que você receba artigos de notícias financeiras em tempo real à medida que são publicados. Diferentemente da API REST, que exige sondagens periódicas para obter novos dados, a API WebSocket envia a você os artigos recém-publicados em tempo real, mantendo você atualizado sem fazer requisições repetidas.

• Atualizações em tempo real: Após conectar, você recebe primeiro o artigo mais recente que corresponde à sua consulta. Depois disso, qualquer artigo recém-publicado que corresponda à sua consulta é enviado automaticamente.
• Streaming contínuo: Permaneça conectado o tempo que precisar. Cada nível de preço inclui um número fixo de conexões WebSocket paralelas que podem permanecer abertas durante todo o mês. Não há cobrança por uso — você é limitado apenas pelo número de conexões simultâneas permitidas no seu nível.
• Análise de sentimento: Os artigos vêm com dados de sentimento para ajudar você a avaliar rapidamente o humor do mercado.

Cadastre-se e obtenha sua chave de API gratuita

Se ainda não fez isso, cadastre-se no painel do finlight para obter sua chave de API gratuita. Esta chave será usada para autenticar sua conexão WebSocket, assim como na API REST.

Escolha seu cliente

Para se conectar à API WebSocket do finlight.me, você pode usar nossas bibliotecas cliente de Node.js ou Python. Essas bibliotecas simplificam o gerenciamento da conexão, a autenticação e os mecanismos de keep-alive (ping/pong).

# Install the Node.js client library via npm
npm install finlight-client

Conecte-se e receba artigos em tempo real

Com sua chave de API e o cliente escolhido, agora você pode estabelecer uma conexão WebSocket. Ao conectar, você receberá imediatamente o artigo mais recente que corresponde à sua consulta, seguido de novos artigos à medida que chegam. As bibliotecas cliente gerenciam para você a autenticação e o mecanismo de keep-alive ping/pong.

import { FinlightApi } from 'finlight-client'

const client = new FinlightApi({
  apiKey: 'YOUR_API_KEY',
})

client.websocket.connect(
  { query: 'nvidia', language: 'en' },
  (article) => {
    console.log('New article received:', article)
  },
)

Esta conexão permanece aberta o tempo que você precisar, entregando continuamente novos artigos que correspondem à sua consulta. Lembre-se de que sua cobrança é baseada na duração da conexão, portanto, tenha o cuidado de desconectar quando não precisar mais de atualizações.

Gerenciando os limites de conexão

Cada nível de preço inclui um número fixo de conexões WebSocket paralelas. Se você atingir seu limite e tentar abrir outra conexão, pode habilitar a opção takeover para fechar automaticamente a conexão mais antiga:

import { FinlightApi } from 'finlight-client'

const client = new FinlightApi(
  {
    apiKey: 'YOUR_API_KEY',
  },
  {
    // WebSocket-specific options
    takeover: true, // Automatically close oldest connection when limit is reached (default: false)
  },
)

client.websocket.connect(
  { query: 'nvidia', language: 'en' },
  (article) => {
    console.log('New article received:', article)
  },
)

Com takeover: true, se você tiver atingido seu limite de conexões, a nova conexão substituirá automaticamente a conexão existente mais antiga. Isso é útil durante o desenvolvimento ou ao reimplantar aplicações. Em produção, talvez você prefira manter o padrão (takeover: false) para manter o controle explícito das suas conexões.

O que vem a seguir?

Agora que você se conectou com sucesso à API WebSocket e recebeu artigos em tempo real, aqui estão alguns próximos passos que podem ser úteis:

• Explore a filtragem por source ou consultas extended para refinar os artigos que recebe.
• Ajuste seus parâmetros de query conforme necessário para acompanhar diferentes empresas, índices ou temas financeiros.
• Revise seu uso e os minutos de conexão no painel do finlight para se manter dentro dos limites do nível gratuito.