API développeur

Envoyez votre clé fom_live_… comme token Bearer : /api/v1/meta la valide, /api/v1/screener renvoie le screener classé au format JSON, avec les en-têtes de limitation du débit dans chaque réponse.

L’API de données Formion donne un accès programmatique aux mêmes signaux que dans l’application — screener classé, probabilités de réussite calibrées et plus encore — via un simple endpoint REST authentifié. Elle s’adresse aux quants, aux développeurs de bots et aux desks de trading qui souhaitent intégrer l’avantage Formion dans leurs propres systèmes.

Statut : disponible sur demande. Les clés sont délivrées manuellement par l’équipe Formion. Les tokens API personnels en libre-service sont prévus — la carte d’accès API dans Profil → Licence affiche Bientôt disponible. Contactez [email protected] pour demander une clé.

Authentification

Chaque requête transmet votre clé API comme token Bearer :

curl "https://app.formion.ai/api/v1/screener?tf=1d&limit=25" \
  -H "Authorization: Bearer fom_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Les clés ressemblent à fom_live_…. Traitez-les comme un mot de passe — toute personne disposant de la clé peut appeler l’API en votre nom.
La clé est affichée une seule fois lors de sa délivrance et stockée uniquement sous forme de hash de notre côté. Si vous la perdez, nous la révoquons et en délivrons une nouvelle — nous ne pouvons pas la récupérer.
Vous pouvez aussi transmettre la clé via ?api_key=… pour des tests rapides, mais l’en-tête Authorization est préférable.

Si votre clé est absente, incorrecte ou révoquée, vous recevez :

{ "ok": false, "error": "unauthorized", "hint": "Send a valid key as 'Authorization: Bearer fom_live_…'. Request access at [email protected]." }

avec le code HTTP 401.

Limites de débit

Chaque clé dispose d’un quota par minute défini par son niveau d’accès API (attribué lors de la délivrance de la clé) :

Niveau	Requêtes / minute
Gratuit	60
Pro	600
Institutional	6 000

Chaque réponse inclut des en-têtes standard pour vous permettre d’adapter votre débit :

X-RateLimit-Limit: 600
X-RateLimit-Remaining: 594
X-RateLimit-Reset: 1789200000     # unix seconds when the window resets

Tout dépassement du quota renvoie le code HTTP 429 avec { "ok": false, "error": "rate_limited", "tier": "…" } et un en-tête Retry-After (en secondes). Attendez avant de réessayer.

Gestion des versions

Tous les endpoints se trouvent sous /api/v1/. Nous considérons la structure des réponses v1 comme un contrat stable — de nouveaux champs peuvent être ajoutés, mais les champs existants ne changeront pas de sens et ne disparaîtront pas sans une nouvelle version (/api/v2/). Vous pouvez développer sur v1 en toute confiance.

Endpoints

GET /api/v1/meta`

Confirme que votre clé fonctionne et liste les ressources auxquelles elle donne accès.

curl https://app.formion.ai/api/v1/meta -H "Authorization: Bearer fom_live_…"

{
  "ok": true,
  "api_version": "v1",
  "key": { "tier": "pro", "rate_per_min": 600, "label": "Acme backtest bot" },
  "endpoints": [
    { "path": "/api/v1/meta", "method": "GET", "desc": "This key's tier + endpoint list." },
    { "path": "/api/v1/screener", "method": "GET", "desc": "Ranked multi-market screener with Formion score + P(win). Query: tf, limit, minScore." }
  ],
  "docs": "https://docs.formion.ai/api",
  "support": "[email protected]"
}

GET /api/v1/screener`

Le screener multimarché classé — le même moteur que celui de l’onglet Screener de l’application.

Paramètres de requête

Paramètre	Valeur par défaut	Description
`tf`	`1d`	Unité de temps : `5m`, `15m`, `1h`, `4h`, `1d`
`limit`	`100`	Nombre de lignes à renvoyer (max 500)
`minScore`	`0`	Renvoyer uniquement les lignes dont le score est ≥ à cette valeur

Exemple

curl "https://app.formion.ai/api/v1/screener?tf=4h&limit=5&minScore=60" \
  -H "Authorization: Bearer fom_live_…"

{
  "ok": true,
  "api_version": "v1",
  "tier": "pro",
  "timeframe": "4h",
  "scanned_at": 1789199400000,
  "count": 5,
  "data": [
    {
      "symbol": "SOLUSDT",
      "asset_class": "crypto",
      "category": "bull-pullback",
      "direction": "long",
      "score": 74,
      "win_probability": 0.58,
      "rsi_1d": 61,
      "tags": ["at-bull-fvg", "bos-up-1d", "arsi-turn-up-4h"]
    }
  ]
}

Référence des champs

Champ	Signification
`symbol`	Paire sur la plateforme d’échange ou ticker
`asset_class`	Classe d’actifs de la ligne (par exemple `crypto`, `stock`, `index`, `commodity`)
`category`	Catégorie de configuration (`bull`, `bear-rally`, `sweep-confirmed`, …)
`direction`	`long`, `short` ou `null`
`score`	Score composite Formion, 0–100
`win_probability`	Probabilité calibrée du modèle que le signal soit correct à l’horizon de l’unité de temps, ou `null` si le modèle n’a pas atteint son seuil de précision
`rsi_1d`	RSI(14) journalier
`tags`	Tags de structure + momentum (FVG, BoS/CHoCH, VWAP, retournements Adaptive-RSI, …)
`scanned_at`	Horodatage Unix en ms du scan sous-jacent (les données peuvent dater de quelques minutes)

Ces deux endpoints (/meta et /screener) constituent aujourd’hui toute l’API v1. Si vous avez besoin d’autres données, indiquez-nous lesquelles — aucun engagement n’est encore pris concernant d’autres endpoints.

Bonnes pratiques

Gérez le cache et la fréquence des requêtes avec discernement. Le screener relance son analyse toutes les quelques minutes ; des requêtes plus fréquentes épuisent votre quota pour des données identiques. Lisez scanned_at et ignorez les données si elles n’ont pas changé.
Une clé par système. Ne partagez pas une clé entre plusieurs clients — le suivi par clé nous permet, à vous comme à nous, d’évaluer l’utilisation.
N’exposez jamais une clé dans un navigateur ou un dépôt public. Si une clé fuite, contactez-nous par e-mail pour que nous puissions la révoquer et en émettre une nouvelle.

Obtenir une clé

Envoyez un e-mail à [email protected] en précisant votre cas d’utilisation et le volume prévu. Nous vous fournirons une clé, définirons son niveau d’accès et vous aiderons à réussir votre premier appel.