Utilise l'API Stock Events

L'API Stock Events est une fonctionnalité Pro pour automatiser les données de ton compte Stock Events depuis tes propres outils. Elle est conçue pour l'automatisation de compte, et non comme une API générale de données de marché ou de recherche de symboles.

Les requêtes d'écriture modifient les mêmes watchlists, symboles et transactions que ceux que tu vois dans Stock Events.

Ce que tu peux faire avec l'API

• Lister, créer, récupérer et mettre à jour des watchlists.
• Lister, ajouter, mettre à jour et supprimer des symboles dans une watchlist.
• Lister, créer, récupérer, mettre à jour et supprimer des transactions.
• Lire les vues calculées des Holdings et des Dividendes.

Comment créer une clé API

Un abonnement actif à Stock Events Pro est requis pour créer et utiliser des clés API.

1. Connecte-toi à l'application web Stock Events.
2. Ouvre ton Profil.
3. Sélectionne Paramètres.
4. Sous Compte, sélectionne Données.
5. Sélectionne Clés API.
6. Sélectionne Créer une clé API.
7. Entre un Nom descriptif, puis sélectionne Créer.
8. Sélectionne Copier la clé API et conserve la clé en lieu sûr avant de fermer la boîte de dialogue.

La clé API complète n'est affichée qu'une seule fois. Après avoir fermé la boîte de dialogue, l'écran des Clés API affichera son nom, son préfixe, sa date de création et sa date de dernière utilisation au lieu de la clé complète.

Si ton abonnement Pro devient inactif, tes clés restent liées à ton compte, mais les requêtes API renverront une erreur 403 Forbidden jusqu'à ce que l'accès Pro soit de nouveau actif.

Fais ta première requête

L'URL de base de l'API est https://stockevents.app/api/v1. Envoie ta clé API en tant que bearer token dans l'en-tête Authorization.

curl -H "Authorization: Bearer $STOCK_EVENTS_API_KEY" \    https://stockevents.app/api/v1/watchlists

Cette requête renvoie tes watchlists et leurs IDs. Tu peux utiliser l'ID d'une watchlist avec les endpoints spécifiques aux symboles, aux Holdings et aux Dividendes d'une watchlist.

Pour les champs de requête, les structures de réponse, les paramètres optionnels et tous les endpoints disponibles, utilise ces ressources :

• Documentation de l'API Stock Events
• Paramètres des Clés API
• Document OpenAPI

Garde ta clé API en sécurité

Traite une clé API comme un mot de passe. Ne la soumets pas à un contrôle de version (source control), ne l'expose pas dans du code client public et ne l'envoie pas dans un paramètre de requête ou dans le corps d'une requête.

Les clés API authentifient l'API d'automatisation de compte sans permissions distinctes pour chaque clé. Utilise-les uniquement avec des outils en lesquels tu as confiance.

Si une clé est exposée, retourne dans Clés API, sélectionne Révoquer la clé API, puis confirme Révoquer. La clé cessera de fonctionner immédiatement et ne pourra pas être réactivée. Crée une nouvelle clé de remplacement si nécessaire.

Erreurs courantes

• 401 Unauthorized : La clé API est manquante, invalide ou a été révoquée.
• 403 Forbidden : Le compte n'a pas d'accès Pro actif actuellement.