Inicio rápido
La API WebSocket de finlight.me te permite recibir artículos de noticias financieras en tiempo real a medida que se publican. A diferencia de la API REST, que requiere sondeos periódicos para obtener nuevos datos, la API WebSocket te envía los artículos recién publicados en tiempo real, lo que te mantiene actualizado sin hacer solicitudes repetidas.
- Actualizaciones en tiempo real: Una vez conectado, primero recibes el artículo más reciente que coincide con tu consulta. Después, cualquier artículo recién publicado que coincida con tu consulta se te envía automáticamente.
- Transmisión continua: Mantente conectado el tiempo que necesites. Cada plan de precios incluye un número fijo de conexiones WebSocket paralelas que pueden permanecer abiertas durante todo el mes. No hay precios basados en el uso: solo te limita el número de conexiones simultáneas permitidas en tu plan.
- Análisis de sentimiento: Los artículos vienen con datos de sentimiento para ayudarte a evaluar rápidamente el ánimo del mercado.
Regístrate y obtén tu clave de API gratuita
Si aún no lo has hecho, regístrate en el panel de finlight para obtener tu clave de API gratuita. Esta clave se usará para autenticar tu conexión WebSocket, igual que con la API REST.
Elige tu cliente
Para conectarte a la API WebSocket de finlight.me, puedes usar nuestras bibliotecas cliente de Node.js o Python. Estas bibliotecas simplifican la gestión de la conexión, la autenticación y los mecanismos de keep-alive (ping/pong).
# Install the Node.js client library via npm
npm install finlight-client
Conéctate y recibe artículos en tiempo real
Con tu clave de API y el cliente elegido, ya puedes establecer una conexión WebSocket. Al conectarte, recibirás de inmediato el artículo más reciente que coincida con tu consulta, seguido de los nuevos artículos a medida que lleguen. Las bibliotecas cliente gestionan por ti la autenticación y el 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 conexión permanece abierta el tiempo que la necesites, entregando continuamente nuevos artículos que coincidan con tu consulta. Recuerda que tu facturación se basa en la duración de la conexión, así que ten cuidado de desconectarte cuando ya no necesites actualizaciones.
Gestión de los límites de conexión
Cada plan de precios incluye un número fijo de conexiones WebSocket paralelas. Si alcanzas tu límite e intentas abrir otra conexión, puedes habilitar la opción takeover para cerrar automáticamente la conexión más antigua:
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)
},
)
Con takeover: true, si has alcanzado tu límite de conexiones, la nueva conexión reemplazará automáticamente a la conexión existente más antigua. Esto resulta útil durante el desarrollo o al volver a desplegar aplicaciones. En producción, quizá prefieras mantener el valor predeterminado (takeover: false) para conservar el control explícito de tus conexiones.
¿Qué sigue?
Ahora que te has conectado correctamente a la API WebSocket y has recibido artículos en tiempo real, aquí tienes algunos pasos siguientes que pueden resultarte útiles:
- Explora el filtrado por
sourceo consultasextendedpara refinar los artículos que recibes. - Ajusta tus parámetros de
querysegún sea necesario para seguir distintas empresas, índices o temas financieros. - Revisa tu uso y los minutos de conexión en el panel de finlight para mantenerte dentro de los límites del plan gratuito.