API publique

API publique Vantage

L'API publique permet d'intégrer les scores et données Vantage dans tes outils (Excel, Google Sheets, scripts Python, autres dashboards).

Activer l'API

Pendant la beta : Profil → API Keys → "Générer une clé". Tu reçois une clé Bearer à conserver précieusement (ne sera plus affichée après).

Au lancement payant, l'accès API sera limité au plan Premium.

Authentification

Toutes les requêtes nécessitent le header :

Authorization: Bearer vt_xxxxxxxxxxxxxxxxxxxxxxxx

Endpoints disponibles

`GET /api/public/v1/scores/:ticker`

Retourne le score Vantage et les ratios clés d'un ticker.

curl -H "Authorization: Bearer vt_xxx" \
  https://vantage.spaarple.fr/api/public/v1/scores/AAPL

Réponse :

{
  "ticker": "AAPL",
  "name": "Apple Inc.",
  "score": 78.4,
  "rating": "TRES BON",
  "criteria_validated": 10,
  "ratios": { "pe": 28.5, "roic": 0.32, "margin": 0.245, "growth": 0.082 },
  "updated_at": "2026-05-21T07:00:00"
}

Rate limiting

60 requêtes / minute par clé (sliding window)
1000 requêtes / jour par clé pendant la beta
HTTP 429 si dépassement avec un header Retry-After

Erreurs

401 : clé manquante ou invalide
404 : ticker inconnu
429 : rate limit
500 : erreur serveur (rare — réessayer)

Bonnes pratiques

Cache côté client : les scores changent au max toutes les 24h. Cache 12h au minimum.
Pas en boucle infinie : si tu pull 1000 tickers, fais-le séquentiellement avec un délai.
Garde ta clé secrète : ne la commit jamais dans Git, ne l'expose pas côté frontend.

À venir

Endpoint /screener avec filtres custom (multi-tickers)
Endpoint /track-record pour les pépites historiques
Webhooks d'alertes (changement de score significatif)

Ouvre une issue ou contacte-nous (contact@spaarple.fr) si tu as besoin d'un endpoint spécifique.