Endpoints

Nesta página, vamos nos aprofundar nos diferentes endpoints que você pode usar para recuperar artigos de notícias financeiras de forma programática. Veremos como consultar artigos usando a API do finlight.me.

Modelo de artigo

O modelo de artigo da resposta contém todas as informações sobre um artigo, como o link, o título, a data de publicação e a fonte. Também contém um sentimento e seu nível de confiança a respeito.

Name
link
Type
string
Description
URL do artigo completo.
Name
source
Type
string
Description
Site da fonte. Por exemplo, www.reuters.com
Name
title
Type
string
Description
Título do artigo.
Name
summary
Type
string
Description
Resumo do artigo, se existir. Pode ser nulo.
Name
publishDate
Type
Date
Description
Data de publicação como data ISO.
Name
createdAt
Type
Date
Description
Data em que o artigo foi indexado pela primeira vez pelo sistema do finlight, como string de data ISO 8601.
Name
revisedDate
Type
Date | null
Description
Data da última revisão do artigo após a publicação inicial, como string de data ISO 8601. null quando o artigo nunca foi revisado. Retornado quando orderBy=revisedDate é usado ou includeUpdates está habilitado via WebSocket/Webhook.
Name
isUpdate
Type
boolean
Description
true quando esta carga útil do artigo é uma reentrega acionada por uma revisão pós-publicação. Presente apenas quando includeUpdates está habilitado em uma assinatura de WebSocket ou Webhook.
Name
language
Type
string
Description
Código de idioma em ISO 639-1. Por exemplo, en | de | fr
Name
sentiment
Type
string
Description
Resultado da análise de sentimento. Os valores podem ser positive | neutral |negative
Name
confidence
Type
number
Description
Nível de confiança da análise de sentimento de 0 a 1.
Name
images
Type
string[]
Description
Matriz de URLs de imagens do artigo.
Name
countries
Type
string[]
Description
Matriz de códigos de país no formato ISO 3166-1 alpha-2 representando os países relacionados ao artigo. Por exemplo, ["US", "GB", "DE"]. Pode estar vazia.
Name
categories
Type
string[]
Description
Matriz de categorias do artigo. Valores possíveis: markets | economy | business | politics | geopolitics | regulation | technology | energy | commodities | crypto | health | climate | security. Pode estar vazia.
Name
companies
Type
Company[]
Description
Matriz de empresas mencionadas no artigo. Só é exibida/disponível com um nível de assinatura específico. Pode ser nulo.

Modelo de empresa

O modelo de empresa da resposta contém informações sobre uma empresa mencionada em um artigo. Inclui detalhes como o nome da empresa, o símbolo de cotação, o setor e mais.

Name
companyId
Type
number
Description
Identificador único da empresa.
Name
confidence
Type
string
Description
Nível de confiança da identificação da empresa de 0 a 1.
Name
country
Type
string
Description
País onde a empresa está sediada, no formato ISO 3166-1 alpha-2. Por exemplo, US | DE | GB
Name
exchange
Type
string
Description
Bolsa de valores em que a empresa está listada.
Name
industry
Type
Date
Description
Setor industrial da empresa. Por exemplo, Biotechnology, Technology
Name
name
Type
string
Description
Nome completo da empresa. Por exemplo, Apple Inc.
Name
sector
Type
string
Description
Setor da empresa. Por exemplo, Technology | Health Care
Name
ticker
Type
string
Description
Símbolo de cotação da empresa. Por exemplo, AAPL | GOOGL
Name
isin
Type
string
Description
Número Internacional de Identificação de Valores Mobiliários (ISIN) da empresa. Por exemplo, US0378331005
Name
openfigi
Type
string
Description
Identificador OpenFIGI da empresa. Por exemplo, BBG000B9XRY4
Name
primaryListing
Type
object
Description
Informações de listagem na bolsa principal da empresa.
Name
primaryListing.ticker
Type
string
Description
Símbolo de cotação principal na bolsa principal.
Name
primaryListing.exchangeCode
Type
string
Description
Código da bolsa principal em que o valor mobiliário está listado.
Name
primaryListing.exchangeCountry
Type
string
Description
País da bolsa principal em que o valor mobiliário está listado.
Name
isins
Type
string[]
Description
Matriz de Números Internacionais de Identificação de Valores Mobiliários (ISINs) da empresa.
Name
otherListings
Type
object[]
Description
Matriz de outras listagens em bolsa da empresa.
Name
otherListings[].ticker
Type
string
Description
Símbolo de cotação na bolsa alternativa.
Name
otherListings[].exchangeCode
Type
string
Description
Código da bolsa alternativa em que o valor mobiliário está listado.
Name
otherListings[].exchangeCountry
Type
string
Description
País da bolsa alternativa em que o valor mobiliário está listado.

POST/v2/articles

Recuperar artigos

Recupere informações de artigos, incluindo análise detalhada, empresas e mais. Observe que alguns campos exigem um nível de assinatura específico para acesso.

Parâmetros opcionais do BODY

Como este endpoint usa uma requisição POST, você pode passar parâmetros no corpo da requisição. Isso permite consultas e opções de filtragem mais complexas.

Name
query
Type
string
Description
Consulta de busca para encontrar artigos relevantes com filtros simples ou avançados. Consultas avançadas
Name
sources
Type
string[]
Description
Filtro simples para uma ou várias fontes (matriz de strings). Consulte o endpoint "Obter todas as fontes" para ver os valores válidos. Suporta o curinga "*" para incluir todas as fontes.
Name
excludeSources[]
Type
string[]
Description
Exclui uma ou várias fontes (matriz de strings). Consulte o endpoint "Obter todas as fontes" para ver os valores válidos.
Name
tickers
Type
string[]
Description
Filtra por símbolos de cotação (matriz de strings). Isso retornará artigos que mencionam esses símbolos. Suporta o curinga "*" para incluir todos os símbolos.
Name
countries
Type
string[]
Description
Filtra por país da empresa usando códigos de país ISO 3166-1 alpha-2 (matriz de strings). Por exemplo, ["US", "GB", "DE"]
Name
includeEntities
Type
boolean
Description
Inclui as empresas mencionadas no artigo. Requer um nível de assinatura específico.
Name
from
Type
string
Description
Data de início no formato YYYY-MM-DD ou string de data ISO.
Name
to
Type
string
Description
Data de término no formato YYYY-MM-DD ou string de data ISO.
Name
language
Type
string
Description
Filtra por idioma (ISO 639-1). O padrão é en, que retorna apenas inglês e exclui outros idiomas — consulte Idioma e cobertura.
Name
orderBy
Type
string
Description
Ordenar por ("publishDate", "createdAt" ou "revisedDate") - padrão "publishDate". publishDate é a data de publicação do artigo segundo a fonte. createdAt é quando o artigo foi indexado pela primeira vez pelo finlight. revisedDate ordena pela data de revisão mais recente (artigos nunca revisados aparecem por último). Tenha em mente que algumas fontes publicam artigos com datas de publicação passadas.
Name
order
Type
string
Description
Ordem de classificação ("ASC" ou "DESC") - padrão "DESC".
Name
pageSize
Type
number
Description
Número de resultados por página (1-100).
Name
page
Type
number
Description
Número da 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 artigo por link

Recupere um único artigo pela sua URL. Retorna os dados completos do artigo com análise de sentimento e, opcionalmente, inclui o conteúdo e as entidades de empresa.

Parâmetros de consulta obrigatórios

Name
link
Type
string
Description
A URL do artigo a ser recuperado.

Parâmetros de consulta opcionais

Name
includeContent
Type
boolean
Description
Inclui o conteúdo completo do artigo na resposta.
Name
includeEntities
Type
boolean
Description
Inclui as empresas mencionadas no artigo. Requer um nível de assinatura 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

Obter todas as fontes

Recupere uma lista de todas as fontes de artigos atualmente suportadas.

Nota: As fontes são extraídas com base no melhor esforço e podem mudar no futuro.

Resposta

Uma matriz JSON de objetos de fonte. Exemplo:

Name
array
Type
Source[]
Description
Matriz de fontes de notícias.

Modelo de fonte

O modelo de fonte da resposta contém informações sobre uma fonte de notícias, incluindo seu domínio e se é uma fonte padrão.

Name
domain
Type
string
Description
Domínio do site da fonte.
Name
isDefaultSource
Type
boolean
Description
Indica se esta fonte é uma fonte padrão para a 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
  },
  // ...
]