क्विकस्टार्ट

finlight.me WebSocket API आपको वित्तीय समाचार लेखों को उनके प्रकाशित होते ही रीयल-टाइम में प्राप्त करने देता है। REST API के विपरीत, जिसे नया डेटा लाने के लिए समय-समय पर पोलिंग की आवश्यकता होती है, WebSocket API नए प्रकाशित लेखों को रीयल-टाइम में आपको पुश करता है, जिससे आप बार-बार अनुरोध किए बिना अपडेट रहते हैं।

• रीयल-टाइम अपडेट: कनेक्ट होने पर, आपको पहले आपकी क्वेरी से मेल खाने वाला नवीनतम लेख मिलता है। उसके बाद, आपकी क्वेरी से मेल खाने वाला कोई भी नया प्रकाशित लेख स्वतः आपको भेज दिया जाता है।
• निरंतर स्ट्रीमिंग: जब तक आवश्यक हो कनेक्ट रहें। प्रत्येक मूल्य निर्धारण स्तर में समानांतर WebSocket कनेक्शनों की एक निश्चित संख्या शामिल होती है जो पूरे महीने खुली रह सकती हैं। उपयोग-आधारित मूल्य निर्धारण नहीं है — आप केवल अपने स्तर में अनुमत समवर्ती कनेक्शनों की संख्या से सीमित हैं।
• सेंटिमेंट विश्लेषण: लेख सेंटिमेंट डेटा के साथ आते हैं ताकि आप बाज़ार के मूड का शीघ्र आकलन कर सकें।

साइन अप करें और अपनी मुफ़्त API कुंजी प्राप्त करें

यदि आपने अभी तक नहीं किया है, तो अपनी मुफ़्त API कुंजी प्राप्त करने के लिए finlight डैशबोर्ड पर साइन अप करें। इस कुंजी का उपयोग आपके WebSocket कनेक्शन को प्रमाणित करने के लिए किया जाएगा, ठीक वैसे ही जैसे REST API के साथ।

अपना क्लाइंट चुनें

finlight.me WebSocket API से कनेक्ट करने के लिए, आप स्ट्रीमिंग समर्थन वाली हमारी किसी भी क्लाइंट लाइब्रेरी का उपयोग कर सकते हैं। ये लाइब्रेरी कनेक्शन, प्रमाणीकरण और कीप-अलाइव (ping/pong) तंत्र के प्रबंधन को सरल बनाती हैं। PHP क्लाइंट एकमात्र अपवाद है — इसमें WebSocket समर्थन नहीं है, इसलिए PHP एप्लिकेशन में पुश डिलीवरी के लिए webhooks का उपयोग करें।

# Install the Node.js client library via npm
npm install finlight-client

कनेक्ट करें और रीयल-टाइम लेख प्राप्त करें

अपनी API कुंजी और चुने हुए क्लाइंट के साथ, अब आप एक WebSocket कनेक्शन स्थापित कर सकते हैं। कनेक्ट होने पर, आपको तुरंत आपकी क्वेरी से मेल खाने वाला सबसे हालिया लेख मिलेगा, उसके बाद नए लेख जैसे-जैसे आएँगे। क्लाइंट लाइब्रेरी आपके लिए प्रमाणीकरण और ping/pong कीप-अलाइव तंत्र को संभालती हैं।

import { FinlightApi } from 'finlight-client'

const client = new FinlightApi({
  apiKey: 'YOUR_API_KEY',
})

client.websocket.connect(
  { query: 'nvidia', language: 'en' },
  (article) => {
    console.log('New article received:', article)
  },
)

यह कनेक्शन जब तक आपको आवश्यकता हो खुला रहता है, और आपकी क्वेरी से मेल खाने वाले नए लेख निरंतर डिलीवर करता है। याद रखें कि आपकी बिलिंग कनेक्शन की अवधि पर आधारित है, इसलिए जब आपको अपडेट की आवश्यकता न हो तो कनेक्शन काटने का ध्यान रखें।

कनेक्शन सीमाओं का प्रबंधन

प्रत्येक मूल्य निर्धारण स्तर में समानांतर WebSocket कनेक्शनों की एक निश्चित संख्या शामिल होती है। यदि आप अपनी सीमा तक पहुँच जाते हैं और एक और कनेक्शन खोलने का प्रयास करते हैं, तो आप सबसे पुराने कनेक्शन को स्वतः बंद करने के लिए takeover विकल्प सक्षम कर सकते हैं:

TypeScript, Python, Java और Ruby में यह विकल्प उसी क्लाइंट पर सेट किया जाता है जो आपके पास पहले से है। Go, C# और Rust में शीर्ष-स्तरीय क्लाइंट हमेशा डिफ़ॉल्ट स्ट्रीम विकल्पों का उपयोग करता है, इसलिए takeover को इसके बजाय सीधे बनाए गए स्ट्रीम क्लाइंट पर कॉन्फ़िगर किया जाता है।

import { FinlightApi } from 'finlight-client'

const client = new FinlightApi(
  {
    apiKey: 'YOUR_API_KEY',
  },
  {
    // WebSocket-specific options
    takeover: true, // Automatically close oldest connection when limit is reached (default: false)
  },
)

client.websocket.connect(
  { query: 'nvidia', language: 'en' },
  (article) => {
    console.log('New article received:', article)
  },
)

takeover: true के साथ, यदि आप अपनी कनेक्शन सीमा तक पहुँच चुके हैं, तो नया कनेक्शन स्वतः सबसे पुराने मौजूदा कनेक्शन को बदल देगा। यह विकास के दौरान या एप्लिकेशन को पुनः परिनियोजित करते समय उपयोगी है। उत्पादन में, आप अपने कनेक्शनों पर स्पष्ट नियंत्रण बनाए रखने के लिए डिफ़ॉल्ट (takeover: false) रखना चाह सकते हैं।

आगे क्या?

अब जब आपने सफलतापूर्वक WebSocket API से कनेक्ट कर लिया है और रीयल-टाइम लेख प्राप्त कर लिए हैं, यहाँ कुछ अगले चरण दिए गए हैं जो आपको उपयोगी लग सकते हैं:

• आपको प्राप्त होने वाले लेखों को परिष्कृत करने के लिए source या extended क्वेरीज़ द्वारा फ़िल्टरिंग का अन्वेषण करें।
• विभिन्न कंपनियों, सूचकांकों या वित्तीय विषयों को ट्रैक करने के लिए आवश्यकतानुसार अपने query पैरामीटर समायोजित करें।
• मुफ़्त स्तर की सीमाओं के भीतर रहने के लिए finlight डैशबोर्ड में अपने उपयोग और कनेक्शन मिनटों की समीक्षा करें।