Authentification
L'API CoinBoss est publique. Aucun compte ni clé API n'est nécessaire pour appeler un endpoint de données.
Aucune clé requise
Appelez n'importe quel endpoint du catalogue par un simple GET HTTPS. Les requêtes anonymes sont limitées par adresse IP : 1200 requêtes par minute.
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"Clé API facultative
Si plusieurs de vos services partagent une même adresse IP, ou si vous appelez depuis un réseau dont l'adresse change, vous pouvez créer une clé dans votre compte et l'envoyer dans l'en-tête CB-API-KEY. Une requête munie d'une clé valide est décomptée sur la clé et non sur l'adresse IP.
- Les clés se créent et se révoquent sur la page Clés API de votre compte. Une adresse e-mail vérifiée est requise.
- La clé complète n'est affichée qu'une fois, à sa création. Seul un hash est conservé : elle ne peut donc plus être affichée ensuite.
- Chaque compte peut détenir jusqu'à cinq clés actives.
- Une clé inconnue ou révoquée est ignorée : la requête est traitée comme anonyme et décomptée sur l'adresse IP.
Requête avec une clé
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC" \
-H "CB-API-KEY: $COINBOSS_API_KEY"Niveaux de limite de requêtes
Tous les niveaux renvoient les mêmes données. Pendant la période de gratuité actuelle, le trafic anonyme et toutes les clés bénéficient du niveau le plus élevé.
| Niveau | Requêtes par minute | |
|---|---|---|
| hobbyist | 30 | |
| startup | 80 | |
| standard | 300 | |
| professional | 1200 | en vigueur pour tous |
Protéger vos clés
- Traitez une clé comme un mot de passe. Conservez-la dans une variable d'environnement ou un gestionnaire de secrets, pas dans le code source.
- N'intégrez pas de clé dans une page web, une extension de navigateur ou une application mobile. Tout ce qui est livré à un client peut être lu par ses utilisateurs. Appelez l'API depuis votre serveur, ou appelez-la anonymement depuis le navigateur.
- Révoquez une clé dès que vous soupçonnez une fuite et créez-en une nouvelle.
- CoinBoss ne demande jamais de clés API de plateformes. Les données sont collectées auprès des endpoints publics des plateformes ; cette API ne requiert ni n'accepte aucun identifiant de plateforme.
Appeler depuis un navigateur
Les réponses incluent Access-Control-Allow-Origin: *, de sorte que les endpoints de données peuvent être appelés depuis n'importe quelle origine web. Les en-têtes X-Request-Id, X-Cache et X-RateLimit-* sont exposés aux scripts.
Endpoints de compte
Les endpoints sous /api/user et /api/auth relèvent de l'expérience connectée du site (listes de suivi, préférences, gestion des clés). Ils utilisent la session du site, ne font pas partie de l'API publique de données et ne figurent pas dans le catalogue.