Endpoints

En esta página profundizaremos en los diferentes endpoints que puedes usar para recuperar artículos de noticias financieras de forma programática. Veremos cómo consultar artículos usando la API de finlight.me.

Modelo de artículo

El modelo de artículo de la respuesta contiene toda la información sobre un artículo, como el enlace, el título, la fecha de publicación y la fuente. También incluye un sentimiento y su nivel de confianza al respecto.

Name
link
Type
string
Description
URL del artículo completo.
Name
source
Type
string
Description
Sitio web de la fuente. Por ejemplo, www.reuters.com
Name
title
Type
string
Description
Título del artículo.
Name
summary
Type
string
Description
Resumen del artículo si existe. Puede ser nulo.
Name
publishDate
Type
Date
Description
Fecha de publicación como fecha ISO.
Name
createdAt
Type
Date
Description
Fecha en que el artículo fue indexado por primera vez por el sistema de finlight, como cadena de fecha ISO 8601.
Name
revisedDate
Type
Date | null
Description
Fecha de la última revisión del artículo después de su publicación inicial, como cadena de fecha ISO 8601. null cuando el artículo nunca ha sido revisado. Se devuelve cuando se usa orderBy=revisedDate o cuando includeUpdates está habilitado mediante WebSocket/Webhook.
Name
isUpdate
Type
boolean
Description
true cuando esta carga útil del artículo es una reentrega activada por una revisión posterior a la publicación. Solo está presente cuando includeUpdates está habilitado en una suscripción de WebSocket o Webhook.
Name
language
Type
string
Description
Código de idioma en ISO 639-1. Por ejemplo, en | de | fr
Name
sentiment
Type
string
Description
Resultado del análisis de sentimiento. Los valores pueden ser positive | neutral |negative
Name
confidence
Type
number
Description
Nivel de confianza del análisis de sentimiento de 0 a 1.
Name
images
Type
string[]
Description
Matriz de URLs de imágenes del artículo.
Name
countries
Type
string[]
Description
Matriz de códigos de país en formato ISO 3166-1 alpha-2 que representan los países relacionados con el artículo. Por ejemplo, ["US", "GB", "DE"]. Puede estar vacía.
Name
categories
Type
string[]
Description
Matriz de categorías del artículo. Valores posibles: markets | economy | business | politics | geopolitics | regulation | technology | energy | commodities | crypto | health | climate | security. Puede estar vacía.
Name
companies
Type
Company[]
Description
Matriz de empresas mencionadas en el artículo. Solo se muestra/está disponible con un nivel de suscripción específico. Puede ser nulo.

Modelo de empresa

El modelo de empresa de la respuesta contiene información sobre una empresa mencionada en un artículo. Incluye detalles como el nombre de la empresa, el símbolo bursátil, el sector y más.

Name
companyId
Type
number
Description
Identificador único de la empresa.
Name
confidence
Type
string
Description
Nivel de confianza de la identificación de la empresa de 0 a 1.
Name
country
Type
string
Description
País donde tiene su sede la empresa, en formato ISO 3166-1 alpha-2. Por ejemplo, US | DE | GB
Name
exchange
Type
string
Description
Bolsa de valores en la que cotiza la empresa.
Name
industry
Type
Date
Description
Sector industrial de la empresa. Por ejemplo, Biotechnology, Technology
Name
name
Type
string
Description
Nombre completo de la empresa. Por ejemplo, Apple Inc.
Name
sector
Type
string
Description
Sector de la empresa. Por ejemplo, Technology | Health Care
Name
ticker
Type
string
Description
Símbolo bursátil de la empresa. Por ejemplo, AAPL | GOOGL
Name
isin
Type
string
Description
Número Internacional de Identificación de Valores (ISIN) de la empresa. Por ejemplo, US0378331005
Name
openfigi
Type
string
Description
Identificador OpenFIGI de la empresa. Por ejemplo, BBG000B9XRY4
Name
primaryListing
Type
object
Description
Información de cotización en la bolsa principal de la empresa.
Name
primaryListing.ticker
Type
string
Description
Símbolo bursátil principal en la bolsa principal.
Name
primaryListing.exchangeCode
Type
string
Description
Código de la bolsa principal en la que cotiza el valor.
Name
primaryListing.exchangeCountry
Type
string
Description
País de la bolsa principal en la que cotiza el valor.
Name
isins
Type
string[]
Description
Matriz de Números Internacionales de Identificación de Valores (ISIN) de la empresa.
Name
otherListings
Type
object[]
Description
Matriz de otras cotizaciones bursátiles de la empresa.
Name
otherListings[].ticker
Type
string
Description
Símbolo bursátil en la bolsa alternativa.
Name
otherListings[].exchangeCode
Type
string
Description
Código de la bolsa alternativa en la que cotiza el valor.
Name
otherListings[].exchangeCountry
Type
string
Description
País de la bolsa alternativa en la que cotiza el valor.

POST/v2/articles

Recuperar artículos

Recupera información de artículos, incluyendo análisis detallado, empresas y más. Ten en cuenta que algunos campos requieren un nivel de suscripción específico para acceder a ellos.

Parámetros de BODY opcionales

Como este endpoint usa una solicitud POST, puedes pasar parámetros en el cuerpo de la solicitud. Esto permite consultas y opciones de filtrado más complejas.

Name
query
Type
string
Description
Consulta de búsqueda para encontrar artículos relevantes con filtros simples o avanzados. Consultas avanzadas
Name
sources
Type
string[]
Description
Filtro simple para una o varias fuentes (matriz de cadenas). Consulta el endpoint "Obtener todas las fuentes" para ver los valores válidos. Admite el comodín "*" para incluir todas las fuentes.
Name
excludeSources[]
Type
string[]
Description
Excluye una o varias fuentes (matriz de cadenas). Consulta el endpoint "Obtener todas las fuentes" para ver los valores válidos.
Name
tickers
Type
string[]
Description
Filtra por símbolos bursátiles (matriz de cadenas). Esto devolverá artículos que mencionen estos símbolos. Admite el comodín "*" para incluir todos los símbolos.
Name
countries
Type
string[]
Description
Filtra por país de la empresa usando códigos de país ISO 3166-1 alpha-2 (matriz de cadenas). Por ejemplo, ["US", "GB", "DE"]
Name
includeEntities
Type
boolean
Description
Incluye las empresas mencionadas en el artículo. Requiere un nivel de suscripción específico.
Name
from
Type
string
Description
Fecha de inicio en formato YYYY-MM-DD o cadena de fecha ISO.
Name
to
Type
string
Description
Fecha de fin en formato YYYY-MM-DD o cadena de fecha ISO.
Name
language
Type
string
Description
Filtra por idioma (ISO 639-1). Su valor predeterminado es en, que devuelve solo inglés y excluye otros idiomas — consulta Idioma y cobertura.
Name
orderBy
Type
string
Description
Ordenar por ("publishDate", "createdAt" o "revisedDate") - predeterminado "publishDate". publishDate es la fecha de publicación del artículo según la fuente. createdAt es cuando el artículo fue indexado por primera vez por finlight. revisedDate ordena por la fecha de revisión más reciente (los artículos que nunca se han revisado aparecen al final). Ten en cuenta que algunas fuentes publican artículos con fechas de publicación pasadas.
Name
order
Type
string
Description
Orden de clasificación ("ASC" o "DESC") - predeterminado "DESC".
Name
pageSize
Type
number
Description
Número de resultados por página (1-100).
Name
page
Type
number
Description
Número de página.

Request

GET

/v2/articles

curl -X POST 'https://api.finlight.me/v2/articles' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{ "query": "Nvidia", "countries": ["US", "GB"] }'

Response

{
  "status": "ok",
  "page": 1,
  "pageSize": 20,
  "articles": [
    {
      "link": "https://www.example.com/article1",
      "source": "www.example.com",
      "title": "Stock Market Hits New Highs",
      "summary": "A brief summary of the article...",
      "publishDate": "2023-10-01T12:34:56Z",
      "language": "en",
      "sentiment": "positive",
      "confidence": 0.95,
      "images": [
                  "https://www.example.com/image1.jpg",
                  "https://www.example.com/image2.jpg"
                ],
      "countries": ["US"],
      "categories": ["markets", "technology"],
      "companies": [
                {
                    "companyId": 41494,
                    "confidence": "0.9335401058197021",
                    "country": "US",
                    "exchange": "XNAS",
                    "industry": "Biotechnology: Pharmaceutical Preparations",
                    "name": "Summit Therapeutics Inc. Common Stock",
                    "sector": "Health Care",
                    "ticker": "SMMT",
                    "isin": "US86627T1088",
                    "openfigi": "BBG01PH11VP5",
                    "primaryListing": {
                        "ticker": "SMMT",
                        "exchangeCode": "XNAS",
                        "exchangeCountry": "US"
                    },
                    "isins": ["US86627T1088", "US86627T2088"],
                    "otherListings": [
                        {
                            "ticker": "SMMT.L",
                            "exchangeCode": "XLON",
                            "exchangeCountry": "GB"
                        }
                    ]
                },
                ...
              ]
    },
    // ...
  ]
}

GET/v2/articles/by-link

Recuperar artículo por enlace

Recupera un solo artículo por su URL. Devuelve los datos completos del artículo con análisis de sentimiento y, opcionalmente, incluye el contenido y las entidades de empresa.

Parámetros de consulta obligatorios

Name
link
Type
string
Description
La URL del artículo que se desea recuperar.

Parámetros de consulta opcionales

Name
includeContent
Type
boolean
Description
Incluye el contenido completo del artículo en la respuesta.
Name
includeEntities
Type
boolean
Description
Incluye las empresas mencionadas en el artículo. Requiere un nivel de suscripción específico.

Request

GET

/v2/articles/by-link

curl -X GET 'https://api.finlight.me/v2/articles/by-link?link=https%3A%2F%2Fwww.somepage.com%2Ftechnology%2Fexample-article&includeContent=true&includeEntities=true' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Response

{
  "status": "ok",
  "article": {
      "link": "https://www.somepage.com/technology/example-article",
      "source": "www.reuters.com",
      "title": "Nvidia Announces New GPU Architecture",
      "summary": "A brief summary of the article...",
      "publishDate": "2023-10-01T12:34:56Z",
      "createdAt": "2023-10-01T12:35:10Z",
      "language": "en",
      "sentiment": "positive",
      "confidence": 0.95,
      "content": "Full article content here...",
      "images": [
                  "https://www.example.com/image1.jpg"
                ],
      "countries": ["US"],
      "categories": ["technology"],
      "companies": [
                {
                    "companyId": 4157,
                    "confidence": "0.97",
                    "country": "US",
                    "exchange": "XNAS",
                    "industry": "Semiconductors",
                    "name": "NVIDIA Corporation",
                    "sector": "Technology",
                    "ticker": "NVDA",
                    "isin": "US67066G1040",
                    "openfigi": "BBG000BBJQV0"
                }
              ]
  }
}

GET/v2/sources

Obtener todas las fuentes

Recupera una lista de todas las fuentes de artículos actualmente admitidas.

Nota: Las fuentes se extraen con el mejor esfuerzo posible y pueden cambiar en el futuro.

Respuesta

Una matriz JSON de objetos de fuente. Ejemplo:

Name
array
Type
Source[]
Description
Matriz de fuentes de noticias.

Modelo de fuente

El modelo de fuente de la respuesta contiene información sobre una fuente de noticias, incluyendo su dominio y si es una fuente predeterminada.

Name
domain
Type
string
Description
Dominio del sitio web de la fuente.
Name
isDefaultSource
Type
boolean
Description
Indica si esta fuente es una fuente predeterminada para la API.

Request

GET

/v2/sources

curl -X GET 'https://api.finlight.me/v2/sources' \
  -H 'X-API-KEY: YOUR_API_KEY'

Response

[
  {
    "domain": "www.yahoo.com",
    "isDefaultSource": true
  },
  {
    "domain": "seekingalpha.com",
    "isDefaultSource": true
  },
  // ...
]