Ga naar hoofdinhoud

API-referentie

API-documentatie

Een alleen-lezen JSON-API over dezelfde marktdata die deze site toont. Succesvolle antwoorden gebruiken de structuur { data, meta }; fouten gebruiken { error: { code, message } }.

Basis-URL
http://localhost:3000
Methoden
Alleen GET
Formaat
JSON, UTF-8
Snelheidslimiet
60 verzoeken per 60 seconden, per IP-adres en per endpoint

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

Demo
Responses komen uit een deterministische demoset met fictieve emittenten, tenzij de server MARKET_DATA_PROVIDER=fmp samen met FMP_API_KEY instelt. Het veld meta.provider van elke response geeft aan welke bron heeft geantwoord.

Koersen weergeven

GET/api/quotes

Geeft één pagina met instrumenten terug als een platte array, met total, page en pageSize in meta. Elk screenerfilter hieronder werkt hier ook; waarden die niet kunnen worden geparseerd, worden genegeerd.

Parameters

ParameterInTypeVereistBeschrijving
sectorquerystringOptioneelExacte sectornaam: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
sortquerystringOptioneelSorteerveld: marketCap (standaard), price, changePercent, volume of symbol.
orderquerystringOptioneelSorteervolgorde: desc (standaard) of asc.
pagequerynumberOptioneelPaginanummer, beginnend bij 1.
pageSizequerynumberOptioneelRijen per pagina: standaard 20, maximaal 100.

Verzoek

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

Voorbeeldresponse

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

Het voorbeeld is ingekort tot één rij.

Eén koers ophalen

GET/api/quotes/{symbol}

Geeft de volledige koers voor één instrument of index terug. Een onbekend symbool geeft 404 not_found.

Parameters

ParameterInTypeVereistBeschrijving
symbolpathstringVereistSymbool van instrument of index, bijvoorbeeld NWRB. Overeenkomsten zijn hoofdletterongevoelig.

Verzoek

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

Voorbeeldresponse

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

Candles ophalen

GET/api/candles/{symbol}

Geeft OHLCV-candles terug, oudste eerst. Het bereik 1D gebruikt intervallen van 30-minute; elk ander bereik gebruikt dagelijkse candles. Een onbekend bereik geeft 400 bad_request.

Parameters

ParameterInTypeVereistBeschrijving
symbolpathstringVereistSymbool van instrument of index, bijvoorbeeld NWRB. Overeenkomsten zijn hoofdletterongevoelig.
rangequerystringOptioneelEen van 1D, 5D, 1M, 6M, 1Y, 5Y. Standaard is 1M.

Verzoek

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

Voorbeeldresponse

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

Het voorbeeld is ingekort tot twee candles; 1M geeft er 22.

Instrumenten screenen

GET/api/screener

Filtert, sorteert en pagineert instrumenten met dezelfde parameters als de screenerpagina. Het resultaat bevat rows samen met total, page en pageSize; waarden die niet kunnen worden geparseerd, worden genegeerd.

Parameters

ParameterInTypeVereistBeschrijving
sectorquerystringOptioneelExacte sectornaam: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
minMarketCap, maxMarketCapquerynumberOptioneelGrenzen voor marktkapitalisatie in USD.
minPrice, maxPricequerynumberOptioneelPrijsgrenzen in USD.
minChangePercent, maxChangePercentquerynumberOptioneelGrenzen voor dagelijkse verandering in procentpunten: -3 betekent -3%.
minVolumequerynumberOptioneelMinimaal dagelijks volume in aandelen.
profitableOnlyquerystringOptioneelZet op 1 om alleen instrumenten met EPS boven 0 te behouden.
sortquerystringOptioneelSorteerveld: marketCap (standaard), price, changePercent, volume of symbol.
orderquerystringOptioneelSorteervolgorde: desc (standaard) of asc.
pagequerynumberOptioneelPaginanummer, beginnend bij 1.
pageSizequerynumberOptioneelRijen per pagina: standaard 20, maximaal 100.

Verzoek

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

Voorbeeldresponse

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

Het voorbeeld is ingekort tot één rij.

Authenticatie

De demomodus heeft geen sleutel nodig. Als de server de omgevingsvariabele API_KEY instelt, moet elk verzoek dezelfde waarde meesturen in de header X-API-Key; al het andere krijgt 401 unauthorized.

curl -s "http://localhost:3000/api/quotes/NWRB" \
  -H "X-API-Key: your-key-here"
Let op
De sleutel wordt alleen op de server gelezen. De knoppen Verzoek verzenden op deze pagina roepen de API zonder sleutel aan vanuit je browser, dus ze geven 401 zolang sleutelauthenticatie is ingeschakeld.

Foutcodes

Mislukte verzoeken geven een bijpassende HTTP-status en één foutobject. Vertak op code; de message is voor mensen geschreven en kan veranderen.

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
HTTP-statusCodeWanneer het gebeurt
400bad_requestEen parameterwaarde is niet toegestaan, bijvoorbeeld een onbekend candlebereik.
401unauthorizedAPI_KEY is ingesteld en het verzoek heeft geen bijpassende header X-API-Key.
404not_foundHet symbool bestaat niet in de dataset.
405method_not_allowedDe API is alleen-lezen: /api/quotes antwoordt op POST met deze code.
429rate_limitedMeer dan 60 verzoeken in 60 seconden vanaf één IP-adres naar één endpoint. De response bevat Retry-After in seconden.

Bekijk dezelfde data in het product

Het marktoverzicht, de koerspagina's en de screener lezen dezelfde provider als deze endpoints.