Hoppa till huvudinnehåll

API-referens

API-dokumentation

Ett skrivskyddat JSON-API över samma marknadsdata som webbplatsen visar. Lyckade svar använder strukturen { data, meta }; fel använder { error: { code, message } }.

Bas-URL
http://localhost:3000
Metoder
Endast GET
Format
JSON, UTF-8
Hastighetsgräns
60 anrop per 60 sekunder, per IP-adress och endpoint

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

Demo
Svaren kommer från en deterministisk demomängd med fiktiva emittenter om inte servern anger MARKET_DATA_PROVIDER=fmp tillsammans med FMP_API_KEY. Fältet meta.provider i varje svar anger vilken källa som svarade.

Lista kurser

GET/api/quotes

Returnerar en sida instrument som en platt array, med total, page och pageSize i meta. Alla screenerfilter nedan fungerar även här; värden som inte kan tolkas ignoreras.

Parametrar

ParameterITypObligatoriskBeskrivning
sectorquerystringValfriExakt sektornamn: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
sortquerystringValfriSorteringsfält: marketCap (standard), price, changePercent, volume eller symbol.
orderquerystringValfriSorteringsordning: desc (standard) eller asc.
pagequerynumberValfriSidnummer, med start på 1.
pageSizequerynumberValfriRader per sida: 20 som standard, högst 100.

Förfrågan

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

Exempelsvar

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

Exemplet är kortat till en rad.

Hämta en kurs

GET/api/quotes/{symbol}

Returnerar hela kursen för ett instrument eller index. En okänd symbol returnerar 404 not_found.

Parametrar

ParameterITypObligatoriskBeskrivning
symbolpathstringObligatoriskSymbol för instrument eller index, till exempel NWRB. Matchningen ignorerar skiftläge.

Förfrågan

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

Exempelsvar

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

Hämta candles

GET/api/candles/{symbol}

Returnerar OHLCV-candles, äldst först. Intervallet 1D använder 30-minute-intervall; alla andra intervall använder dagliga candles. Ett okänt intervall returnerar 400 bad_request.

Parametrar

ParameterITypObligatoriskBeskrivning
symbolpathstringObligatoriskSymbol för instrument eller index, till exempel NWRB. Matchningen ignorerar skiftläge.
rangequerystringValfriEtt av 1D, 5D, 1M, 6M, 1Y, 5Y. Standard är 1M.

Förfrågan

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

Exempelsvar

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

Exemplet är kortat till två candles; 1M returnerar 22.

Screena instrument

GET/api/screener

Filtrerar, sorterar och paginerar instrument med samma parametrar som screener-sidan. Resultatet innehåller rows tillsammans med total, page och pageSize; värden som inte kan tolkas ignoreras.

Parametrar

ParameterITypObligatoriskBeskrivning
sectorquerystringValfriExakt sektornamn: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
minMarketCap, maxMarketCapquerynumberValfriGränser för börsvärde i USD.
minPrice, maxPricequerynumberValfriPrisgränser i USD.
minChangePercent, maxChangePercentquerynumberValfriGränser för daglig förändring i procentenheter: -3 betyder -3%.
minVolumequerynumberValfriMinsta dagliga volym i aktier.
profitableOnlyquerystringValfriSätt till 1 för att bara behålla instrument med EPS över 0.
sortquerystringValfriSorteringsfält: marketCap (standard), price, changePercent, volume eller symbol.
orderquerystringValfriSorteringsordning: desc (standard) eller asc.
pagequerynumberValfriSidnummer, med start på 1.
pageSizequerynumberValfriRader per sida: 20 som standard, högst 100.

Förfrågan

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

Exempelsvar

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

Exemplet är kortat till en rad.

Autentisering

Demoläget kräver ingen nyckel. När servern anger miljövariabeln API_KEY måste varje förfrågan skicka samma värde i headern X-API-Key; allt annat får 401 unauthorized.

curl -s "http://localhost:3000/api/quotes/NWRB" \
  -H "X-API-Key: your-key-here"
Obs
Nyckeln läses bara på servern. Knapparna Skicka förfrågan på den här sidan anropar API:t från din webbläsare utan nyckel, så de returnerar 401 så länge nyckelautentisering är aktiverad.

Felkoder

Misslyckade förfrågningar returnerar en matchande HTTP-status och ett felobjekt. Förgrena på code; message är skrivet för människor och kan ändras.

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
HTTP-statusKodNär det händer
400bad_requestEtt parametervärde är inte tillåtet, till exempel ett okänt candleintervall.
401unauthorizedAPI_KEY är konfigurerad och förfrågan har ingen matchande header X-API-Key.
404not_foundSymbolen finns inte i datamängden.
405method_not_allowedAPI:t är skrivskyddat: /api/quotes svarar på POST med den här koden.
429rate_limitedFler än 60 anrop inom 60 sekunder från en IP-adress till en endpoint. Svaret innehåller Retry-After i sekunder.

Se samma data i produkten

Marknadsöversikten, kurssidorna och screenern läser samma leverantör som de här endpointerna.