Que fait OKX CEX Portefeuille & Compte CLI ?
Solde du compte, positions, P&L, relevés, frais et transferts de fonds sur l'échange OKX. Nécessite des identifiants API.
Prérequis
- Installez la CLI
okx:npm install -g @okx_ai/okx-trade-cli - Configurez les identifiants :
Ou définissez les variables d'environnement :okx config initexport OKX_API_KEY=votre_cle export OKX_SECRET_KEY=votre_secret export OKX_PASSPHRASE=votre_passphrase - Testez avec le mode démo :
okx --profile demo account balance
Vérification des identifiants et du profil
Effectuez cette vérification avant toute commande authentifiée.
Étape A — Vérifier les identifiants
okx config show # vérifier l'état de la configuration (la sortie est masquée)
- Si la commande renvoie une erreur ou ne montre aucune configuration : arrêtez toutes les opérations, guidez l'utilisateur pour exécuter
okx config init, et attendez que la configuration soit terminée avant de réessayer. - Si les identifiants sont configurés : passez à l'étape B.
Étape B — Confirmer le profil (obligatoire)
--profile est obligatoire pour toutes les commandes authentifiées. N'ajoutez jamais de profil implicitement.
| Valeur | Mode | Fonds |
|---|---|---|
live | Réel | Fonds réels |
demo | Simulation | Fonds simulés |
Règles de résolution :
- L'intention du message actuel est claire (par ex. "réel" / "live" →
live; "test" / "simulation" / "demo" →demo) → utilisez-la et informez l'utilisateur :"Utilisation de --profile live (Réel)"ou"Utilisation de --profile demo (Simulation)" - Le message actuel n'a pas de déclaration explicite → vérifiez le contexte de la conversation pour un profil précédent :
- Trouvé → utilisez-le, informez l'utilisateur :
"Suite avec --profile live (Réel) de tout à l'heure" - Non trouvé → demandez :
"Réel (live) ou Simulation (demo) ?"— attendez la réponse avant de continuer
- Trouvé → utilisez-le, informez l'utilisateur :
Gestion des erreurs d'authentification 401
Si une commande renvoie une erreur 401 / d'authentification :
- Arrêtez immédiatement — ne réessayez pas la même commande
- Informez l'utilisateur : "L'authentification a échoué (401). Vos identifiants API sont peut-être invalides ou expirés."
- Guidez l'utilisateur pour mettre à jour les identifiants en modifiant directement le fichier avec son éditeur local :
Mettez à jour les champs~/.okx/config.tomlapi_key,secret_key,passphrasesous le profil concerné. Ne collez PAS les nouveaux identifiants dans le chat. - Une fois que l'utilisateur confirme que le fichier est mis à jour, exécutez
okx config showpour vérifier (la sortie est masquée) - Alors seulement, réessayez l'opération d'origine
Mode Démo vs Réel
Le profil est le seul contrôle pour basculer entre modes réel et simulation — exactement deux options :
--profile | Mode | Fonds |
|---|---|---|
live | Réel | Fonds réels |
demo | Simulation | Fonds simulés |
okx --profile live account balance # Réel
okx --profile demo account balance # Simulation (solde simulé)
Règles :
- Commandes de lecture (solde, positions, relevés, etc.) : indiquez toujours quel profil a été utilisé
- Commandes d'écriture (
transfer,set-position-mode) : le profil doit être confirmé avant l'exécution (voir "Vérification des identifiants et du profil" Étape B) ; le transfert surtout — un mauvais profil signifie un mauvais compte - Chaque réponse après une commande doit ajouter :
[profile: live]ou[profile: demo] - N'utilisez pas le drapeau
--demo— utilisez--profileà la place
Routage des compétences
- Pour les données de marché (prix, graphiques, profondeur, taux de financement) → utilisez
okx-cex-market - Pour le solde du compte, P&L, positions, frais, transferts → utilisez
okx-cex-portfolio(cette compétence) - Pour les ordres spot/swap/futures/algo classiques → utilisez
okx-cex-trade - Pour les robots de trading grid et DCA → utilisez
okx-cex-bot
Démarrage rapide
# Solde du compte de trading (toutes les devises avec solde > 0)
okx account balance
# Vérifier le solde USDT uniquement
okx account balance USDT
# Solde du compte de financement
okx account asset-balance
# Toutes les positions ouvertes
okx account positions
# Historique des positions fermées avec P&L réalisé
okx account positions-history
# Relevés de compte récents (100 derniers)
okx account bills
# Mon niveau de frais de trading
okx account fees --instType SPOT
# Transférer 100 USDT du financement (18) vers le trading (6)
okx account transfer --ccy USDT --amt 100 --from 18 --to 6
Index des commandes
Commandes de lecture
| # | Commande | Type | Description |
|---|---|---|---|
| 1 | okx account balance [ccy] | LECTURE | Capitaux propres, disponibles, gelés du compte de trading |
| 2 | okx account asset-balance [ccy] | LECTURE | Solde du compte de financement |
| 3 | okx account positions | LECTURE | Positions ouvertes sur contrats/swap |
| 4 | okx account positions-history | LECTURE | Positions fermées + P&L réalisé |
| 5 | okx account bills | LECTURE | Grand livre du compte (dépôts, retraits, transactions) |
| 6 | okx account fees --instType <type> | LECTURE | Mon niveau de frais de trading (maker/taker) |
| 7 | okx account config | LECTURE | Niveau du compte, mode de position, UID |
| 8 | okx account max-size --instId <id> --tdMode <mode> | LECTURE | Taille max d'achat/vente au prix actuel |
| 9 | okx account max-avail-size --instId <id> --tdMode <mode> | LECTURE | Taille disponible pour la prochaine commande |
| 10 | okx account max-withdrawal [ccy] | LECTURE | Montant retirable maximum par devise |
Commandes d'écriture
| # | Commande | Type | Description |
|---|---|---|---|
| 11 | okx account set-position-mode <mode> | ÉCRITURE | Basculer entre le mode de position net/hedge |
| 12 | okx account transfer | ÉCRITURE | Transférer des fonds entre les comptes |
Workflows inter-compétences
Vérification du solde avant trading
Utilisateur : "Je veux acheter 0,1 BTC — est-ce que j'ai assez d'USDT ?"
1. okx-cex-portfolio okx account balance USDT → vérifier les capitaux propres disponibles
2. okx-cex-market okx market ticker BTC-USDT → vérifier le prix actuel
↓ l'utilisateur approuve
3. okx-cex-trade okx spot place --instId BTC-USDT --side buy --ordType market --sz 0.1
Vérification du solde avant bot
Utilisateur : "Je veux démarrer un bot grid BTC avec 1000 USDT"
1. okx-cex-portfolio okx account balance USDT → confirmer que les fonds disponibles ≥ 1000
2. okx-cex-market okx market candles BTC-USDT --bar 4H --limit 50 → déterminer la fourchette de prix
↓ l'utilisateur approuve
3. okx-cex-bot okx bot grid create --instId BTC-USDT --algoOrdType grid \
--minPx 90000 --maxPx 100000 --gridNum 10 --quoteSz 1000
Examiner les positions ouvertes et le P&L
Utilisateur : "Montre-moi mes positions actuelles et comment elles se portent"
1. okx-cex-portfolio okx account positions → positions ouvertes avec P&L non réalisé
2. okx-cex-portfolio okx account positions-history → positions fermées récemment
3. okx-cex-market okx market ticker BTC-USDT-SWAP → vérifier le prix actuel par rapport à l'entrée
Transfert et trading
Utilisateur : "Déplace 500 USDT de mon compte de financement pour trader du BTC"
1. okx-cex-portfolio okx account asset-balance USDT → confirmer que le solde de financement ≥ 500
↓ l'utilisateur approuve
2. okx-cex-portfolio okx account transfer --ccy USDT --amt 500 --from 18 --to 6
3. okx-cex-portfolio okx account balance USDT → confirmer que le solde de trading est mis à jour
↓ prêt à trader
4. okx-cex-trade okx spot place ...
Vérifier la taille de position maximale avant d'entrer
Utilisateur : "Combien de BTC puis-je acheter avec une marge croisée ?"
1. okx-cex-portfolio okx account balance → capitaux propres totaux
2. okx-cex-portfolio okx account max-size --instId BTC-USDT-SWAP --tdMode cross → taille max d'achat/vente
3. okx-cex-market okx market ticker BTC-USDT-SWAP → référence de prix actuelle
Flux d'opération
Étape 0 — Vérification des identifiants et du profil
Avant toute commande authentifiée :
Déterminer le profil (obligatoire) :
- Options :
live(Réel) oudemo(Simulation) — exactement ces deux valeurs
- L'intention du message actuel est claire (par ex. "réel"/"live" → live ; "test"/"simulation"/"demo" → demo) → utilisez-la, informez l'utilisateur :
"Utilisation de --profile live (Réel)" - Le message actuel n'a pas de déclaration explicite → vérifiez le contexte de la conversation pour un profil précédent :
- Trouvé → utilisez-le, informez l'utilisateur :
"Suite avec --profile live (Réel) de tout à l'heure" - Non trouvé → demandez :
"Réel (live) ou Simulation (demo) ?"— attendez la réponse
- Trouvé → utilisez-le, informez l'utilisateur :
Si aucun identifiant n'est configuré : guidez l'utilisateur pour exécuter okx config init, arrêtez toutes les actions de trading
Après chaque résultat de commande : ajoutez [profile: live] ou [profile: demo] à la réponse
Étape 1 : Identifier l'action du compte
- Vérifier le solde →
okx account balance(trading) ouokx account asset-balance(financement) - Voir les positions ouvertes →
okx account positions - Voir les positions fermées + P&L →
okx account positions-history - Voir l'historique des transactions →
okx account bills - Vérifier le niveau de frais →
okx account fees - Vérifier les paramètres du compte →
okx account config - Calculer la taille d'ordre →
okx account max-sizeouokx account max-avail-size - Vérifier la limite de retrait →
okx account max-withdrawal - Transférer des fonds →
okx account transfer - Changer le mode de position →
okx account set-position-mode
Étape 2 : Exécuter les commandes de lecture immédiatement — confirmer le profil (Étape 0) puis les écritures
Commandes de lecture (1–10) : exécutez immédiatement, aucune confirmation nécessaire.
- Filtre
ccy: utilisez le symbole de la devise commeUSDT,BTC,ETH --instTypepour les frais/positions :SPOT,SWAP,FUTURES,OPTION--archivepour les relevés : accédez aux enregistrements plus anciens au-delà de la fenêtre par défaut--tdModepour max-size :cash(spot),cross, ouisolated
Commandes d'écriture (11–12) : confirmez une fois avant d'exécuter.
set-position-mode: confirmez le mode (net= unidirectionnel,long_short_mode= mode couverture) ; le changement peut affecter les positions ouvertestransfer: confirmez--ccy,--amt,--from,--to(types de compte :6=trading,18=financement) ; vérifiez d'abord le solde source
Étape 3 : Vérifier après les écritures
- Après
set-position-mode: exécutezokx account configpour confirmer queposModeest mis à jour - Après
transfer: exécutezokx account balanceetokx account asset-balancepour confirmer que les soldes sont mis à jour
Référence des commandes CLI
Solde du compte — Compte de trading
okx account balance [ccy] [--json]
| Paramètre | Requis | Défaut | Description |
|---|---|---|---|
ccy | Non | - | Filtrer pour une seule devise (par ex., USDT) |
Renvoie un tableau : currency, equity, available, frozen. N'affiche que les devises avec un solde > 0.
Solde des actifs — Compte de financement
okx account asset-balance [ccy] [--json]
| Paramètre | Requis | Défaut | Description |
|---|---|---|---|
ccy | Non | - | Filtrer pour une seule devise |
Renvoie : ccy, bal, availBal, frozenBal. N'affiche que les devises avec un solde > 0.
Positions — Positions ouvertes
okx account positions [--instType <type>] [--instId <id>] [--json]
| Paramètre | Requis | Défaut | Description |
|---|---|---|---|
--instType | Non | - | Filtre : SWAP, FUTURES, OPTION |
--instId | Non | - | Filtrer pour un instrument spécifique |
Renvoie : instId, instType, side (posSide), pos, avgPx, upl (P&L non réalisé), lever. N'affiche que les positions avec une taille ≠ 0.
Historique des positions — Positions fermées
okx account positions-history [--instType <type>] [--instId <id>] [--limit <n>] [--json]
Renvoie : instId, direction, openAvgPx, closeAvgPx, realizedPnl, uTime.
Relevés — Grand livre du compte
okx account bills [--archive] [--instType <type>] [--ccy <ccy>] [--limit <n>] [--json]
| Paramètre | Requis | Défaut | Description |
|---|---|---|---|
--archive | Non | false | Accéder aux enregistrements plus anciens (point de terminaison archive) |
--instType | Non | - | Filtrer par type d'instrument |
--ccy | Non | - | Filtrer par devise |
--limit | Non | 100 | Nombre d'enregistrements |
Renvoie : billId, instId, type, ccy, balChg, bal, ts.
Frais — Niveau de frais de trading
okx account fees --instType <type> [--instId <id>] [--json]
| Paramètre | Requis | Défaut | Description |
|---|---|---|---|
--instType | Oui | - | SPOT, SWAP, FUTURES, OPTION |
--instId | Non | - | Instrument spécifique (optionnel) |
Renvoie : level, maker, taker, makerU, takerU, ts.
Config — Configuration du compte
okx account config [--json]
Renvoie : uid, acctLv (niveau du compte), posMode (net/long_short_mode), autoLoan, greeksType, level, levelTmp.
Taille maximale — Taille d'ordre maximale
okx account max-size --instId <id> --tdMode <mode> [--px <price>] [--json]
| Paramètre | Requis | Défaut | Description |
|---|---|---|---|
--instId | Oui | - | ID de l'instrument |
--tdMode | Oui | - | cash (spot), cross, ou isolated |
--px | Non | - | Prix de référence (utilise le prix de marque si omis) |
Renvoie : instId, maxBuy, maxSell.
Taille disponible maximale
okx account max-avail-size --instId <id> --tdMode <mode> [--json]
Renvoie : instId, availBuy, availSell — la taille immédiatement disponible pour la prochaine commande.
Retrait maximum
okx account max-withdrawal [ccy] [--json]
Renvoie un tableau : ccy, maxWd, maxWdEx (avec emprunt). Affiche toutes les devises si aucun filtre n'est fourni.
Définir le mode de position
okx account set-position-mode <net|long_short_mode> [--json]
| Valeur | Comportement |
|---|---|
net | Unidirectionnel (par défaut) — les positions longues et courtes s'annulent |
long_short_mode | Mode couverture — les positions longues et courtes peuvent coexister |
Avertissement : Changer de mode lorsque des positions sont ouvertes peut entraîner un comportement inattendu. Vérifiez d'abord
okx account positions.
Transférer des fonds
okx account transfer --ccy <ccy> --amt <n> --from <acctType> --to <acctType> \
[--transferType <type>] [--subAcct <name>] [--json]
| Paramètre | Requis | Défaut | Description |
|---|---|---|---|
--ccy | Oui | - | Devise à transférer (par ex., USDT) |
--amt | Oui | - | Montant à transférer |
--from | Oui | - | Type de compte source : 6=trading, 18=financement |
--to | Oui | - | Type de compte de destination : 6=trading, 18=financement |
--transferType | Non | 0 | 0=au sein du compte, 1=vers un sous-compte, 2=depuis un sous-compte |
--subAcct | Non | - | Nom du sous-compte (obligatoire pour les transferts vers/depuis un sous-compte) |
Renvoie : transId, ccy, amt.
Référence des outils MCP
| Outil | Description |
|---|---|
account_get_balance | Solde du compte de trading |
account_get_asset_balance | Solde du compte de financement |
account_get_positions | Positions ouvertes |
account_get_positions_history | Historique des positions fermées |
account_get_bills | Relevés de compte |
account_get_fees | Niveau de frais de trading |
account_get_config | Configuration du compte |
account_get_max_size | Taille d'ordre maximale |
account_get_max_avail_size | Taille disponible maximale |
account_get_max_withdrawal | Montant retirable maximum |
account_set_position_mode | Définir le mode de position |
account_transfer | Transférer des fonds |
account_config_show | Afficher la configuration |