REST API
Le flux WebSocket est accessible publiquement et fournit des mises à jour de données de marché en temps réel pour les ordres et les trades. Deux points de terminaison sont pris en charge en production :
Vous pouvez vous abonner aux canaux suivants :
| Méthode | Arguments | Description |
| SubscribeHeartBeat | Pings serveur en temps réel pour maintenir toutes les connexions ouvertes | |
| SubscribeStatus | aProductId : identifiant du produit | Envoie tous les produits et devises à un intervalle prédéfini |
| SubscribeCandles | aProductId : identifiant du produit | Mises à jour en temps réel des bougies de produit |
| SubscribeTicker | aProductId : identifiant du produit | Mises à jour de prix en temps réel à chaque correspondance |
| SubscribeTickerBatch | aProductId : identifiant du produit | Mises à jour des prix en temps réel toutes les 5000 millisecondes |
| SubscribeLevel2 | aProductId : identifiant du produit | Toutes les mises à jour et moyen le plus simple de maintenir l'instantané du carnet d'ordres |
| SubscribeMarketTrades | aProductId : identifiant du produit | Mises à jour en temps réel à chaque transaction de marché |
| SubscribeUser | aProductId : identifiant du produit | Envoie uniquement les messages qui incluent l'utilisateur authentifié |
| SubscribeFuturesBalanceSummary | Mises à jour en temps réel chaque fois que le solde futures d'un utilisateur change |
Les canaux User et FuturesBalanceSummary nécessitent une authentification, commencez donc par demander vos clés API dans votre compte Coinbase puis définissez les valeurs dans la propriété Coinbase du composant :
ApiKey
ApiSecret
L'authentification apporte plusieurs avantages :
Des endpoints privés sont disponibles pour la gestion des ordres et la gestion des comptes.
Avant de pouvoir signer des requêtes, vous devez créer une clé API via le site web Coinbase Pro. La clé API sera limitée à un profil spécifique. Lors de la création d'une clé, vous aurez 3 informations à mémoriser :
La clé et le secret seront générés aléatoirement et fournis par Coinbase Pro ; la Passphrase sera fournie par vous pour sécuriser davantage votre accès API. Coinbase Pro stocke le hachage salé de votre passphrase pour la vérification, mais ne peut pas la récupérer si vous l'oubliez.
Vous pouvez restreindre les fonctionnalités des clés API. Avant de créer la clé, vous devez choisir les permissions que vous souhaitez lui attribuer. Les permissions sont :
Comptes
| Méthode | Arguments | Description |
| ListAccounts | Obtenir une liste des comptes de trading du profil de la clé API. | |
| GetAccount | aAccountId : identifiant du compte | Informations pour un seul compte. Utilisez ce point de terminaison lorsque vous connaissez l'account_id. La clé API doit appartenir au même profil que le compte. |
Ordres
| Méthode | Arguments | Description |
| PlaceNewOrder | aOrder : classe qui contient tous les champs possibles d'un ordre | Passe un nouvel ordre. N'utilisez cette méthode que si vous avez besoin d'accéder aux options d'ordre avancées. |
| PlaceMarketOrder |
aSide : buy ou sell aProductId : identifiant du produit aQuoteSize : Le montant du deuxième actif dans la paire de trading. aBaseSize : La quantité du premier actif dans la paire de trading aClient_oid : Identifiant d'ordre que vous avez choisi pour identifier votre ordre |
Place un nouvel ordre au marché. |
| PlaceLimitOrder |
aSide : buy ou sell aProductId : identifiant du produit aQuoteSize : Le montant du deuxième actif dans la paire de trading. aBaseSize : La quantité du premier actif dans la paire de trading
aLimitPrice : limite de prix Client_oid : Identifiant d'ordre sélectionné par vous pour identifier votre ordre |
Place un nouvel ordre Limit. |
| PlaceStopOrder |
aSide : buy ou sell ProductId : identifiant du produit aBaseSize : La quantité du premier actif dans la paire de trading StopPrice : prix du stop aLimitPrice : prix limite aStopDirection : perte ou entrée Client_oid : Identifiant d'ordre que vous choisissez pour identifier votre ordre |
Place un nouvel ordre Stop |
| CancelOrder | aOrderId : identifiant de la commande | Annuler un ordre précédemment placé. L'ordre doit appartenir au profil auquel appartient la clé API. |
| EditOrder |
aOrderId : identifiant de la commande aPrice : prix aSize : Montant |
Modifier un ordre avec une nouvelle taille ou un nouveau prix spécifié |
| EditOrderPreview |
aOrderId : identifiant de la commande aPrice : prix aSize : Montant |
Prévisualiser une demande de modification d'ordre avec une nouvelle taille ou un nouveau prix spécifié. |
| ListOrders | Obtenir une liste des ordres filtrés par des paramètres de requête optionnels (product_id, order_status, etc.). | |
| GetOrder | aOrderId : identifiant de la commande | Obtenir un seul ordre par identifiant d'ordre. |
| PreviewOrder | Aperçu d'un ordre. | |
| ClosePosition |
aOrderId : identifiant de la commande aProductId : identifiant du produit aSize : montant |
Place un ordre pour clôturer toutes les positions ouvertes pour un product_id spécifié. |
Données de marché
| Méthode | Arguments | Description |
| GetPublicProducts | Obtenir une liste des paires de devises disponibles pour le trading. | |
| GetPublicProduct |
aProductId : identifiant du produit |
Obtenir des informations sur un seul produit par son identifiant de produit. |
| GetPublicProductBook | aProductId : identifiant du produit | Obtenir la liste des offres/demandes pour un seul produit. Le niveau de détail affiché peut être personnalisé avec le paramètre de limite. |
| GetPublicProductCandles |
aProductId : identifiant du produit aStart : début de l'intervalle de temps aEnd : fin de l'intervalle de temps aGranularity : L'intervalle de temps que représente chaque chandelier. |
Obtenir les taux pour un seul produit par identifiant de produit, regroupés en buckets. |
| GetTrades | aProductId : identifiant du produit | Obtenir des informations instantanées par identifiant de produit sur les dernières transactions (ticks) et la meilleure offre/demande. |
| GetTime |
|
Obtenir l'heure actuelle depuis l'API Coinbase Advanced. |
Remplissages
| Méthode | Arguments | Description |
| GetFillsByOrderId | Obtenir une liste de transactions filtrées par identifiant d'ordre | |
| GetFillsByProductId |
|
Obtenir une liste de transactions filtrées par identifiant de produit |
| GetFillsByTradeId | Obtenir une liste de remplissages filtrés par identifiant de transaction |
Convertir
| Méthode | Arguments | Description |
| CreateConvertQuote | Créer un devis de conversion entre devises. | |
| CommitConvertTrade | Valider un trade de conversion. | |
| GetConvertTrade | Obtenir les détails d'une opération de conversion. |
Frais
| Méthode | Arguments | Description |
| GetTransactionSummary | Obtenir un résumé des frais de transaction. |
Produits (authentifiés)
| Méthode | Arguments | Description |
| ListProducts | Lister les produits disponibles. | |
| GetProduct | aProductId : identifiant du produit | Obtenir un produit spécifique. |
| GetProductBook | aProductId : identifiant du produit | Obtenir le carnet d'ordres du produit. |
| GetProductCandles | aProductId : identifiant du produit | Obtenir les bougies OHLCV du produit. |
| GetMarketTrades | aProductId : identifiant du produit | Obtenir les transactions récentes du marché. |
| GetBestBidAsk | Obtenir les meilleurs prix bid/ask. |
Portefeuilles
| Méthode | Arguments | Description |
| ListPortfolios | Lister tous les portefeuilles. | |
| CreatePortfolio | Créer un nouveau portefeuille. | |
| DeletePortfolio | Supprimer un portefeuille. | |
| GetPortfolioBreakdown | Obtenir les détails du portefeuille. | |
| MovePortfolioFunds | Déplacer des fonds entre des portefeuilles. |
Perpétuels
| Méthode | Arguments | Description |
| GetPerpetualsPortfolioSummary | Obtenir le résumé du portefeuille de perpétuels. | |
| ListPerpetualsPositions | Lister les positions perpétuelles. | |
| GetPerpetualsPosition | Obtenir une position de contrat perpétuel spécifique. |