Aller au contenu principal
QuantanSite

Référence de l’API

Documentation de l’API

Une API JSON en lecture seule sur les mêmes données de marché que celles affichées par ce site. Les réponses réussies utilisent l’enveloppe { data, meta } ; les échecs utilisent { error: { code, message } }.

URL de base
http://localhost:3000
Méthodes
GET uniquement
Format
JSON, UTF-8
Limite de requêtes
60 requêtes par 60 secondes, par adresse IP et par point de terminaison

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

Démo
Les réponses proviennent d’un jeu de données de démonstration déterministe avec des émetteurs fictifs, sauf si le serveur définit MARKET_DATA_PROVIDER=fmp avec FMP_API_KEY. Le champ meta.provider de chaque réponse indique quelle source a répondu.

Lister les cotations

GET/api/quotes

Renvoie une page d’instruments sous forme de tableau plat, avec total, page et pageSize dans meta. Tous les filtres du screener ci-dessous fonctionnent aussi ici ; les valeurs qui ne peuvent pas être analysées sont ignorées.

Paramètres

ParamètreDansTypeObligatoireDescription
sectorquerystringFacultatifNom exact du secteur : Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
sortquerystringFacultatifChamp de tri : marketCap (par défaut), price, changePercent, volume ou symbol.
orderquerystringFacultatifOrdre de tri : desc (par défaut) ou asc.
pagequerynumberFacultatifNuméro de page, à partir de 1.
pageSizequerynumberFacultatifLignes par page : 20 par défaut, 100 au maximum.

Requête

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

Exemple de réponse

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

L’exemple est réduit à une ligne.

Obtenir une cotation

GET/api/quotes/{symbol}

Renvoie la cotation complète d’un instrument ou d’un indice. Un symbole inconnu renvoie 404 not_found.

Paramètres

ParamètreDansTypeObligatoireDescription
symbolpathstringObligatoireSymbole d’instrument ou d’indice, par exemple NWRB. La correspondance ignore la casse.

Requête

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

Exemple de réponse

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

Obtenir des chandeliers

GET/api/candles/{symbol}

Renvoie des chandeliers OHLCV, du plus ancien au plus récent. La plage 1D utilise des intervalles de 30-minute ; toutes les autres plages utilisent des chandeliers journaliers. Une plage inconnue renvoie 400 bad_request.

Paramètres

ParamètreDansTypeObligatoireDescription
symbolpathstringObligatoireSymbole d’instrument ou d’indice, par exemple NWRB. La correspondance ignore la casse.
rangequerystringFacultatifL’une des valeurs 1D, 5D, 1M, 6M, 1Y, 5Y. Par défaut : 1M.

Requête

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

Exemple de réponse

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

L’exemple est réduit à deux chandeliers ; 1M en renvoie 22.

Filtrer les instruments

GET/api/screener

Filtre, trie et pagine les instruments avec les mêmes paramètres que la page screener. Le résultat contient rows avec total, page et pageSize ; les valeurs qui ne peuvent pas être analysées sont ignorées.

Paramètres

ParamètreDansTypeObligatoireDescription
sectorquerystringFacultatifNom exact du secteur : Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
minMarketCap, maxMarketCapquerynumberFacultatifBornes de capitalisation boursière en USD.
minPrice, maxPricequerynumberFacultatifBornes de prix en USD.
minChangePercent, maxChangePercentquerynumberFacultatifBornes de variation journalière en points de pourcentage : -3 signifie -3 %.
minVolumequerynumberFacultatifVolume journalier minimal en titres.
profitableOnlyquerystringFacultatifDéfinir sur 1 pour ne conserver que les instruments dont l’EPS est supérieur à 0.
sortquerystringFacultatifChamp de tri : marketCap (par défaut), price, changePercent, volume ou symbol.
orderquerystringFacultatifOrdre de tri : desc (par défaut) ou asc.
pagequerynumberFacultatifNuméro de page, à partir de 1.
pageSizequerynumberFacultatifLignes par page : 20 par défaut, 100 au maximum.

Requête

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

Exemple de réponse

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

L’exemple est réduit à une ligne.

Authentification

Le mode démo ne nécessite aucune clé. Lorsque le serveur définit la variable d’environnement API_KEY, chaque requête doit envoyer la même valeur dans l’en-tête X-API-Key ; toute autre valeur reçoit 401 unauthorized.

curl -s "http://localhost:3000/api/quotes/NWRB" \
  -H "X-API-Key: your-key-here"
Remarque
La clé n’est lue que sur le serveur. Les boutons Envoyer la requête de cette page appellent l’API depuis votre navigateur sans clé ; ils renvoient donc 401 tant que l’authentification par clé est activée.

Codes d’erreur

Les requêtes en échec renvoient un statut HTTP correspondant et un seul objet d’erreur. Branchez-vous sur code ; le message est rédigé pour les humains et peut changer.

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
Statut HTTPCodeQuand cela se produit
400bad_requestUne valeur de paramètre n’est pas autorisée, par exemple une plage de chandeliers inconnue.
401unauthorizedAPI_KEY est configurée et la requête n’a pas d’en-tête X-API-Key correspondant.
404not_foundLe symbole n’existe pas dans le jeu de données.
405method_not_allowedL’API est en lecture seule : /api/quotes répond à POST avec ce code.
429rate_limitedPlus de 60 requêtes en 60 secondes depuis une adresse IP vers un point de terminaison. La réponse inclut Retry-After en secondes.

Retrouvez les mêmes données dans le produit

L’aperçu du marché, les pages de cotation et le screener lisent le même fournisseur que ces points de terminaison.