Ana içeriğe geç
QuantanSite

API başvurusu

API belgeleri

Bu sitenin gösterdiği piyasa verisinin üzerinde salt okunur bir JSON API'si. Başarılı yanıtlar { data, meta } zarfını kullanır; hatalar { error: { code, message } } zarfını kullanır.

Temel URL
http://localhost:3000
Yöntemler
Yalnızca GET
Biçim
JSON, UTF-8
Hız sınırı
IP adresi ve uç nokta başına 60 saniyede 60 istek

These are API examples. This site is served as static files.

Demo
Yanıtlar, sunucu MARKET_DATA_PROVIDER=fmp ile birlikte FMP_API_KEY ayarlamadıkça kurgusal ihraççılar içeren belirlenimci bir demo veri kümesinden gelir. Her yanıttaki meta.provider alanı hangi kaynağın yanıt verdiğini söyler.

Kotasyonları listele

GET/api/quotes

Enstrümanların bir sayfasını düz bir dizi olarak döndürür; meta içinde total, page ve pageSize bulunur. Aşağıdaki her tarayıcı filtresi burada da çalışır; ayrıştırılamayan değerler yok sayılır.

Parametreler

ParametreKonumTürGerekliAçıklama
sectorquerystringİsteğe bağlıTam sektör adı: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
sortquerystringİsteğe bağlıSıralama alanı: marketCap (varsayılan), price, changePercent, volume veya symbol.
orderquerystringİsteğe bağlıSıralama yönü: desc (varsayılan) veya asc.
pagequerynumberİsteğe bağlıSayfa numarası, 1 ile başlar.
pageSizequerynumberİsteğe bağlıSayfa başına satır: varsayılan 20, en fazla 100.

İstek

curl -s "http://localhost:3000/api/quotes?pageSize=3"

Yanıt örneği

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
  }
}

Örnek tek satıra kısaltılmıştır.

Kotasyon getir

GET/api/quotes/{symbol}

Bir enstrüman veya endeks için tam kotasyonu döndürür. Bilinmeyen bir sembol 404 not_found döndürür.

Parametreler

ParametreKonumTürGerekliAçıklama
symbolpathstringGerekliEnstrüman veya endeks sembolü, örneğin NWRB. Eşleştirme büyük-küçük harf farkını yok sayar.

İstek

curl -s "http://localhost:3000/api/quotes/NWRB"

Yanıt örneği

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."
  }
}

Mumları getir

GET/api/candles/{symbol}

OHLCV mumlarını en eskiden başlayarak döndürür. 1D aralığı 30-minute aralıklarını kullanır; diğer tüm aralıklar günlük mumları kullanır. Bilinmeyen bir aralık 400 bad_request döndürür.

Parametreler

ParametreKonumTürGerekliAçıklama
symbolpathstringGerekliEnstrüman veya endeks sembolü, örneğin NWRB. Eşleştirme büyük-küçük harf farkını yok sayar.
rangequerystringİsteğe bağlı1D, 5D, 1M, 6M, 1Y, 5Y değerlerinden biri. Varsayılan 1M.

İstek

curl -s "http://localhost:3000/api/candles/NWRB?range=1M"

Yanıt örneği

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"
  }
}

Örnek iki muma kısaltılmıştır; 1M aralığı 22 mum döndürür.

Enstrümanları tara

GET/api/screener

Enstrümanları tarayıcı sayfasıyla aynı parametrelerle filtreler, sıralar ve sayfalar. Sonuç, rows ile birlikte total, page ve pageSize taşır; ayrıştırılamayan değerler yok sayılır.

Parametreler

ParametreKonumTürGerekliAçıklama
sectorquerystringİsteğe bağlıTam sektör adı: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
minMarketCap, maxMarketCapquerynumberİsteğe bağlıUSD cinsinden piyasa değeri sınırları.
minPrice, maxPricequerynumberİsteğe bağlıUSD cinsinden fiyat sınırları.
minChangePercent, maxChangePercentquerynumberİsteğe bağlıYüzde puanı cinsinden günlük değişim sınırları: -3, -3% anlamına gelir.
minVolumequerynumberİsteğe bağlıHisse cinsinden en düşük günlük hacim.
profitableOnlyquerystringİsteğe bağlıYalnızca EPS değeri 0 üzerinde olan enstrümanları tutmak için 1 olarak ayarlayın.
sortquerystringİsteğe bağlıSıralama alanı: marketCap (varsayılan), price, changePercent, volume veya symbol.
orderquerystringİsteğe bağlıSıralama yönü: desc (varsayılan) veya asc.
pagequerynumberİsteğe bağlıSayfa numarası, 1 ile başlar.
pageSizequerynumberİsteğe bağlıSayfa başına satır: varsayılan 20, en fazla 100.

İstek

curl -s "http://localhost:3000/api/screener?profitableOnly=1&pageSize=5"

Yanıt örneği

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
  }
}

Örnek tek satıra kısaltılmıştır.

Kimlik doğrulama

Demo modu anahtar gerektirmez. Sunucu API_KEY ortam değişkenini ayarladığında her istek X-API-Key başlığında aynı değeri göndermelidir; başka her değer 401 unauthorized alır.

curl -s "http://localhost:3000/api/quotes/NWRB" \
  -H "X-API-Key: your-key-here"
Not
Anahtar yalnızca sunucuda okunur. Bu sayfadaki İsteği gönder düğmeleri API'yi tarayıcınızdan anahtarsız çağırır, bu nedenle anahtar kimlik doğrulaması etkinken 401 döndürürler.

Hata kodları

Başarısız istekler eşleşen bir HTTP durumu ve tek bir hata nesnesi döndürür. code üzerine dallanın; message insanlar için yazılmıştır ve değişebilir.

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
HTTP durumuKodNe zaman olur
400bad_requestBir parametre değerine izin verilmez, örneğin bilinmeyen bir mum aralığı.
401unauthorizedAPI_KEY yapılandırılmış ve istekte eşleşen bir X-API-Key başlığı yok.
404not_foundSembol veri kümesinde yok.
405method_not_allowedAPI salt okunurdur: /api/quotes, POST isteğine bu kodu yanıtlar.
429rate_limitedBir IP adresinden bir uç noktaya 60 saniyede 60 istekten fazla. Yanıt, saniye cinsinden Retry-After içerir.

Aynı verileri üründe görün

Piyasa genel bakışı, kotasyon sayfaları ve tarayıcı bu uç noktalarla aynı sağlayıcıyı okur.