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.
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
/api/quotesEnstrü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
| Parametre | Konum | Tür | Gerekli | Açıklama |
|---|---|---|---|---|
| sector | query | string | İsteğe bağlı | Tam sektör adı: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate. |
| sort | query | string | İsteğe bağlı | Sıralama alanı: marketCap (varsayılan), price, changePercent, volume veya symbol. |
| order | query | string | İsteğe bağlı | Sıralama yönü: desc (varsayılan) veya asc. |
| page | query | number | İsteğe bağlı | Sayfa numarası, 1 ile başlar. |
| pageSize | query | number | İ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
/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
| Parametre | Konum | Tür | Gerekli | Açıklama |
|---|---|---|---|---|
| symbol | path | string | Gerekli | Enstrü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
/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
| Parametre | Konum | Tür | Gerekli | Açıklama |
|---|---|---|---|---|
| symbol | path | string | Gerekli | Enstrüman veya endeks sembolü, örneğin NWRB. Eşleştirme büyük-küçük harf farkını yok sayar. |
| range | query | string | İ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
/api/screenerEnstrü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
| Parametre | Konum | Tür | Gerekli | Açıklama |
|---|---|---|---|---|
| sector | query | string | İsteğe bağlı | Tam sektör adı: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate. |
| minMarketCap, maxMarketCap | query | number | İsteğe bağlı | USD cinsinden piyasa değeri sınırları. |
| minPrice, maxPrice | query | number | İsteğe bağlı | USD cinsinden fiyat sınırları. |
| minChangePercent, maxChangePercent | query | number | İsteğe bağlı | Yüzde puanı cinsinden günlük değişim sınırları: -3, -3% anlamına gelir. |
| minVolume | query | number | İsteğe bağlı | Hisse cinsinden en düşük günlük hacim. |
| profitableOnly | query | string | İsteğe bağlı | Yalnızca EPS değeri 0 üzerinde olan enstrümanları tutmak için 1 olarak ayarlayın. |
| sort | query | string | İsteğe bağlı | Sıralama alanı: marketCap (varsayılan), price, changePercent, volume veya symbol. |
| order | query | string | İsteğe bağlı | Sıralama yönü: desc (varsayılan) veya asc. |
| page | query | number | İsteğe bağlı | Sayfa numarası, 1 ile başlar. |
| pageSize | query | number | İ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"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 durumu | Kod | Ne zaman olur |
|---|---|---|
| 400 | bad_request | Bir parametre değerine izin verilmez, örneğin bilinmeyen bir mum aralığı. |
| 401 | unauthorized | API_KEY yapılandırılmış ve istekte eşleşen bir X-API-Key başlığı yok. |
| 404 | not_found | Sembol veri kümesinde yok. |
| 405 | method_not_allowed | API salt okunurdur: /api/quotes, POST isteğine bu kodu yanıtlar. |
| 429 | rate_limited | Bir 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.