मुख्य सामग्री पर जाएँ
QuantanSite

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 फ़ील्ड बताता है कि किस स्रोत ने उत्तर दिया।

कोट्स की सूची

GET/api/quotes

उपकरणों का एक पेज फ्लैट ऐरे के रूप में लौटाता है, जिसमें meta के अंदर total, page और pageSize होते हैं। नीचे दिया गया हर स्क्रीनर फ़िल्टर यहाँ भी काम करता है; जो मान पार्स नहीं हो सकते वे अनदेखा कर दिए जाते हैं।

पैरामीटर

पैरामीटरस्थानप्रकारआवश्यकविवरण
sectorquerystringवैकल्पिकसटीक सेक्टर नाम: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate।
sortquerystringवैकल्पिकक्रमबद्धता फ़ील्ड: marketCap (डिफ़ॉल्ट), price, changePercent, volume या symbol।
orderquerystringवैकल्पिकक्रमबद्धता की दिशा: desc (डिफ़ॉल्ट) या asc।
pagequerynumberवैकल्पिकपेज संख्या, 1 से शुरू।
pageSizequerynumberवैकल्पिकप्रति पेज पंक्तियाँ: डिफ़ॉल्ट रूप से 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
  }
}

नमूना घटाकर एक पंक्ति किया गया है।

कोट प्राप्त करें

GET/api/quotes/{symbol}

एक उपकरण या इंडेक्स का पूरा कोट लौटाता है। अज्ञात सिंबल 404 not_found लौटाता है।

पैरामीटर

पैरामीटरस्थानप्रकारआवश्यकविवरण
symbolpathstringआवश्यकउपकरण या इंडेक्स सिंबल, उदाहरण के लिए 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."
  }
}

कैंडल प्राप्त करें

GET/api/candles/{symbol}

OHLCV कैंडल सबसे पुराने से पहले लौटाता है। 1D रेंज 30-minute अंतराल का उपयोग करती है; बाकी हर रेंज दैनिक कैंडल का उपयोग करती है। अज्ञात रेंज 400 bad_request लौटाती है।

पैरामीटर

पैरामीटरस्थानप्रकारआवश्यकविवरण
symbolpathstringआवश्यकउपकरण या इंडेक्स सिंबल, उदाहरण के लिए NWRB। मिलान में केस को अनदेखा किया जाता है।
rangequerystringवैकल्पिक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 लौटाती है।

उपकरणों को स्क्रीन करें

GET/api/screener

स्क्रीनर पेज के समान पैरामीटर के साथ उपकरणों को फ़िल्टर करता है, क्रमबद्ध करता है और पेजों में बाँटता है। परिणाम में rows के साथ total, page और pageSize होते हैं; जो मान पार्स नहीं हो सकते वे अनदेखा कर दिए जाते हैं।

पैरामीटर

पैरामीटरस्थानप्रकारआवश्यकविवरण
sectorquerystringवैकल्पिकसटीक सेक्टर नाम: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate।
minMarketCap, maxMarketCapquerynumberवैकल्पिकUSD में मार्केट कैपिटलाइज़ेशन की सीमाएँ।
minPrice, maxPricequerynumberवैकल्पिकUSD में कीमत की सीमाएँ।
minChangePercent, maxChangePercentquerynumberवैकल्पिकप्रतिशत अंकों में दैनिक बदलाव की सीमाएँ: -3 का अर्थ -3% है।
minVolumequerynumberवैकल्पिकशेयरों में न्यूनतम दैनिक वॉल्यूम।
profitableOnlyquerystringवैकल्पिककेवल ऐसे उपकरण रखने के लिए 1 पर सेट करें जिनका EPS 0 से अधिक है।
sortquerystringवैकल्पिकक्रमबद्धता फ़ील्ड: marketCap (डिफ़ॉल्ट), price, changePercent, volume या symbol।
orderquerystringवैकल्पिकक्रमबद्धता की दिशा: desc (डिफ़ॉल्ट) या asc।
pagequerynumberवैकल्पिकपेज संख्या, 1 से शुरू।
pageSizequerynumberवैकल्पिकप्रति पेज पंक्तियाँ: डिफ़ॉल्ट रूप से 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"
नोट
कुंजी केवल सर्वर पर पढ़ी जाती है। इस पेज के अनुरोध भेजें बटन आपके ब्राउज़र से बिना कुंजी के API कॉल करते हैं, इसलिए कुंजी प्रमाणीकरण सक्षम रहने तक वे 401 लौटाते हैं।

त्रुटि कोड

विफल अनुरोध मेल खाता HTTP स्टेटस और एक त्रुटि ऑब्जेक्ट लौटाते हैं। code पर शाखा बनाएँ; message लोगों के लिए लिखा जाता है और बदल सकता है।

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
HTTP स्टेटसकोडकब होता है
400bad_requestकोई पैरामीटर मान अनुमत नहीं है, उदाहरण के लिए अज्ञात कैंडल रेंज।
401unauthorizedAPI_KEY कॉन्फ़िगर है और अनुरोध में मेल खाता X-API-Key हेडर नहीं है।
404not_foundयह सिंबल डेटासेट में मौजूद नहीं है।
405method_not_allowedAPI केवल-पढ़ने योग्य है: /api/quotes POST को यह कोड लौटाता है।
429rate_limitedएक IP पता से एक एंडपॉइंट पर 60 सेकंड में 60 से अधिक अनुरोध। प्रतिक्रिया में Retry-After सेकंड में शामिल होता है।

प्रोडक्ट में वही डेटा देखें

मार्केट अवलोकन, कोट पेज और स्क्रीनर इन एंडपॉइंट के समान प्रोवाइडर को पढ़ते हैं।