Endpoints

On this page, we'll dive into the different endpoints you can use to retrieve financial news articles programmatically. We'll look at how to query articles using the Finlight.me API.

Article model

The response article model contains all the information about an article, such as the link, title, publish date and source. It also contains a sentiment and its confidence about that.

  • Name
    link
    Type
    string
    Description

    URL to the full article.

  • Name
    source
    Type
    string
    Description

    Source website. E.g. www.reuters.com

  • Name
    title
    Type
    string
    Description

    Title of the article.

  • Name
    summary
    Type
    string
    Description

    Summary of the article if existing. Can be nullable.

  • Name
    publishDate
    Type
    Date
    Description

    Publication date as ISO date.

  • Name
    language
    Type
    string
    Description

    Language code in ISO 639-1. E.g. en | de | fr

  • Name
    sentiment
    Type
    string
    Description

    Sentiment analysis result. Values can be positive | neutral |negative

  • Name
    confidence
    Type
    number
    Description

    Confidence level of sentiment analysis from 0 to 1.

  • Name
    images
    Type
    string[]
    Description

    Array of image URLs from the article.

  • Name
    content
    Type
    string
    Description

    Full content of the article. Is only shown/available with specific subscription tier. Can be nullable.

  • Name
    companies
    Type
    Company[]
    Description

    Array of companies that are mentioned in the article. Is only shown/available with specific subscription tier. Can be nullable.

Company model

The response company model contains information about a company that is mentioned in an article. It includes details like the company name, ticker symbol, industry, and more.

  • Name
    companyId
    Type
    number
    Description

    Unique identifier for the company.

  • Name
    confidence
    Type
    string
    Description

    Confidence level of the company identification from 0 to 1.

  • Name
    country
    Type
    string
    Description

    Country where the company is based. E.g. United States | Germany

  • Name
    exchange
    Type
    string
    Description

    Stock exchange where the company is listed.

  • Name
    industry
    Type
    Date
    Description

    Industry sector of the company. E.g. Biotechnology, Technology

  • Name
    name
    Type
    string
    Description

    Full name of the company. E.g. Apple Inc.

  • Name
    sector
    Type
    string
    Description

    Sector of the company. E.g. Technology | Health Care

  • Name
    ticker
    Type
    string
    Description

    Stock ticker symbol of the company. E.g. AAPL | GOOGL

  • Name
    isin
    Type
    string
    Description

    International Securities Identification Number (ISIN) of the company. E.g. US0378331005

  • Name
    openfigi
    Type
    string
    Description

    OpenFIGI identifier for the company. E.g. BBG000B9XRY4

POST/v2/articles

Fetch articles

Retrieve article information, including content, detailed analysis, companies and more. Please note that some fields require a specific subscription tier to access, such as the full content of the article.

Optional BODY parameters

Because this endpoint uses a POST request, you can pass parameters in the body of the request. This allows for more complex queries and filtering options.

  • Name
    query
    Type
    string
    Description

    Search query to find relevant articles with simple or advanced filters. Advanced queries

  • Name
    sources
    Type
    string[]
    Description

    Simple filter for single or multiple sources (String Array). See "Get all sources" endpoint for valid values.

  • Name
    excludeSources[]
    Type
    string[]
    Description

    Excludes single or multiple sources (String Array). See "Get all sources" endpoint for valid values.

  • Name
    tickers
    Type
    string[]
    Description

    Filter by stock ticker symbols (String Array). This will return articles that mention these tickers.

  • Name
    includeContent
    Type
    boolean
    Description

    Includes the full content of the article. Requires a specific subscription tier.

  • Name
    includeEntities
    Type
    boolean
    Description

    Includes the companies mentioned in the article. Requires a specific subscription tier.

  • Name
    excludeEmptyContent
    Type
    boolean
    Description

    Includes only articles that have a value in the content available. Requires a specific subscription tier.

  • Name
    from
    Type
    string
    Description

    Start date in YYYY-MM-DD format or ISO date string.

  • Name
    to
    Type
    string
    Description

    End date in YYYY-MM-DD format or ISO date string.

  • Name
    language
    Type
    string
    Description

    Filter by language. Language code in ISO 639-1

  • Name
    order
    Type
    string
    Description

    Order by date ("ASC" or "DESC") - default "DESC".

  • Name
    pageSize
    Type
    number
    Description

    Number of results per page (1-100).

  • Name
    page
    Type
    number
    Description

    Page number.

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" }'

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"
                ],
      "content": "Full article content here...",
      "companies": [
                {
                    "companyId": 41494,
                    "confidence": "0.9335401058197021",
                    "country": "United States",
                    "exchange": "NASDAQ",
                    "industry": "Biotechnology: Pharmaceutical Preparations",
                    "name": "Summit Therapeutics Inc. Common Stock",
                    "sector": "Health Care",
                    "ticker": "SMMT",
                    "isin": "US86627T1088",
                    "openfigi": "BBG01PH11VP5"
                },
                ...
              ]
    },
    // ...
  ]
}
GET/v2/sources

Get all sources

Retrieve a list of all currently supported article sources.

Response

A JSON array of source objects. Example:

  • Name
    array
    Type
    Source[]
    Description

    Array of news sources.

Source model

The response source model contains information about a news source, including its domain, content availability, and whether it is a default source.

  • Name
    domain
    Type
    string
    Description

    Domain of the source website.

  • Name
    isContentAvailable
    Type
    boolean
    Description

    Indicates if the full content of articles from this source is available.

  • Name
    isDefaultSource
    Type
    boolean
    Description

    Indicates if this source is a default source for the 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",
    "isContentAvailable": true,
    "isDefaultSource": true
  },
  {
    "domain": "seekingalpha.com",
    "isContentAvailable": true,
    "isDefaultSource": true
  },
  // ...
]