Endpoint d’API
Un endpoint est l’URL d’une fonction précise d’une API : un programme l’appelle pour obtenir un type de données, par exemple les spreads Spot – Spot ou les taux de funding. La documentation présente un endpoint avec sa méthode HTTP : GET /arbitrage/spot-spot.
Anatomie de l’URL
L’URL https://api.genesisarbitrage.com/v1/arbitrage/spot-spot?min_spread=0.5 dans une requête curl :
BASE="https://api.genesisarbitrage.com/v1"
curl "$BASE/arbitrage/spot-spot?min_spread=0.5" \
-H "X-API-Key: $GENESIS_API_KEY"
| Élément | Valeur |
|---|---|
| URL de base | https://api.genesisarbitrage.com/v1 : serveur et version de l’API |
| Chemin | /arbitrage/spot-spot : le jeu de données Spot — Spot |
| Paramètre de requête | min_spread=0.5 : un spread de 0,5 % ou plus |
La requête renvoie les opportunités avec un spread de 0,5 % ou plus : la coin (coin), les exchanges d’achat et de vente (exchange_buy, exchange_sell), les prix, spread_pct et les indicateurs de dépôt et de retrait. Les autres paramètres de l’endpoint, coin, exchange et min_volume, sont listés dans la section Spot — Spot.
Paramètres de chemin et paramètres de requête
Un paramètre de chemin fait partie de l’URL elle-même ; la documentation l’indique entre accolades. Dans /orderbooks/coin/{coin}, vous remplacez {coin} par un ticker : /orderbooks/coin/BTC renvoie les carnets d’ordres du BTC sur tous les exchanges et marchés (Carnets d’un coin).
Les paramètres de requête suivent le ? sous forme de paires nom=valeur séparées par &. Une même URL peut porter les deux types : dans /orderbooks/spreads/spot-futures?coin=BTC&volume=5000, le jeu spot-futures est dans le chemin, tandis que la coin et le volume de 5 000 $ sont des paramètres de requête (Δ des carnets).
Erreurs lors de l’appel
| Réponse | Cause |
|---|---|
404 not_found | Cet endpoint ou cette ressource n’existe pas |
400 bad_request | Paramètres invalides, détails dans message |
403 plan_restricted | L’endpoint n’est pas dans votre forfait |
410 gone | L’endpoint est retiré, son remplaçant est indiqué dans message |
La liste complète de plus de 35 endpoints se trouve dans la documentation et dans la spécification lisible par machine OpenAPI.
Voir aussi : API REST, JSON, endpoints d’arbitrage, endpoints de carnets d’ordres.
Questions et réponses
En quoi un endpoint diffère-t-il d’une API ?
Une API est l’ensemble des fonctions d’un service ; un endpoint est une fonction avec sa propre URL. Genesis API en compte plus de 35 : arbitrage, carnets d’ordres, funding, marché, on-chain, marchés de prédiction, signaux IA et recherche de coins.