Référence de l’API

Aperçu de l’API

L’API Stochio est une API REST qui donne accès aux modèles Stochio depuis votre code.

Prérequis

Un compte sur la console Stochio.
Une clé API : consultez Obtenir votre clé API.

URL de base

https://api.stochio.fr/v1

Tous les endpoints sont préfixés par /v1.

Authentification

Chaque requête doit inclure votre clé API dans l’en-tête Authorization :

En-tête	Valeur	Obligatoire
`Authorization`	`Bearer sk-sto-...`	Oui
`Content-Type`	`application/json`	Pour les requêtes POST

Une clé API donne accès uniquement à l’API des modèles. Une clé révoquée est refusée immédiatement. N’exposez jamais votre clé côté client, par exemple dans le code d’une page web.

Endpoints disponibles

Méthode	Endpoint	Description
GET	/v1/models	Liste les modèles disponibles et leurs limites.
POST	/v1/forecast	Prévoit les prochaines barres d’une série de bougies.

Format des requêtes et des réponses

Les requêtes et les réponses sont au format JSON. Les dates suivent la norme ISO 8601. Les séries sont envoyées en colonnes : un tableau par champ, avec une valeur par barre, de la plus ancienne à la plus récente.

Erreurs

L’API renvoie toujours les erreurs au format JSON, avec un champ error (le code de l’erreur) et un champ message (sa description, en anglais) :

JSON

{"error": "rate_limited", "message": "Too many requests for this organization: 10 per minute."}

Code HTTP	Erreur	Description	Solution
400	`invalid_request`	Le format ou le contenu de la requête pose problème, ou elle dépasse une limite du plan.	Lisez le champ `message` : il indique le champ ou la limite en cause.
401	`invalid_api_key`	La clé API est absente, invalide, révoquée ou expirée, ou son organisation est fermée.	Vérifiez la variable `STOCHIO_API_KEY`, ou créez une nouvelle clé.
402	`quota_exceeded`	Votre organisation a atteint un quota du plan Développeur.	Attendez `resets_at` : l’en-tête `Retry-After` indique le nombre de secondes restantes.
429	`rate_limited`	Votre organisation a atteint une limite de débit (requêtes ou points de sortie par minute).	Attendez le nombre de secondes indiqué par l’en-tête `Retry-After` avant de réessayer.
502	`inference_failed`	Le modèle n’a pas renvoyé de prévision valide.	Réessayez. Si l’erreur persiste, contactez-nous.
503	`inference_unavailable`	Le modèle est temporairement surchargé ou indisponible.	Réessayez après le nombre de secondes indiqué par l’en-tête `Retry-After`.

Limites de débit

Les limites dépendent du plan de votre organisation. Consultez Limites de débit et quotas.