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 basic and extended articles using the Finlight.me API.

Article model

The 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.

GET/v1/articles

Get articles

Retrieve basic article information based on search queries and filters. The endpoint does not return the summary or content of an article. If the extended route is called the article contains the content and an optional summary.

Optional query parameters

Name
query
Type
string
Description
Search query to find relevant articles. Advanced queries
Name
sources
Type
string
Description
Filter by article single or multiple sources (separated by commas). E.g. "www.reuters.com,www.cnbc.com". See source endpoint for valid values.
Name
excludeSources
Type
string
Description
Excludes single or multiple sources (separated by commas). E.g. "www.reuters.com,www.cnbc.com". See source endpoint for valid values.
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

/v1/articles

curl -X GET 'https://api.finlight.me/v1/articles?query=Nvidia' \
  -H 'X-API-KEY: YOUR_API_KEY'

Response

{
  "status": "ok",
  "page": 1,
  "pageSize": 20,
  "articles": [
    {
      "link": "https://www.example.com/article1",
      "title": "Stock Market Hits New Highs",
      "publishDate": "2023-10-01T12:34:56Z",
      "source": "www.example.com",
      "language": "en",
      "sentiment": "positive",
      "confidence": 0.95,
      "summary": "A brief summary of the article...",
      "images": [
        "https://www.example.com/image1.jpg",
        "https://www.example.com/image2.jpg"
      ]
    },
    {
      "link": "https://www.example.com/article2",
      "title": "Economic Growth Slows Down",
      "publishDate": "2023-10-02T09:21:00Z",
      "source": "www.example.com",
      "language": "en",
      "sentiment": "negative",
      "confidence": 0.90,
      "summary": "A brief summary of the article...",
      "images": []
    }
    // ...
  ]
}

Extended article model

The 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 with specific api call, your subscribed tier. Can be nullable.

GET/v1/articles/extended

Get extended articles

Retrieve extended article information, including content and detailed analysis.

Optional query parameters

Name
query
Type
string
Description
Search query to find relevant articles. Advanced queries
Name
sources
Type
string
Description
Filter by article single or multiple sources (separated by commas). E.g. "www.reuters.com,www.cnbc.com". See source endpoint for valid values.
Name
excludeSources
Type
string
Description
Excludes single or multiple sources (separated by commas). E.g. "www.reuters.com,www.cnbc.com". See source endpoint for valid values.
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

/v1/articles/extended

curl -X GET 'https://api.finlight.me/v1/articles/extended?query=stock+market' \
  -H 'X-API-KEY: YOUR_API_KEY'

Response

{
  "status": "ok",
  "page": 1,
  "pageSize": 20,
  "articles": [
    {
      "link": "https://www.example.com/article1",
      "title": "Stock Market Hits New Highs",
      "publishDate": "2023-10-01T12:34:56Z",
      "source": "www.example.com",
      "language": "en",
      "sentiment": "positive",
      "confidence": 0.95,
      "content": "Full article content here...",
      "summary": "A brief summary of the article...",
      "images": [
                  "https://www.example.com/image1.jpg",
                  "https://www.example.com/image2.jpg"
                ]
    },
    // ...
  ]
}

GET/v1/sources

Get all sources

Retrieve a list of all currently supported article sources.

Response

A JSON array of source strings. Example:

Name
array
Type
string[]
Description
Array of news sources.

Request

GET

/v1/sources

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

Response

[
  "www.reuters.com",
  "www.cnbc.com",
  "www.wsj.com",
  "www.bloomberg.com"
  // ...
]