エンドポイント

このページでは、金融ニュース記事をプログラムから取得するために使用できるさまざまなエンドポイントを詳しく見ていきます。finlight.me API を使って記事をクエリする方法を確認します。

記事モデル

レスポンスの記事モデルには、リンク、タイトル、公開日、ソースなど、記事に関するすべての情報が含まれます。また、センチメントとその信頼度も含まれます。

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 を使用した場合、または WebSocket/Webhook 経由で includeUpdates が有効な場合に返されます。
Name
isUpdate
Type
boolean
Description
この記事ペイロードが公開後の修正によってトリガーされた再配信である場合に true。WebSocket または Webhook サブスクリプションで includeUpdates が有効な場合にのみ存在します。
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 ページあたりの結果数（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
  },
  // ...
]