Zum Hauptinhalt springen
QuantanSite

API-Referenz

API-Dokumentation

Eine schreibgeschützte JSON-API auf dieselben Marktdaten, die diese Website anzeigt. Erfolgreiche Antworten verwenden die Hülle { data, meta }; Fehler verwenden { error: { code, message } }.

Basis-URL
http://localhost:3000
Methoden
Nur GET
Format
JSON, UTF-8
Ratenlimit
60 Anfragen pro 60 Sekunden, pro IP-Adresse und Endpunkt

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

Demo
Die Antworten stammen aus einem deterministischen Demo-Datensatz mit fiktiven Emittenten, sofern der Server nicht MARKET_DATA_PROVIDER=fmp zusammen mit FMP_API_KEY setzt. Das Feld meta.provider jeder Antwort gibt an, welche Quelle geantwortet hat.

Kurse auflisten

GET/api/quotes

Gibt eine Seite von Instrumenten als flaches Array zurück, mit total, page und pageSize in meta. Alle Screener-Filter unten funktionieren auch hier; Werte, die nicht geparst werden können, werden ignoriert.

Parameter

ParameterInTypErforderlichBeschreibung
sectorquerystringOptionalExakter Sektorname: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
sortquerystringOptionalSortierfeld: marketCap (Standard), price, changePercent, volume oder symbol.
orderquerystringOptionalSortierreihenfolge: desc (Standard) oder asc.
pagequerynumberOptionalSeitenzahl, beginnend bei 1.
pageSizequerynumberOptionalZeilen pro Seite: standardmäßig 20, höchstens 100.

Anfrage

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

Beispielantwort

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

Das Beispiel ist auf eine Zeile gekürzt.

Einen Kurs abrufen

GET/api/quotes/{symbol}

Gibt den vollständigen Kurs für ein Instrument oder einen Index zurück. Ein unbekanntes Symbol liefert 404 not_found.

Parameter

ParameterInTypErforderlichBeschreibung
symbolpathstringErforderlichInstrument- oder Indexsymbol, zum Beispiel NWRB. Die Suche ignoriert Groß- und Kleinschreibung.

Anfrage

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

Beispielantwort

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

Candlesticks abrufen

GET/api/candles/{symbol}

Gibt OHLCV-Candlesticks zurück, älteste zuerst. Der Bereich 1D verwendet 30-minute-Intervalle; jeder andere Bereich verwendet Tageskerzen. Ein unbekannter Bereich liefert 400 bad_request.

Parameter

ParameterInTypErforderlichBeschreibung
symbolpathstringErforderlichInstrument- oder Indexsymbol, zum Beispiel NWRB. Die Suche ignoriert Groß- und Kleinschreibung.
rangequerystringOptionalEiner von 1D, 5D, 1M, 6M, 1Y, 5Y. Standard ist 1M.

Anfrage

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

Beispielantwort

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

Das Beispiel ist auf zwei Candlesticks gekürzt; 1M liefert 22.

Instrumente screenen

GET/api/screener

Filtert, sortiert und paginiert Instrumente mit denselben Parametern wie die Screener-Seite. Das Ergebnis enthält rows zusammen mit total, page und pageSize; Werte, die nicht geparst werden können, werden ignoriert.

Parameter

ParameterInTypErforderlichBeschreibung
sectorquerystringOptionalExakter Sektorname: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
minMarketCap, maxMarketCapquerynumberOptionalGrenzen der Marktkapitalisierung in USD.
minPrice, maxPricequerynumberOptionalPreisgrenzen in USD.
minChangePercent, maxChangePercentquerynumberOptionalGrenzen der Tagesänderung in Prozentpunkten: -3 bedeutet -3 %.
minVolumequerynumberOptionalMindesttagesvolumen in Stück.
profitableOnlyquerystringOptionalAuf 1 setzen, um nur Instrumente mit einem EPS über 0 zu behalten.
sortquerystringOptionalSortierfeld: marketCap (Standard), price, changePercent, volume oder symbol.
orderquerystringOptionalSortierreihenfolge: desc (Standard) oder asc.
pagequerynumberOptionalSeitenzahl, beginnend bei 1.
pageSizequerynumberOptionalZeilen pro Seite: standardmäßig 20, höchstens 100.

Anfrage

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

Beispielantwort

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

Das Beispiel ist auf eine Zeile gekürzt.

Authentifizierung

Der Demo-Modus benötigt keinen Schlüssel. Setzt der Server die Umgebungsvariable API_KEY, muss jede Anfrage denselben Wert im Header X-API-Key senden; alles andere erhält 401 unauthorized.

curl -s "http://localhost:3000/api/quotes/NWRB" \
  -H "X-API-Key: your-key-here"
Hinweis
Der Schlüssel wird nur auf dem Server gelesen. Die Schaltflächen „Anfrage senden“ auf dieser Seite rufen die API ohne Schlüssel aus Ihrem Browser auf und liefern daher 401, solange die Schlüssel-Authentifizierung aktiv ist.

Fehlercodes

Fehlgeschlagene Anfragen liefern einen passenden HTTP-Status und genau ein Fehlerobjekt. Verzweigen Sie nach code; die message ist für Menschen geschrieben und kann sich ändern.

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
HTTP-StatusCodeWann es auftritt
400bad_requestEin Parameterwert ist nicht zulässig, zum Beispiel ein unbekannter Candlestick-Bereich.
401unauthorizedAPI_KEY ist konfiguriert und die Anfrage hat keinen passenden X-API-Key-Header.
404not_foundDas Symbol existiert nicht im Datensatz.
405method_not_allowedDie API ist schreibgeschützt: /api/quotes antwortet auf POST mit diesem Code.
429rate_limitedMehr als 60 Anfragen in 60 Sekunden von einer IP-Adresse an einen Endpunkt. Die Antwort enthält Retry-After in Sekunden.

Dieselben Daten im Produkt ansehen

Marktübersicht, Kursseiten und Screener lesen denselben Anbieter wie diese Endpunkte.