एंडपॉइंट

इस पृष्ठ पर, हम उन विभिन्न एंडपॉइंट्स में गहराई से जाएँगे जिनका उपयोग आप प्रोग्रामेटिक रूप से वित्तीय समाचार लेखों को पुनर्प्राप्त करने के लिए कर सकते हैं। हम देखेंगे कि 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
कंपनी के लिए अंतर्राष्ट्रीय प्रतिभूति पहचान संख्याओं (ISINs) की सरणी।
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
  },
  // ...
]