Эндпоинты

На этой странице мы подробно рассмотрим различные эндпоинты, которые можно использовать для программного получения статей финансовых новостей. Мы разберём, как запрашивать статьи с помощью API finlight.me.

Модель статьи

Модель статьи в ответе содержит всю информацию о статье, такую как ссылка, заголовок, дата публикации и источник. Она также содержит тональность и уровень уверенности в ней.

Name
link
Type
string
Description
URL полной статьи.
Name
source
Type
string
Description
Веб-сайт источника. Например, www.reuters.com
Name
title
Type
string
Description
Заголовок статьи.
Name
summary
Type
string
Description
Краткое описание статьи, если оно есть. Может быть null.
Name
publishDate
Type
Date
Description
Дата публикации в формате ISO.
Name
createdAt
Type
Date
Description
Дата, когда статья была впервые проиндексирована системой finlight, в виде строки даты ISO 8601.
Name
revisedDate
Type
Date | null
Description
Дата последней редакции статьи после первоначальной публикации, в виде строки даты ISO 8601. null, если статья никогда не редактировалась. Возвращается при использовании orderBy=revisedDate или когда includeUpdates включён через WebSocket/Webhook.
Name
isUpdate
Type
boolean
Description
true, когда эта полезная нагрузка статьи является повторной доставкой, вызванной редакцией после публикации. Присутствует только когда includeUpdates включён в подписке WebSocket или Webhook.
Name
language
Type
string
Description
Код языка в формате ISO 639-1. Например, en | de | fr
Name
sentiment
Type
string
Description
Результат анализа тональности. Значения могут быть positive | neutral |negative
Name
confidence
Type
number
Description
Уровень уверенности анализа тональности от 0 до 1.
Name
images
Type
string[]
Description
Массив URL изображений из статьи.
Name
countries
Type
string[]
Description
Массив кодов стран в формате ISO 3166-1 alpha-2, представляющих страны, связанные со статьёй. Например, ["US", "GB", "DE"]. Может быть пустым.
Name
categories
Type
string[]
Description
Массив категорий статьи. Возможные значения: markets | economy | business | politics | geopolitics | regulation | technology | energy | commodities | crypto | health | climate | security. Может быть пустым.
Name
companies
Type
Company[]
Description
Массив компаний, упомянутых в статье. Отображается/доступно только при определённом уровне подписки. Может быть null.

Модель компании

Модель компании в ответе содержит информацию о компании, упомянутой в статье. Она включает такие детали, как название компании, тикер, отрасль и др.

Name
companyId
Type
number
Description
Уникальный идентификатор компании.
Name
confidence
Type
string
Description
Уровень уверенности идентификации компании от 0 до 1.
Name
country
Type
string
Description
Страна, в которой базируется компания, в формате ISO 3166-1 alpha-2. Например, US | DE | GB
Name
exchange
Type
string
Description
Фондовая биржа, на которой котируется компания.
Name
industry
Type
Date
Description
Отраслевой сектор компании. Например, Biotechnology, Technology
Name
name
Type
string
Description
Полное название компании. Например, Apple Inc.
Name
sector
Type
string
Description
Сектор компании. Например, Technology | Health Care
Name
ticker
Type
string
Description
Биржевой тикер компании. Например, AAPL | GOOGL
Name
isin
Type
string
Description
Международный идентификационный код ценных бумаг (ISIN) компании. Например, US0378331005
Name
openfigi
Type
string
Description
Идентификатор OpenFIGI компании. Например, BBG000B9XRY4
Name
primaryListing
Type
object
Description
Информация о листинге компании на основной фондовой бирже.
Name
primaryListing.ticker
Type
string
Description
Основной тикер на главной бирже.
Name
primaryListing.exchangeCode
Type
string
Description
Код основной биржи, на которой котируется акция.
Name
primaryListing.exchangeCountry
Type
string
Description
Страна основной биржи, на которой котируется акция.
Name
isins
Type
string[]
Description
Массив международных идентификационных кодов ценных бумаг (ISIN) компании.
Name
otherListings
Type
object[]
Description
Массив других листингов компании на фондовых биржах.
Name
otherListings[].ticker
Type
string
Description
Тикер на альтернативной бирже.
Name
otherListings[].exchangeCode
Type
string
Description
Код альтернативной биржи, на которой котируется акция.
Name
otherListings[].exchangeCountry
Type
string
Description
Страна альтернативной биржи, на которой котируется акция.

POST/v2/articles

Получить статьи

Получите информацию о статьях, включая подробный анализ, компании и др. Обратите внимание, что для доступа к некоторым полям требуется определённый уровень подписки.

Необязательные параметры BODY

Поскольку этот эндпоинт использует POST-запрос, вы можете передавать параметры в теле запроса. Это позволяет создавать более сложные запросы и опции фильтрации.

Name
query
Type
string
Description
Поисковый запрос для поиска релевантных статей с простыми или продвинутыми фильтрами. Продвинутые запросы
Name
sources
Type
string[]
Description
Простой фильтр для одного или нескольких источников (массив строк). См. эндпоинт «Получить все источники» для допустимых значений. Поддерживает подстановочный знак "*" для включения всех источников.
Name
excludeSources[]
Type
string[]
Description
Исключает один или несколько источников (массив строк). См. эндпоинт «Получить все источники» для допустимых значений.
Name
tickers
Type
string[]
Description
Фильтрация по биржевым тикерам (массив строк). Это вернёт статьи, упоминающие эти тикеры. Поддерживает подстановочный знак "*" для включения всех тикеров.
Name
countries
Type
string[]
Description
Фильтрация по стране компании с использованием кодов стран ISO 3166-1 alpha-2 (массив строк). Например, ["US", "GB", "DE"]
Name
includeEntities
Type
boolean
Description
Включает компании, упомянутые в статье. Требует определённого уровня подписки.
Name
from
Type
string
Description
Дата начала в формате YYYY-MM-DD или строка даты ISO.
Name
to
Type
string
Description
Дата окончания в формате YYYY-MM-DD или строка даты ISO.
Name
language
Type
string
Description
Фильтрация по языку (ISO 639-1). По умолчанию en, что возвращает только английский и исключает другие языки — см. Язык и охват.
Name
orderBy
Type
string
Description
Сортировка по ("publishDate", "createdAt" или "revisedDate") - по умолчанию "publishDate". publishDate — это дата публикации статьи согласно источнику. createdAt — это момент, когда статья была впервые проиндексирована finlight. revisedDate сортирует по самой последней дате редакции (статьи, которые никогда не редактировались, отображаются последними). Учтите, что некоторые источники публикуют статьи с прошлыми датами публикации.
Name
order
Type
string
Description
Порядок сортировки ("ASC" или "DESC") - по умолчанию "DESC".
Name
pageSize
Type
number
Description
Количество результатов на странице (1-100).
Name
page
Type
number
Description
Номер страницы.

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

Получить статью по ссылке

Получите одну статью по её URL. Возвращает полные данные статьи с анализом тональности и опционально включает содержимое и сущности компаний.

Обязательные параметры запроса

Name
link
Type
string
Description
URL статьи, которую нужно получить.

Необязательные параметры запроса

Name
includeContent
Type
boolean
Description
Включить полное содержимое статьи в ответ.
Name
includeEntities
Type
boolean
Description
Включить компании, упомянутые в статье. Требует определённого уровня подписки.

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

Получить все источники

Получите список всех поддерживаемых на данный момент источников статей.

Примечание: Источники извлекаются по принципу максимальных усилий и могут измениться в будущем.

Ответ

JSON-массив объектов источников. Пример:

Name
array
Type
Source[]
Description
Массив источников новостей.

Модель источника

Модель источника в ответе содержит информацию об источнике новостей, включая его домен и является ли он источником по умолчанию.

Name
domain
Type
string
Description
Домен веб-сайта источника.
Name
isDefaultSource
Type
boolean
Description
Указывает, является ли этот источник источником по умолчанию для 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
  },
  // ...
]