Questions fréquentes sur l'API OKX
Que signifie le terme Phrase secrète ?
Ceci est le mot de passe que vous avez saisi lors de la demande de la Clé API. Vous devez le mémoriser vous-même. Une fois oublié, vous ne pourrez pas le récupérer et devrez créer une nouvelle Clé API.
Comment créer une clé API ?
Sur l’application :
1. Connectez-vous à votre Compte OKX > Sélectionnez Menu (⋮⋮⋮) > Faites défiler vers le bas et sélectionnez Clé API > Créer une clé API
2. Remplissez le nom de l'API > Sélectionnez le compte et le but > Saisissez la liste blanche d'adresses IP > Sélectionnez les autorisations > Saisissez la phrase secrète
Sur le Web :
1. Connectez-vous à votre Compte OKX > Allez dans votre Profil et sélectionnez API et connexions > Créer une clé API
2. Remplissez le nom de la Clé API > Sélectionnez le compte et le Usage
3. Saisissez la liste blanche des adresses IP > Sélectionnez Autorisations > Saisissez la phrase secrète
Note :
Les adresses IP contribuent à sécuriser votre Clé API. Vous pouvez associer jusqu'à 20 adresses par clé, en les séparant par une virgule ou un espace.
Vous devez consulter les informations de l'API et accéder à son interface. Veuillez garder votre mot de passe en sécurité. Vous pouvez créer une nouvelle API si vous perdez le mot de passe, car nous ne pouvons pas récupérer les API.
Comment gérer ou modifier la clé API ?
Pour gérer ou modifier votre clé API sur OKX :
Connectez-vous à votre Compte OKX et allez dans Profil > API.
Vous verrez une liste de vos clés API existantes. Cliquez sur celle que vous souhaitez gérer.
À partir d'ici, vous pouvez :
Afficher le nom de la clé API, les autorisations et la liste blanche IP associée.
Modifier le nom de la clé, les autorisations (Lecture, Trader, Retirer) ou les adresses IP associées.
Supprimez la clé si elle n'est plus nécessaire.
Remarque : Vous ne pouvez pas consulter la phrase secrète après sa création initiale. En cas de perte, vous devrez supprimer la clé existante et en créer une nouvelle. Veuillez toujours conserver vos identifiants en lieu sûr.
Comment différencier le trading spot du trading sur marge si je trade en utilisant l'API ?
La manière dont le spot et le trading sur marge sont différenciés via l'API peut varier en fonction de votre type de compte et de vos paramètres. Nous vous recommandons de consulter la documentation API OKX pour obtenir les paramètres les plus précis et à jour applicables à la configuration de votre compte.
Si vous avez besoin de plus de précisions, veuillez contacter l'Assistant OKX pour une assistance personnalisée.
Comment créer une clé API de disque de démonstration ?
Pour trader sur le demo disk API, vous devez créer une Clé API sur le demo disk. Suivez les étapes ci-dessous :
Connectez-vous à votre Compte OKX > trading > trading en mode démo > Centre personnel > Créer une Clé API de compte démo > Commencer le trading en mode démo
La clé API expirera-t-elle ?
Les clés API non liées à une adresse IP et disposant des autorisations de transaction ou de retrait seront automatiquement supprimées après 14 jours d'inactivité. Les clés API ne seront pas considérées comme inactives si elles sont utilisées pour appeler des interfaces privées ou liées au compte nécessitant une vérification d’identité, telles que la consultation du solde du compte, des données de facturation ou la passation d’ordres.
Seules les clés API en lecture seule liées à une adresse IP ou à des autorisations spécifiques n’expireront pas.
Quelles sont les autorisations Loan, Earn et transférer ?
Transférer : Permet à la clé de transférer des fonds entre vos comptes. Disponible pour tous les comptes.
Loan : Permet à la clé d'emprunter, de rembourser et de gérer les Loan. Visible uniquement si votre compte dispose de l'éligibilité requise aux fonctionnalités.
Gagner : Permet à la clé de s'abonner et de récupérer des produits Gagner. Visible uniquement si votre compte dispose de l'éligibilité requise aux fonctionnalités.
Si votre clé API disposait auparavant des autorisations de Trader activées, les trois autorisations seront automatiquement activées lors de cette mise à jour. Aucune configuration manuelle n'est requise.
Peut-on passer des ordres en unités de devise lors de la passation d'ordres via l'interface ?
Non ; pour les ordres de contrat, l'interface utilise par défaut le nombre de contrats. Si vous devez calculer la conversion entre le nombre de contrats et les jetons, vous pouvez consulter l'interface de conversion nombre de contrats-vers-jeton ici.
Comment obtenir le taux de fluctuation de l'interface ?
L'interface ne peut pas obtenir directement l'augmentation ou la diminution du cours, mais cela peut être calculé à l'aide d'une formule de calcul.
La valeur de la hausse ou de la baisse du dernier cours de transaction par rapport au cours d'ouverture du chandelier il y a 24 heures / 100 % du cours d'ouverture du chandelier il y a 24 heures.
Les données de la formule ci-dessus peuvent être obtenues via l'interface du marché ici.
Quelle est la raison du message d'erreur « 51000 Parameter posSide error » lors de la passation d'un ordre ?
Vous devez d'abord vérifier le mode du compte ; mode achat et vente/mode ouverture et fermeture, que vous pouvez consulter ici pour obtenir posMode.
Remarque :
Dans le cas de l'ouverture et de la fermeture de positions et de la passation d'ordres en utilisant un contrat, le paramètre posSide est requis, et longue ou courte doit être renseigné.
S'il s'agit d'un mode d'achat et de vente, ou si une transaction de cryptomonnaie ou à effet de levier est effectuée en mode ouverture et fermeture, posSide ne prend en charge que la transmission nette ou aucune transmission.
Quelle interface peut être utilisée pour obtenir la valeur nominale du contrat et la quantité minimale de l'ordre ?
Vous pouvez utiliser l'interface pour obtenir des informations de base sur les produits de trading ici.
valeur nominale du contrat : ctVal, quantité minimale de l'ordre : minSz.
Quel est le format de instId ?
Vous pouvez directement utiliser l'interface pour obtenir les informations de base des produits de trading ici.
Comment définir un stop Loss et un Take Profit ?
Si l'ordre est associé à un take profit ou un stop Loss, vous pouvez consulter l'interface des ordres ici : paramètres du tableau attachAlgoOrds.
Cependant, s'il s'agit d'un stop Loss d'ordre distinct, vous pouvez consulter l'interface de commission de stratégie ici.
Pourquoi une erreur est-elle signalée lors de la définition du cours de déclenchement pour le Take Profit et le stop Loss : 51046, 51047, 51048, 51049 ?
Règles pour définir le cours de déclenchement du stop-loss / du take-profit – lors de la vente, le cours de déclenchement du take-profit est supérieur au dernier cours de transaction, et le cours de déclenchement du stop-loss est inférieur au dernier cours de transaction ; lors de l'achat, le cours de déclenchement du take-profit est inférieur au dernier cours de transaction, et le cours de déclenchement du stop-loss est supérieur au dernier cours de transaction.
Qu'est-ce que « Erreur d'interface : 50102 Requête horodatée expirée » ?
Cette erreur se produit lorsque le timestamp a expiré. Vous devez appeler l'interface de l'heure système ici pour synchroniser votre heure locale avec celle de notre serveur. Maintenir un écart de temps inférieur à 30 secondes peut aider à éviter ce problème.
Remarque : l'heure dans l'en-tête de la requête est en UTC0. Lors de l'appel à l'interface de l'heure du serveur, l'heure est fournie en UTC + 8.
Que signifie « Erreur d'interface : 50101 APIKey ne correspond pas à l'environnement actuel » ?
Cela est dû à une incompatibilité entre la clé API et l’environnement actuel. Les appels depuis un compte réel nécessitent l’utilisation de la clé API du compte réel, et la valeur du paramètre x-simulated-trading dans l’en-tête de la requête doit être 0. Les appels depuis un compte simulé nécessitent l’utilisation de la clé API du compte simulé, et la valeur du paramètre x-simulated-trading dans l’en-tête de la requête doit être 1.
Que signifie « Erreur d'interface : 51010 Requête non prise en charge dans le mode du compte actuel » ?
Cela concerne votre mode du compte. Si vous souhaitez placer un effet de levier ou un contrat sur une seule devise, vous devez passer à l'un des trois autres modes, à l'exception du mode de trading spot ! Vous pouvez le configurer via les paramètres de l'interface ici, ou vous pouvez le régler sur le site web ou l'application.
Remarque : le premier paramètre doit être configuré sur la page ou l'application ; option des paramètres dans le menu principal de la page de trading - mode du compte.
Qu'est-ce que « Erreur d'interface : 51121 La quantité de l'ordre doit être un multiple de la taille du lot » ?
Dans l'API, les ordres de contrat sont exprimés en unités de lots et doivent être un multiple de la quantité minimale d'ordre de la paire de devises. La quantité minimale d'ordre peut être obtenue via le champ minSz de l'interface produit ici.
"Erreur de retrait : 58207 L'adresse de retrait n'est pas sur la liste blanche pour l'exemption de vérification" ; pourquoi la vérification de la liste blanche signale-t-elle toujours une erreur alors qu'elle est désactivée sur la page de retrait ?
Pour retirer des jetons via l'interface API, il est nécessaire d'ajouter une adresse de retrait sur la page et de cocher le bouton non vérifié par Visa. Que la vérification de la liste blanche soit désactivée sur la page n'affectera pas la fonction de l'interface.
Que signifie « Erreur d'interface : délai d'attente de la requête du point de terminaison API 50004 » (cela ne signifie pas que la requête a réussi ou échoué, veuillez vérifier le résultat de la requête) ?
Le code 50004 est généralement causé par une surcharge du serveur. Les heures de 8h, 16h et 24h sont les moments de la journée où les frais de capital sont collectés. À ces moments, la pression sur le serveur est élevée. Il est recommandé d'échelonner les transactions à ces horaires. Si une erreur 50004 survient à d'autres moments, vous pouvez réessayer plus tard. Si un ordre est passé avec une erreur 50004, cela ne reflète pas le résultat réel de la requête d'interface. La requête peut réussir ou échouer. Veuillez vous référer au résultat réel.
Qu'est-ce que l'erreur « 50119 API key doesn’t exist » ?
Cette erreur se produit généralement lorsque le domaine de votre compte ne correspond pas à votre région.
Pour les utilisateurs de l'EEE, veuillez modifier le nom de domaine de votre requête API en eea.okx.com au lieu de www.okx.com.
Pour les utilisateurs américains, veuillez changer le nom de domaine de votre requête API en us.okx.com au lieu de www.okx.com.
Si vous utilisez un logiciel tiers pour vous connecter à OKX et que vous voyez cette erreur, veuillez vérifier auprès du fournisseur du logiciel s'il prend en charge les domaines régionaux. Par exemple, les utilisateurs de l'EEE doivent se connecter via eea.okx.com, sinon la requête échouera.
Pourquoi l'erreur « 50110 » s'affiche-t-elle lors de la liaison avec un logiciel tiers ?
Cette erreur peut survenir si le type actuel de clé API n'est pas compatible avec la liaison du logiciel tiers. Essayez de demander une clé API de type transaction, sans lier de liste d'IP, puis reconnectez le logiciel tiers.
Comment puis-je obtenir le dernier cours d'une certaine paire de devises ?
Utilisez les détails ici pour les symboles et pour un symbole, ici. L'interface des symboles est utilisée pour obtenir en lot le dernier cours des paires de devises, et le symbole est utilisé pour obtenir le dernier cours d'une paire de devises individuelle.
Exemple du paramètre de réponse du dernier cours tradé dans la section Symbole
Quelles sont les exigences pour créer une clé API ?
Un solde minimum d'actifs sous gestion (AUM) de 100 USD est requis pour créer une Clé API.
Un AUM supérieur à 100 USD (AUM > 100U) est requis pour créer une clé API
Pour les comptes principaux ou les sous-comptes, seuls les comptes avec un AUM > 100U sont autorisés à créer des clés API
Remarque : Cette exigence s'applique uniquement aux utilisateurs de certaines régions
Que dois-je faire si WebSocket ne peut pas se connecter ou se déconnecte constamment ?
Confirmez que vous utilisez l’URL WebSocket correcte pour votre site et votre service API. Vérifiez votre réseau, proxy, paramètres TLS, paramètres d’abonnement, le signal Ping/Pong et la logique de reconnexion. Si le problème persiste, fournissez le canal, l’heure d’occurrence, le message d’erreur complet et les journaux anonymisés.
Comment dois-je résoudre un code d'erreur API ou un paramètre de requête invalide ?
Consultez le code d'erreur dans la documentation officielle de l'API de votre site, puis vérifiez le point de terminaison, la méthode HTTP, les paramètres de la requête, le mode du compte et les restrictions du produit. Si la cause reste inconnue, fournissez le code d'erreur complet, sCode/sMsg, l'heure d'occurrence, ainsi que la requête et la réponse anonymisées.
Pourquoi la passation, la modification ou l'annulation de mon ordre via l'API a-t-elle échoué ?
Veuillez utiliser le message d'erreur et le code d'erreur renvoyés par l'API pour déterminer la cause spécifique. Si vous ne comprenez pas la signification de l'erreur, veuillez fournir les paramètres complets de la requête ainsi que les détails de l'erreur afin que nous puissions enquêter plus en détail.
Que dois-je faire si les données du marché, les chandeliers ou les données du carnet d’ordres semblent incorrects ?
Confirmez le nom du canal, instId, les paramètres d’abonnement et la fréquence des requêtes, et distinguez les données instantanées des mises à jour incrémentielles. Pour les carnets d’ordres, vérifiez également les ID de séquence et les horodatages. Si des données semblent manquer, enregistrez le canal, la plage horaire et la réponse brute expurgée.
Pourquoi les soldes, positions ou valeurs de marge de l'API diffèrent-ils de ceux du site web ou de l'application ?
Commencez par distinguer le compte de trading du compte de financement, puis vérifiez le mode du compte, la dimension de la devise, le point de terminaison et l'heure de mise à jour des données. Pour les calculs de solde, position et marge, utilisez la documentation la plus récente des produits et de l'API pour le site concerné.
Que dois-je faire si un dépôt, un retrait ou un transfert via API échoue ?
Vérifiez les autorisations API, la devise, le réseau, le compte de destination ainsi que les exigences relatives au carnet d’adresses ou à la liste blanche, puis dépannez en utilisant le code d’erreur retourné. Des restrictions liées à la sécurité du compte, à la conformité ou au risque peuvent nécessiter un examen supplémentaire par le support du site concerné.
Comment créer et utiliser une clé API pour un sous-compte ?
Créez la clé API sous le sous-compte prévu et utilisez les autorisations, la phrase secrète et le domaine du site de ce sous-compte. Ne mélangez pas la clé API, le secret ou la phrase secrète du compte principal avec ceux du sous-compte.
Que dois-je faire après avoir atteint une limite de fréquence API ?
Réduisez le taux de requêtes conformément à la limite spécifique à chaque point de terminaison, et utilisez des files d'attente de requêtes, un retour exponentiel en arrière ou des points de terminaison par lots lorsque cela est approprié. La portée et le quota de la limitation de débit peuvent varier selon le point de terminaison, ne supposez donc pas que tous les points de terminaison disposent de la même allocation.
Où puis-je trouver la documentation API, les SDK et des exemples de code ?
Vous pouvez consulter les docs API (V5). Référence REST + WebSocket, journal des modifications, codes d'erreur, exemples de requêtes/réponses par point de terminaison. SDK officiels (GitHub) — github.com/okxapi Un exemple de code est disponible dans le SDK.
Quelles informations dois-je fournir si je ne peux dire que « l’API ne fonctionne pas » ?
Fournissez le point de terminaison, la méthode HTTP, l'opération prévue, le code d'erreur complet ou le message, l'heure d'occurrence, le site du compte, l'environnement réseau, ainsi que la requête et la réponse anonymisées. N'envoyez jamais de Secret API, de phrase secrète, de code de vérification ou de signature non anonymisée.
Que dois-je faire si j'ai encore des questions sur l'API ? Ou puis-je discuter avec le service client API ?
Si vous avez d'autres questions, n'hésitez pas à rejoindre notre groupe de support API :
Que dois-je faire si l'API de trading en mode démo renvoie le code d'erreur 50123 ?
Le code d'erreur 50123 signifie que la clé API n'a pas la permission de trade crypto. Pour le trading en mode démo, utilisez une clé API créée sous trading en mode démo, assurez-vous que la clé a la permission Trade, utilisez le domaine API correct pour votre site, et incluez x-simulated-trading: 1 dans chaque requête de trading simulé. Une clé avec uniquement la permission Lecture peut récupérer les données du compte mais ne peut pas passer d'ordres.
Que dois-je faire si un ordre Demo Spot renvoie une erreur HTTP 503 et le code d'erreur OKX 50001 ?
Le code d'erreur 50001 avec HTTP 503 signifie que le service est temporairement indisponible. Veuillez réessayer plus tard. Si l'erreur persiste, rejoignez notre groupe de support API pour contacter le service client API.
Remarque :
Si vous avez des questions concernant WebSocket ou d'autres sujets liés à l'API, cliquez sur le lien de l'article et scannez le code QR en bas de l'article avec l'Appli OKX pour rejoindre le groupe et contacter notre spécialiste du support API.
Comment scanner : dans l'application, appuyez sur Menu > l'icône Scan, puis scannez le code QR.