API संदर्भ
API दस्तावेज़
इस साइट पर दिखाए जाने वाले उसी मार्केट डेटा के ऊपर एक केवल-पढ़ने योग्य JSON API। सफल प्रतिक्रियाएँ { data, meta } एनवलप का उपयोग करती हैं; विफलताएँ { error: { code, message } } का उपयोग करती हैं।
- बेस URL
- http://localhost:3000
- विधियाँ
- केवल GET
- फ़ॉर्मैट
- JSON, UTF-8
- दर सीमा
- प्रति IP पता और प्रति एंडपॉइंट, हर 60 सेकंड में 60 अनुरोध
These are API examples. This site is served as static files.
MARKET_DATA_PROVIDER=fmp के साथ FMP_API_KEY सेट नहीं करता, तब तक प्रतिक्रियाएँ काल्पनिक जारीकर्ताओं वाले एक नियतात्मक डेमो डेटासेट से आती हैं। हर प्रतिक्रिया का meta.provider फ़ील्ड बताता है कि किस स्रोत ने उत्तर दिया।कोट्स की सूची
/api/quotesउपकरणों का एक पेज फ्लैट ऐरे के रूप में लौटाता है, जिसमें meta के अंदर total, page और pageSize होते हैं। नीचे दिया गया हर स्क्रीनर फ़िल्टर यहाँ भी काम करता है; जो मान पार्स नहीं हो सकते वे अनदेखा कर दिए जाते हैं।
पैरामीटर
| पैरामीटर | स्थान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|---|
| sector | query | string | वैकल्पिक | सटीक सेक्टर नाम: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate। |
| sort | query | string | वैकल्पिक | क्रमबद्धता फ़ील्ड: marketCap (डिफ़ॉल्ट), price, changePercent, volume या symbol। |
| order | query | string | वैकल्पिक | क्रमबद्धता की दिशा: desc (डिफ़ॉल्ट) या asc। |
| page | query | number | वैकल्पिक | पेज संख्या, 1 से शुरू। |
| pageSize | query | number | वैकल्पिक | प्रति पेज पंक्तियाँ: डिफ़ॉल्ट रूप से 20, अधिकतम 100। |
अनुरोध
curl -s "http://localhost:3000/api/quotes?pageSize=3"प्रतिक्रिया का नमूना
200application/json
{
"data": [
{
"symbol": "NWRB",
"name": "Northwind Robotics",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Industrial Automation",
"price": 733.8,
"change": -16.52,
"changePercent": -2.2,
"previousClose": 750.32,
"open": 750.03,
"dayHigh": 751.29,
"dayLow": 731.5,
"volume": 3471317,
"avgVolume": 2962633,
"marketCap": 982258754565,
"peRatio": 60.35,
"eps": 12.16,
"dividendYield": null,
"week52High": 963.99,
"week52Low": 583.89,
"afterHoursPrice": 731,
"afterHoursChangePercent": -0.38,
"updatedAt": "2026-11-12T21:00:00.000Z"
}
],
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
"total": 20,
"page": 1,
"pageSize": 3
}
}नमूना घटाकर एक पंक्ति किया गया है।
कोट प्राप्त करें
/api/quotes/{symbol}एक उपकरण या इंडेक्स का पूरा कोट लौटाता है। अज्ञात सिंबल 404 not_found लौटाता है।
पैरामीटर
| पैरामीटर | स्थान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|---|
| symbol | path | string | आवश्यक | उपकरण या इंडेक्स सिंबल, उदाहरण के लिए NWRB। मिलान में केस को अनदेखा किया जाता है। |
अनुरोध
curl -s "http://localhost:3000/api/quotes/NWRB"प्रतिक्रिया का नमूना
200application/json
{
"data": {
"symbol": "NWRB",
"name": "Northwind Robotics",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Industrial Automation",
"price": 733.8,
"change": -16.52,
"changePercent": -2.2,
"previousClose": 750.32,
"open": 750.03,
"dayHigh": 751.29,
"dayLow": 731.5,
"volume": 3471317,
"avgVolume": 2962633,
"marketCap": 982258754565,
"peRatio": 60.35,
"eps": 12.16,
"dividendYield": null,
"week52High": 963.99,
"week52Low": 583.89,
"afterHoursPrice": 731,
"afterHoursChangePercent": -0.38,
"updatedAt": "2026-11-12T21:00:00.000Z"
},
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice."
}
}कैंडल प्राप्त करें
/api/candles/{symbol}OHLCV कैंडल सबसे पुराने से पहले लौटाता है। 1D रेंज 30-minute अंतराल का उपयोग करती है; बाकी हर रेंज दैनिक कैंडल का उपयोग करती है। अज्ञात रेंज 400 bad_request लौटाती है।
पैरामीटर
| पैरामीटर | स्थान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|---|
| symbol | path | string | आवश्यक | उपकरण या इंडेक्स सिंबल, उदाहरण के लिए NWRB। मिलान में केस को अनदेखा किया जाता है। |
| range | query | string | वैकल्पिक | 1D, 5D, 1M, 6M, 1Y, 5Y में से एक। डिफ़ॉल्ट 1M है। |
अनुरोध
curl -s "http://localhost:3000/api/candles/NWRB?range=1M"प्रतिक्रिया का नमूना
200application/json
{
"data": [
{
"time": "2026-11-11",
"open": 757.4,
"high": 761.18,
"low": 743.92,
"close": 750.32,
"volume": 3531710
},
{
"time": "2026-11-12",
"open": 750.03,
"high": 751.29,
"low": 731.5,
"close": 733.8,
"volume": 3471317
}
],
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
"symbol": "NWRB",
"range": "1M"
}
}नमूना घटाकर दो कैंडल किया गया है; 1M वाली रेंज 22 लौटाती है।
उपकरणों को स्क्रीन करें
/api/screenerस्क्रीनर पेज के समान पैरामीटर के साथ उपकरणों को फ़िल्टर करता है, क्रमबद्ध करता है और पेजों में बाँटता है। परिणाम में rows के साथ total, page और pageSize होते हैं; जो मान पार्स नहीं हो सकते वे अनदेखा कर दिए जाते हैं।
पैरामीटर
| पैरामीटर | स्थान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|---|
| sector | query | string | वैकल्पिक | सटीक सेक्टर नाम: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate। |
| minMarketCap, maxMarketCap | query | number | वैकल्पिक | USD में मार्केट कैपिटलाइज़ेशन की सीमाएँ। |
| minPrice, maxPrice | query | number | वैकल्पिक | USD में कीमत की सीमाएँ। |
| minChangePercent, maxChangePercent | query | number | वैकल्पिक | प्रतिशत अंकों में दैनिक बदलाव की सीमाएँ: -3 का अर्थ -3% है। |
| minVolume | query | number | वैकल्पिक | शेयरों में न्यूनतम दैनिक वॉल्यूम। |
| profitableOnly | query | string | वैकल्पिक | केवल ऐसे उपकरण रखने के लिए 1 पर सेट करें जिनका EPS 0 से अधिक है। |
| sort | query | string | वैकल्पिक | क्रमबद्धता फ़ील्ड: marketCap (डिफ़ॉल्ट), price, changePercent, volume या symbol। |
| order | query | string | वैकल्पिक | क्रमबद्धता की दिशा: desc (डिफ़ॉल्ट) या asc। |
| page | query | number | वैकल्पिक | पेज संख्या, 1 से शुरू। |
| pageSize | query | number | वैकल्पिक | प्रति पेज पंक्तियाँ: डिफ़ॉल्ट रूप से 20, अधिकतम 100। |
अनुरोध
curl -s "http://localhost:3000/api/screener?profitableOnly=1&pageSize=5"प्रतिक्रिया का नमूना
200application/json
{
"data": {
"rows": [
{
"symbol": "NWRB",
"name": "Northwind Robotics",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Industrial Automation",
"price": 733.8,
"change": -16.52,
"changePercent": -2.2,
"previousClose": 750.32,
"open": 750.03,
"dayHigh": 751.29,
"dayLow": 731.5,
"volume": 3471317,
"avgVolume": 2962633,
"marketCap": 982258754565,
"peRatio": 60.35,
"eps": 12.16,
"dividendYield": null,
"week52High": 963.99,
"week52Low": 583.89,
"afterHoursPrice": 731,
"afterHoursChangePercent": -0.38,
"updatedAt": "2026-11-12T21:00:00.000Z"
}
],
"total": 17,
"page": 1,
"pageSize": 5
},
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
"total": 17,
"page": 1,
"pageSize": 5
}
}नमूना घटाकर एक पंक्ति किया गया है।
प्रमाणीकरण
डेमो मोड में किसी कुंजी की आवश्यकता नहीं है। जब सर्वर API_KEY एनवायरनमेंट वेरिएबल सेट करता है, तो हर अनुरोध को X-API-Key हेडर में वही मान भेजना होता है; किसी भी अन्य मान को 401 unauthorized मिलता है।
curl -s "http://localhost:3000/api/quotes/NWRB" \
-H "X-API-Key: your-key-here"त्रुटि कोड
विफल अनुरोध मेल खाता HTTP स्टेटस और एक त्रुटि ऑब्जेक्ट लौटाते हैं। code पर शाखा बनाएँ; message लोगों के लिए लिखा जाता है और बदल सकता है।
{
"error": {
"code": "not_found",
"message": "A human-readable explanation."
}
}| HTTP स्टेटस | कोड | कब होता है |
|---|---|---|
| 400 | bad_request | कोई पैरामीटर मान अनुमत नहीं है, उदाहरण के लिए अज्ञात कैंडल रेंज। |
| 401 | unauthorized | API_KEY कॉन्फ़िगर है और अनुरोध में मेल खाता X-API-Key हेडर नहीं है। |
| 404 | not_found | यह सिंबल डेटासेट में मौजूद नहीं है। |
| 405 | method_not_allowed | API केवल-पढ़ने योग्य है: /api/quotes POST को यह कोड लौटाता है। |
| 429 | rate_limited | एक IP पता से एक एंडपॉइंट पर 60 सेकंड में 60 से अधिक अनुरोध। प्रतिक्रिया में Retry-After सेकंड में शामिल होता है। |
प्रोडक्ट में वही डेटा देखें
मार्केट अवलोकन, कोट पेज और स्क्रीनर इन एंडपॉइंट के समान प्रोवाइडर को पढ़ते हैं।