Genesis Arbitrage

Genesis Arbitrage · · 10 min de lecture

Clé Genesis API : comment l’obtenir, où la stocker, comment la régénérer et la révoquer

En bref

  • Une clé gns_live_… se crée dans votre profil avec le bouton « Obtenir une clé » et ne s’affiche qu’une fois. Nous ne conservons que son hash : une clé perdue ne se récupère pas, elle se régénère.
  • La clé passe dans l’en-tête X-API-Key, depuis votre propre serveur. Le code la lit dans la variable d’environnement GENESIS_API_KEY ; elle ne va jamais dans l’URL d’une requête ni dans le code d’un site web.
  • Si la clé fuite, cliquez sur « Régénérer » : l’ancienne clé cesse de fonctionner aussitôt et vous la remplacez dans tous vos programmes. Chaque compte a une seule clé.

Une clé API de Genesis API est une chaîne gns_live_… qui fonctionne comme un mot de passe : le serveur s’en sert pour identifier votre compte et votre offre. Vous l’envoyez à chaque requête dans l’en-tête HTTP X-API-Key ; sans clé, ou avec une clé erronée, l’API renvoie 401 invalid_key. Chaque compte a une seule clé, que vous obtenez, régénérez et révoquez dans votre profil Genesis Arbitrage.

Où se trouve la clé

Vous gérez la clé dans votre profil, dans le bloc « Genesis API » ; les autres blocs du profil sont décrits dans le guide du profil du compte. Le bloc affiche votre abonnement à l’API et l’état de la clé :

Ce que vous voyezCe que cela signifie
« Abonnement inactif », bouton « S’abonner »Pas encore d’offre API ; le bouton ouvre les offres
« Abonnement actif », « Actif jusqu’au … », bouton « Renouveler »L’offre court jusqu’à cette date
« Abonnement expiré », bouton « Renouveler »La durée est écoulée : la clé est rejetée et les boutons de la clé sont masqués jusqu’au renouvellement
« Aucune clé créée », bouton « Obtenir une clé »Vous avez une offre, mais pas encore de clé
« Clé API » et gns_live_…Le début de la clé active ; la clé complète ne s’affiche plus jamais
« créée le … » · « utilisée le … »Quand la clé a été créée et quand elle a fait sa dernière requête
« Appels utilisés », « req/s », « fraîcheur », « réinitialisation le … »Quota consommé, limite de requêtes par seconde, délai des données et date de remise à zéro du compteur

Le lien « Documentation » dans le coin du bloc ouvre la documentation de Genesis API. Le quota et les limites sont expliqués dans le guide des limites de Genesis API.

Comment obtenir une clé

  1. Souscrivez une offre API

    Sur la page des tarifs de Genesis API, choisissez Trial, Start, Pro ou Max et une durée, cliquez sur « S’abonner » et réglez la facture en crypto. Le statut dans votre profil passe à « Abonnement actif ».

  2. Cliquez sur « Obtenir une clé »

    Le bouton apparaît dans le bloc « Genesis API » tant que vous n’avez pas de clé. La clé est créée immédiatement.

  3. Enregistrez la clé depuis la fenêtre « Votre clé API »

    La fenêtre affiche la clé complète une seule fois. Cliquez sur « Copier » et placez la clé dans un gestionnaire de mots de passe ou directement dans les variables protégées de votre serveur. Après « Terminé », vous ne pouvez plus revoir la clé complète : nous n’en gardons que le hash.

  4. Testez la clé avec une requête

    Appelez /account/usage comme dans les exemples ci-dessous. Une réponse 200 avec votre offre dans data.plan signifie que la clé est acceptée.

Comment envoyer la clé

La clé passe uniquement dans l’en-tête X-API-Key. Le serveur ne lit pas de clé dans les paramètres d’URL ni dans l’en-tête Authorization et répond 401. Les exemples lisent la clé dans la variable d’environnement GENESIS_API_KEY ; l’URL de base est https://api.genesisarbitrage.com/v1.

curl :

# la clé vient d’une variable d’environnement
curl "https://api.genesisarbitrage.com/v1/account/usage" \
  -H "X-API-Key: $GENESIS_API_KEY"

Python 3.10+ avec la bibliothèque requests :

import os

import requests

# os.environ[...] échoue tout de suite si la variable n’est pas définie
key = os.environ["GENESIS_API_KEY"]

r = requests.get(
    "https://api.genesisarbitrage.com/v1/account/usage",
    headers={"X-API-Key": key},
    timeout=10,
)
r.raise_for_status()
print(r.json()["data"]["plan"])

JavaScript, Node.js 18+ avec fetch intégré :

// fichier .mjs : les modules autorisent le top-level await
const key = process.env.GENESIS_API_KEY;
if (!key) throw new Error('GENESIS_API_KEY n’est pas définie');

const res = await fetch(
  'https://api.genesisarbitrage.com/v1/account/usage',
  { headers: { 'X-API-Key': key } },
);
const body = await res.json();
console.log(res.status, body.data?.plan);

Les trois requêtes renvoient la même réponse (valeurs illustratives) :

{
  "success": true,
  "data": {
    "plan": "pro",
    "calls_used": 184201,
    "calls_limit": 5000000,
    "rps_limit": 5,
    "freshness_sec": 10,
    "period_resets_at": 1786492800
  },
  "meta": { … }
}

Les champs de la réponse sont décrits dans la section Utilisation de la documentation.

Où stocker la clé

Une clé Genesis API sert seulement à lire des données : elle ne permet ni de trader ni de retirer des fonds. Une fuite vous coûte autre chose : les programmes d’autres personnes consomment votre quota et votre limite de requêtes par seconde.

EmplacementOKPourquoi
Variable d’environnement sur le serveurOuiLa clé reste hors du code et du dépôt
Un fichier .env listé dans .gitignoreOuiChargé par python-dotenv (load_dotenv()) et par node --env-file=.env dans Node.js 20.6+
Secrets d’hébergement et de CIOuiLa plateforme transmet la clé au programme au démarrage ; dans GitHub Actions, un secret de dépôt passé via le env de l’étape
Gestionnaire de mots de passeOuiUne copie de secours pour une personne
URL de la requêteNonLes URL finissent dans les journaux du serveur et du proxy et dans l’historique du navigateur
Code d’un site web, d’une extension ou d’une application mobileNonQuiconque ouvre le code source de la page ou décompresse l’application voit la clé
Dépôt publicNonLa clé reste dans l’historique des commits même après la suppression du fichier
Captures d’écran, discussions, tickets de supportNonLes messages et les images sont transférés

Si les données doivent arriver dans un navigateur, par exemple un tableau de bord ou une extension, votre serveur appelle Genesis API et le navigateur reçoit de votre serveur le résultat final. Le support a besoin du X-Request-Id de la réponse, de l’heure de la requête en UTC, du endpoint et du statut, jamais de la clé. Les clés d’exchange avec droits de trading sont plus risquées ; la façon de les restreindre est décrite dans comment sécuriser votre compte d’exchange crypto.

Régénérer et révoquer

BoutonCe qui se passeQuand l’utiliser
« Régénérer »L’ancienne clé cesse de fonctionner aussitôt et la fenêtre « Votre clé API » en affiche une nouvelleLa clé a fuité ou a été perdue, ou une personne qui la connaissait est partie
« Révoquer »La clé est désactivée sans remplaçante et l’accès à l’API est fermé ; le bloc affiche de nouveau « Obtenir une clé »Vous n’avez plus besoin de la clé

Les deux boutons demandent d’abord une confirmation. Les boîtes de dialogue affichent « Régénérer la clé ? La clé actuelle cessera de fonctionner immédiatement. » et « Révoquer la clé ? Elle cessera de fonctionner aussitôt et l’accès à l’API sera fermé. », avec « Annuler » et « Confirmer ». Si la clé a fuité :

  1. Régénérez la clé

    Cliquez sur « Régénérer », puis sur « Confirmer », et enregistrez la nouvelle clé depuis la fenêtre « Votre clé API ». Dès cet instant, les requêtes avec l’ancienne clé reçoivent 401.

  2. Remplacez la clé dans tous les programmes

    Mettez à jour les variables d’environnement, les fichiers .env et les secrets de CI et d’hébergement, puis redémarrez les programmes : un processus lit son environnement au démarrage. Si un programme envoie encore l’ancienne clé, vérifiez si GENESIS_API_KEY est déjà définie dans l’environnement : python-dotenv et node --env-file n’écrasent pas par la valeur de .env une variable déjà définie.

  3. Vérifiez votre consommation d’appels

    La ligne « Appels utilisés » de votre profil ou une requête vers /account/usage indique combien d’appels ont été consommés sur la période. La régénération ne remet pas le compteur à zéro.

401 invalid_key : que vérifier

Le serveur répond 401 avec le code invalid_key lorsque la clé est absente, erronée ou révoquée, ou que l’abonnement a expiré :

{
  "success": false,
  "error": {
    "code": "invalid_key",
    "message": "Missing X-API-Key header."
  }
}

Si l’en-tête est arrivé mais que la clé a été rejetée, message énumère d’un coup toutes les causes possibles. Une réponse 403 plan_restricted signifie autre chose : la clé est acceptée, mais le endpoint ne fait pas partie de votre offre. Les autres codes figurent dans la section Erreurs et dans le guide des réponses et erreurs de Genesis API.

Le formulaire « Essayer » de la documentation

Chaque endpoint de la documentation possède un formulaire « Essayer ». Collez la clé dans le champ « Votre clé API (gns_live_…) » et cliquez sur « Envoyer la requête » : le code de statut, le temps de réponse et une réponse abrégée apparaissent sous le formulaire. La clé n’est stockée que dans votre navigateur et n’est envoyée nulle part sauf à l’API.

Le navigateur mémorise la clé et remplit le champ à votre prochaine visite ; n’utilisez donc pas le formulaire sur l’ordinateur de quelqu’un d’autre. Une requête depuis le formulaire est un appel d’API ordinaire : elle consomme le quota et la limite de requêtes par seconde comme une requête depuis du code. Votre première requête depuis du code, avec la réponse expliquée, se trouve dans le démarrage rapide de Genesis API.

Questions et réponses

Puis-je avoir une clé distincte pour chaque bot ?

Non, chaque compte a une seule clé. Tous les programmes qui l’utilisent se partagent le quota d’appels et la limite de requêtes par seconde. Si les limites sont trop serrées, passez à une offre supérieure : ouvrir plusieurs comptes pour contourner les limites enfreint les règles.

La régénération remet-elle le compteur d’appels à zéro ?

Non. « Appels utilisés » appartient à l’abonnement du compte, pas à la clé : la nouvelle clé poursuit la même période de 30 jours.

Puis-je écrire l’en-tête en minuscules, x-api-key ?

Oui. Les noms d’en-têtes HTTP ne sont pas sensibles à la casse, règle posée par la RFC 9110, section 5.1. La clé elle-même doit être envoyée telle quelle.

Ai-je besoin d’une nouvelle clé après le renouvellement ?

Non. Tant que l’abonnement est expiré, la clé reçoit 401, et après « Renouveler » la même clé refonctionne.