Documentation Index
Fetch the complete documentation index at: https://benzinga-2-mrrancy-patch-1.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
El Kit de desarrollo de software (SDK) TypeScript/JavaScript de Benzinga proporciona una interfaz modular basada en eventos para interactuar con las API de Benzinga. Escrito en TypeScript, el SDK funciona sin problemas tanto en navegadores como en entornos Node.js, ofreciendo implementaciones mejoradas con almacenamiento en caché, comparación profunda y otras capacidades avanzadas.
- Compatibilidad con TypeScript - Tipos e interfaces completos de TypeScript
- Universal - Funciona tanto en el navegador como en entornos Node.js
- Arquitectura modular - Instala solo los módulos que necesitas
- Basado en eventos - Patrones de programación reactiva para datos en tiempo real
- Funcionalidades avanzadas - Caché integrada, comparación profunda y optimizaciones
- Moderno - Sintaxis ES6+ con compatibilidad con async/await
El SDK utiliza una arquitectura modular. Empieza por instalar el módulo principal de sesión:
npm install @benzinga/session
# Ejemplo: Instalar módulos específicos
npm install @benzinga/calendar-data
npm install @benzinga/quotes
npm install @benzinga/news-data
Configuración de la sesión
@benzinga/session sienta las bases para autenticarse con las API de Benzinga. Todos los demás módulos dependen de este objeto de sesión Session.
import { Session } from '@benzinga/session';
// Inicializa la sesión con tu clave de API
const session = new Session({
apiKey: 'YOUR_API_KEY'
});
Opciones de configuración
const session = new Session({
apiKey: 'YOUR_API_KEY',
environment: 'production', // o 'sandbox'
timeout: 30000, // Tiempo de espera de la solicitud en milisegundos
// Opciones de configuración adicionales
});
- Instalar solo lo que necesitas
- Reducir el tamaño del bundle
- Mantener una clara separación de responsabilidades
- Actualizar los módulos de forma independiente
Arquitectura basada en eventos
// Example: Subscribe to data updates
dataManager.subscribe((data) => {
console.log('Nuevos datos recibidos:', data);
});
// Example: Handle events
dataManager.on('update', (event) => {
console.log('Data updated:', event);
});
- Reducir llamadas innecesarias a la API
- Mejorar los tiempos de respuesta
- Optimizar el uso de ancho de banda
- Proporcionar opciones de funcionamiento sin conexión
Las funciones avanzadas de comparación de datos permiten:
- Detectar cambios en objetos anidados
- Gestionar el estado de forma eficiente
- Activar actualizaciones de forma inteligente
- Reducir los renders en aplicaciones de UI
El Kit de desarrollo de software (SDK) está organizado en módulos específicos para distintos dominios de la API:
@benzinga/session - Autenticación y gestión de sesiones (requerido)@benzinga/calendar-data - Eventos de calendario y acciones corporativas@benzinga/news-data - Artículos de noticias e inteligencia de mercado@benzinga/quotes - Cotizaciones en tiempo real y con retraso@benzinga/fundamentals - Fundamentos de la empresa y datos financieros
@benzinga/ratings - Calificaciones y precios objetivo de analistas@benzinga/options - Actividad y análisis de opciones@benzinga/transcripts - Transcripciones de conferencias de resultados@benzinga/logos - Logotipos e identidad de marca de la empresa@benzinga/signals - Señales e indicadores de trading
Compatibilidad con TypeScript
import { Session } from '@benzinga/session';
import { CalendarData, DividendEvent } from '@benzinga/calendar-data';
// TypeScript proporcionará autocompletado y verificación de tipos
const session = new Session({ apiKey: 'YOUR_API_KEY' });
const calendar = new CalendarData(session);
// Llamadas API con seguridad de tipos
const dividends: DividendEvent[] = await calendar.getDividends({
dateFrom: '2024-01-01',
dateTo: '2024-12-31',
ticker: 'AAPL'
});
Obtención básica de datos
import { Session } from '@benzinga/session';
import { NewsData } from '@benzinga/news-data';
const session = new Session({ apiKey: 'YOUR_API_KEY' });
const news = new NewsData(session);
// Obtener las noticias más recientes
const articles = await news.getNews({
pageSize: 10,
displayOutput: 'full'
});
console.log(articles);
Flujos de datos en tiempo real
import { Session } from '@benzinga/session';
import { QuoteStream } from '@benzinga/quotes';
const session = new Session({ apiKey: 'YOUR_API_KEY' });
const quoteStream = new QuoteStream(session);
// Suscribirse a cotizaciones en tiempo real
quoteStream.subscribe(['AAPL', 'MSFT', 'GOOGL'], (quote) => {
console.log('Quote update:', quote);
});
// Cancelar la suscripción al finalizar
quoteStream.unsubscribe(['AAPL']);
import { Session } from '@benzinga/session';
import { CalendarData } from '@benzinga/calendar-data';
const session = new Session({ apiKey: 'YOUR_API_KEY' });
const calendar = new CalendarData(session);
// Obtener ganancias próximas
const earnings = await calendar.getEarnings({
dateFrom: '2024-01-01',
dateTo: '2024-01-31',
importance: 3 // Solo de alta importancia
});
// Obtener dividendos
const dividends = await calendar.getDividends({
ticker: 'AAPL'
});
Fundamentos de la empresa
import { Session } from '@benzinga/session';
import { Fundamentals } from '@benzinga/fundamentals';
const session = new Session({ apiKey: 'YOUR_API_KEY' });
const fundamentals = new Fundamentals(session);
// Obtener el perfil de la empresa
const profile = await fundamentals.getCompanyProfile('AAPL');
// Obtener ratios de valoración
const valuationRatios = await fundamentals.getValuationRatios('AAPL');
// Obtener estados financieros
const financials = await fundamentals.getFinancials('AAPL');
// En tu aplicación de React, Vue o Angular
import { Session } from '@benzinga/session';
import { NewsData } from '@benzinga/news-data';
export function NewsComponent() {
const session = new Session({ apiKey: process.env.BENZINGA_API_KEY });
const news = new NewsData(session);
// Use in your component logic
useEffect(() => {
news.getNews({ pageSize: 5 }).then(articles => {
setNewsData(articles);
});
}, []);
}
import { Session } from '@benzinga/session';
import { NewsData } from '@benzinga/news-data';
const session = new Session({ apiKey: 'YOUR_API_KEY' });
const news = new NewsData(session);
try {
const articles = await news.getNews({ pageSize: 10 });
console.log(articles);
} catch (error) {
if (error.code === 'UNAUTHORIZED') {
console.error('Clave de API no válida');
} else if (error.code === 'RATE_LIMIT') {
console.error('Límite de velocidad excedido');
} else {
console.error('Se produjo un error:', error.message);
}
}
import { Session } from '@benzinga/session';
import { NewsData } from '@benzinga/news-data';
const session = new Session({ apiKey: 'YOUR_API_KEY' });
const news = new NewsData(session);
// Obtener múltiples páginas
let page = 0;
let allArticles = [];
while (page < 5) {
const articles = await news.getNews({
page: page,
pageSize: 100
});
if (articles.length === 0) break;
allArticles = allArticles.concat(articles);
page++;
}
console.log(`Fetched ${allArticles.length} articles`);
import { Session } from '@benzinga/session';
import { CalendarData } from '@benzinga/calendar-data';
const session = new Session({
apiKey: 'YOUR_API_KEY',
cache: {
enabled: true,
ttl: 300000 // Caché durante 5 minutos
}
});
const calendar = new CalendarData(session);
// La primera llamada consulta la API
const earnings1 = await calendar.getEarnings({ ticker: 'AAPL' });
// La segunda llamada usa datos en caché (si está dentro del TTL)
const earnings2 = await calendar.getEarnings({ ticker: 'AAPL' });
1. Reutilizar objetos de sesión
// session.ts
export const globalSession = new Session({ apiKey: process.env.BENZINGA_API_KEY });
// En otros archivos
import { globalSession } from './session';
const news = new NewsData(globalSession);
// archivo .env
BENZINGA_API_KEY=your_api_key_here
// In code
const session = new Session({
apiKey: process.env.BENZINGA_API_KEY
});
import type { NewsArticle, NewsParams } from '@benzinga/news-data';
const params: NewsParams = {
pageSize: 10,
displayOutput: 'full',
ticker: 'AAPL'
};
const articles: NewsArticle[] = await news.getNews(params);
const safeApiCall = async (fn: () => Promise<any>) => {
try {
return await fn();
} catch (error) {
console.error('API Error:', error);
// Registrar en el servicio de rastreo de errores
return null;
}
};
const articles = await safeApiCall(() => news.getNews({ pageSize: 10 }));
@benzinga/session - Autenticación y configuración central@benzinga/calendar-data - API de eventos de calendar@benzinga/news-data - API de noticias y artículos@benzinga/quotes - API de cotizaciones en tiempo real@benzinga/fundamentals - API de fundamentos y datos financieros
Para soporte técnico y para la provisión de claves de API, contacta con Benzinga en cloud.benzinga.com.
El SDK de JavaScript de Benzinga es de código abierto. ¡Las contribuciones son bienvenidas! Visita el repositorio de GitHub para obtener más información.
