API Coinbase

Coinbase

 

API supportate

• API WebSockets: si connette a un server websocket pubblico e fornisce aggiornamenti in tempo reale dei dati di mercato.
• REST API: Le REST API dispongono di endpoint per la gestione di account e ordini, nonché di dati di mercato pubblici.

 

 

Usi più comuni

• WebSockets API
  • Come connettersi all'API WebSocket
  • Come sottoscrivere un canale WebSocket

• REST API

  • Come Ottenere Dati di Mercato
  • Come Utilizzare la REST API Privata
  • Come Piazzare Ordini
  • Come Utilizzare un Account SandBox
  • Tempo per le Richieste Private

 

WebSockets API

Il feed WebSocket è disponibile pubblicamente e fornisce aggiornamenti di mercato in tempo reale per ordini e transazioni. In produzione sono supportati due endpoint:

 

• Market Data è il feed che fornisce aggiornamenti sia per gli ordini che per le transazioni. La maggior parte dei canali è ora disponibile senza autenticazione.
• User Order Data fornisce aggiornamenti sugli ordini dell'utente.

 

È possibile sottoscriversi ai seguenti canali:

 

Method	Argomenti	Description
SubscribeHeartBeat		Ping periodici del server per mantenere attive tutte le connessioni
SubscribeStatus	aProductId: id del prodotto	Invia tutti i prodotti e le valute a un intervallo prestabilito
SubscribeCandles	aProductId: id del prodotto	Aggiornamenti in tempo reale sui candlestick dei prodotti
SubscribeTicker	aProductId: id del prodotto	Aggiornamenti del prezzo in tempo reale ogni volta che avviene una corrispondenza
SubscribeTickerBatch	aProductId: id del prodotto	Aggiornamenti del prezzo in tempo reale ogni 5000 millisecondi
SubscribeLevel2	aProductId: id del prodotto	Tutti gli aggiornamenti e il modo più semplice per mantenere lo snapshot del libro degli ordini
SubscribeMarketTrades	aProductId: id del prodotto	Aggiornamenti in tempo reale ogni volta che avviene una transazione di mercato
SubscribeUser	aProductId: id del prodotto	Invia solo i messaggi che includono l'utente autenticato
SubscribeFuturesBalanceSummary		Aggiornamenti in tempo reale ogni volta che il saldo futures di un utente cambia

 

I canali User e FuturesBalanceSummary richiedono l'autenticazione; pertanto, richiedere prima le chiavi API nel proprio account Coinbase e quindi impostare i valori nella proprietà Coinbase del componente:

 

• ApiKey

• ApiSecret

 

L'autenticazione comporta una serie di vantaggi:

1. I messaggi in cui si è uno dei partecipanti sono espansi e contengono campi più utili
2. Si riceveranno messaggi privati, come informazioni sul ciclo di vita degli ordini stop inseriti

 

 

 

REST API

Endpoint privati

Gli endpoint privati sono disponibili per la gestione degli ordini e degli account.

Prima di poter firmare qualsiasi richiesta, deve creare una API key tramite il sito web di Coinbase Pro. La API key sarà associata a uno specifico profilo. Alla creazione di una chiave avrà 3 informazioni che deve ricordare:

 

• Chiave
• Segreto
• Passphrase

 

La chiave e il segreto saranno generati casualmente e forniti da Coinbase Pro; la passphrase sarà fornita dall'utente per proteggere ulteriormente l'accesso all'API. Coinbase Pro memorizza l'hash con salt della passphrase per la verifica, ma non può recuperarla in caso di smarrimento.

 

È possibile limitare la funzionalità delle chiavi API. Prima di creare la chiave, deve scegliere quali permessi desidera che la chiave abbia. I permessi sono:

 

• View - Concede a una chiave i permessi di lettura. Include tutti gli endpoint GET.
• Transfer - Consente a una chiave di trasferire valuta per conto di un account, inclusi depositi e prelievi. Abilitare con cautela - i trasferimenti tramite chiave API BYPASSERANNO l'autenticazione a due fattori.
• Trade - Consente a una chiave di inserire ordini, nonché di recuperare i dati di trading. Ciò include POST /orders e diversi endpoint GET.

 

Account

 

Method	Argomenti	Descrizione
ListAccounts		Ottieni un elenco di account di trading dal profilo della chiave API.
GetAccount	aAccountId: id dell'account	Informazioni per un singolo account. Utilizzi questo endpoint quando conosce l'account_id. La chiave API deve appartenere allo stesso profilo dell'account.

 

Ordini

 

Method	Argomenti	Descrizione
PlaceNewOrder	aOrder: classe che contiene tutti i campi possibili di un ordine	Inserisce un nuovo ordine. Da utilizzare solo se è necessario accedere alle opzioni avanzate degli ordini.
PlaceMarketOrder	aSide: buy o sell aProductId: id del prodotto aQuoteSize: La quantità del secondo asset nella coppia di trading. aBaseSize: La quantità del primo asset nella coppia di trading aClient_oid: ID ordine selezionato dall'utente per identificare il proprio ordine	Inserisce un nuovo ordine Market.
PlaceLimitOrder	aSide: buy o sell aProductId: id del prodotto aQuoteSize: La quantità del secondo Asset nella coppia di trading. aBaseSize: La quantità del primo Asset nella coppia di trading aLimitPrice: limite di prezzo Client_oid: ID ordine scelto dall'utente per identificare il proprio ordine	Inserisce un nuovo ordine Limit.
PlaceStopOrder	aSide: buy o sell ProductId: ID del prodotto aBaseSize: La quantità del primo Asset nella Trading Pair StopPrice: prezzo dello stop aLimitPrice: prezzo limite aStopDirection: perdita o ingresso Client_oid: ID dell'ordine scelto dall'utente per identificare il proprio ordine	Inserisce un nuovo ordine Stop
CancelOrder	aOrderId: id dell'ordine	Annulla un ordine inserito in precedenza. L'ordine deve appartenere al profilo a cui appartiene la chiave API.
EditOrder	aOrderId: id dell'ordine aPrice: prezzo aSize: Importo	Modifica un ordine con una nuova dimensione o un nuovo prezzo specificato
EditOrderPreview	aOrderId: id dell'ordine aPrice: prezzo aSize: Importo	Anteprima di una richiesta di modifica dell'ordine con una nuova dimensione o un nuovo prezzo specificati.
ListOrders		Ottieni un elenco di ordini filtrati per parametri di query opzionali (product_id, order_status, ecc.).
GetOrder	aOrderId: id dell'ordine	Ottiene un singolo ordine tramite l'ID dell'ordine.
PreviewOrder		Anteprima di un ordine.
ClosePosition	aOrderId: id dell'ordine aProductId: ID del prodotto aSize: quantità	Inserisce un ordine per chiudere qualsiasi posizione aperta per un product_id specificato.

 

 

 

 

Dati di mercato

 

Method	Argomenti	Descrizione
GetPublicProducts		Ottiene un elenco delle coppie di valute disponibili per il trading.
GetPublicProduct	aProductId: ID del prodotto	Ottieni informazioni su un singolo prodotto tramite ID prodotto.
GetPublicProductBook	aProductId: id del prodotto	Ottieni un elenco di offerte/richieste per un singolo prodotto. Il livello di dettaglio visualizzato può essere personalizzato con il parametro limit.
GetPublicProductCandles	aProductId: id del prodotto aStart: inizio dell'intervallo di tempo aEnd: fine dell'intervallo di tempo aGranularity: Il periodo temporale rappresentato da ogni candela.	Ottieni le tariffe per un singolo prodotto tramite ID prodotto, raggruppate in bucket.
GetTrades	aProductId: id del prodotto	Ottieni informazioni di snapshot per ID prodotto sugli ultimi trade (tick) e il miglior bid/ask.
GetTime		Ottieni l'ora corrente dall'API Coinbase Advanced.

 

 

Fills

 

Method	Argomenti	Descrizione
GetFillsByOrderId		Ottiene un elenco di fill filtrati per id dell'ordine
GetFillsByProductId		Ottieni un elenco di eseguiti filtrati per product id
GetFillsByTradeId		Ottieni un elenco di esecuzioni filtrate per ID transazione

Converti

Method	Argomenti	Descrizione
CreateConvertQuote		Crea un preventivo di conversione tra valute.
CommitConvertTrade		Conferma una transazione di conversione.
GetConvertTrade		Ottieni i dettagli della transazione di conversione.

Commissioni

Method	Argomenti	Descrizione
GetTransactionSummary		Ottieni il riepilogo delle commissioni di transazione.

Prodotti (autenticati)

Method	Argomenti	Descrizione
ListProducts		Elenca i prodotti disponibili.
GetProduct	aProductId: id del prodotto	Ottenere un prodotto specifico.
GetProductBook	aProductId: id del prodotto	Ottieni il libro degli ordini del prodotto.
GetProductCandles	aProductId: id del prodotto	Ottiene le candele OHLCV del prodotto.
GetMarketTrades	aProductId: id del prodotto	Ottieni le ultime operazioni di mercato.
GetBestBidAsk		Ottieni i migliori prezzi bid/ask.

Portfolios

Method	Argomenti	Descrizione
ListPortfolios		Elenca tutti i portafogli.
CreatePortfolio		Crea un nuovo portfolio.
DeletePortfolio		Elimina un portafoglio.
GetPortfolioBreakdown		Recupera i dettagli della ripartizione del portafoglio.
MovePortfolioFunds		Sposta fondi tra portafogli.

Perpetui

Method	Argomenti	Descrizione
GetPerpetualsPortfolioSummary		Recupera il riepilogo del portafoglio perpetuals.
ListPerpetualsPositions		Elenca le posizioni perpetue.
GetPerpetualsPosition		Ottieni una posizione perpetua specifica.