API Coinbase

APIs suportadas

WebSockets API: conecta a um servidor websocket público e fornece atualizações de dados de mercado em tempo real.
REST API: A REST API tem endpoints para gerenciamento de conta e de ordens, bem como dados de mercado públicos.

Most common uses

WebSockets API
- Como Conectar à WebSocket API
- Como Assinar um Canal WebSocket

REST API

WebSockets API

O feed WebSocket está disponível publicamente e fornece atualizações de dados de mercado em tempo real para ordens e trades. Dois endpoints são suportados em produção:

Market Data é o feed que fornece atualizações tanto para ordens quanto para negociações. A maioria dos canais agora está disponível sem autenticação.
User Order Data fornece atualizações para as ordens do usuário.

Você pode se inscrever nos seguintes canais:

Method	Arguments	Descrição
SubscribeHeartBeat		Pings do servidor em tempo real para manter todas as conexões abertas
SubscribeStatus	aProductId: id do produto	Envia todos os produtos e moedas em um intervalo predefinido
SubscribeCandles	aProductId: id do produto	Atualizações em tempo real sobre product candles
SubscribeTicker	aProductId: id do produto	Atualizações de preço em tempo real toda vez que ocorre um match
SubscribeTickerBatch	aProductId: id do produto	Atualizações de preço em tempo real a cada 5000 milissegundos
SubscribeLevel2	aProductId: id do produto	Todas as atualizações e a maneira mais fácil de manter o snapshot do order book
SubscribeMarketTrades	aProductId: id do produto	Atualizações em tempo real cada vez que um trade de mercado acontece
SubscribeUser	aProductId: id do produto	Envia apenas mensagens que incluem o usuário autenticado
SubscribeFuturesBalanceSummary		Atualizações em tempo real toda vez que o saldo de futuros de um usuário muda

Os canais User e FuturesBalanceSummary requerem autenticação, portanto primeiro solicite suas API keys em sua conta Coinbase e então defina os valores na propriedade Coinbase do componente:

ApiKey
ApiSecret

A autenticação resultará em alguns benefícios:

As mensagens em que você é uma das partes são expandidas e têm campos mais úteis
Você receberá mensagens privadas, como informações de ciclo de vida sobre as ordens stop que você colocou

REST API

Private Endpoints

Endpoints privados estão disponíveis para gerenciamento de ordens e gerenciamento de conta.

Antes de poder assinar qualquer requisição, você deve criar uma chave de API através do site da Coinbase Pro. A chave de API estará vinculada a um perfil específico. Ao criar uma chave, você terá 3 informações que deve lembrar:

Key
Secret
Passphrase

A Key e o Secret serão gerados aleatoriamente e fornecidos pela Coinbase Pro; a Passphrase será fornecida por você para proteger ainda mais seu acesso à API. A Coinbase Pro armazena o hash com salt da sua passphrase para verificação, mas não pode recuperar a passphrase se você a esquecer.

Você pode restringir a funcionalidade das chaves de API. Antes de criar a chave, você deve escolher quais permissões gostaria que a chave tivesse. As permissões são:

View - Permite a uma chave permissões de leitura. Isso inclui todos os endpoints GET.
Transfer - Permite que uma chave transfira moeda em nome de uma conta, incluindo depósitos e saques. Habilite com cautela - as transferências por API key IGNORARÃO a autenticação de dois fatores.
Trade - Permite que uma chave registre ordens, bem como recupere dados de negociação. Isso inclui POST /orders e vários endpoints GET.

Accounts

Method	Arguments	Descrição
ListAccounts		Obtém uma lista de contas de negociação a partir do perfil da chave de API.
GetAccount	aAccountId: id da conta	Informações de uma única conta. Utilize este endpoint quando você souber o account_id. A chave de API deve pertencer ao mesmo perfil que a conta.

Orders

Method	Arguments	Descrição
PlaceNewOrder	aOrder: classe que contém todos os campos possíveis de uma ordem	Coloca uma nova ordem. Utilize apenas se você precisar acessar opções avançadas de ordem.
PlaceMarketOrder	aSide: buy ou sell aProductId: id do produto aQuoteSize: A quantidade do segundo Asset no Trading Pair. aBaseSize: A quantidade do primeiro Asset no Trading Pair aClient_oid: ID da Ordem selecionado por você para identificar sua ordem	Coloca uma nova ordem a Mercado.
PlaceLimitOrder	aSide: buy ou sell aProductId: id do produto aQuoteSize: A quantidade do segundo Asset no Trading Pair. aBaseSize: A quantidade do primeiro Asset no Trading Pair aLimitPrice: limite de preço Client_oid: Order ID selecionado por você para identificar sua ordem	Coloca uma nova ordem Limit.
PlaceStopOrder	aSide: buy ou sell ProductId: id do produto aBaseSize: A quantidade do primeiro Ativo no Par de Negociação StopPrice: preço do stop aLimitPrice: limite de preço aStopDirection: loss ou entry Client_oid: Order ID selecionado por você para identificar sua ordem	Coloca uma nova Stop Order
CancelOrder	aOrderId: id da ordem	Cancela uma ordem previamente colocada. A ordem deve pertencer ao profile ao qual a chave de API pertence.
EditOrder	aOrderId: id da ordem aPrice: preço aSize: Quantidade	Edita uma ordem com um novo tamanho especificado ou um novo preço
EditOrderPreview	aOrderId: id da ordem aPrice: preço aSize: Quantidade	Faz uma prévia de uma requisição de edição de ordem com um novo tamanho ou um novo preço especificado.
ListOrders		Obtém uma lista de ordens filtradas por parâmetros de query opcionais (product_id, order_status, etc).
GetOrder	aOrderId: id da ordem	Obter uma única ordem pelo ID da ordem.
PreviewOrder		Pré-visualiza uma ordem.
ClosePosition	aOrderId: id da ordem aProductId: id do produto aSize: quantidade	Coloca uma ordem para fechar quaisquer posições abertas de um product_id especificado.

Market Data

Method	Arguments	Descrição
GetPublicProducts		Obter uma lista dos pares de moedas disponíveis para negociação.
GetPublicProduct	aProductId: id do produto	Obtém informações sobre um único produto pelo product ID.
GetPublicProductBook	aProductId: id do produto	Obtém uma lista de bids/asks para um único produto. O nível de detalhe exibido pode ser personalizado com o parâmetro limit.
GetPublicProductCandles	aProductId: id do produto aStart: início do intervalo de tempo aEnd: fim do intervalo de tempo aGranularity: O timeframe que cada candle representa.	Obtém as taxas de um único produto pelo ID do produto, agrupadas em buckets.
GetTrades	aProductId: id do produto	Obtém informações de snapshot por ID de produto sobre as últimas negociações (ticks) e o melhor bid/ask.
GetTime		Obtém o horário atual da Coinbase Advanced API.

Fills

Method	Arguments	Descrição
GetFillsByOrderId		Obter uma lista de fills filtrada por id de ordem
GetFillsByProductId		Obtém uma lista de fills filtrados por product id
GetFillsByTradeId		Obtém uma lista de fills filtrada por trade id

Convert

Method	Arguments	Descrição
CreateConvertQuote		Cria uma cotação de conversão entre moedas.
CommitConvertTrade		Confirma uma negociação de conversão.
GetConvertTrade		Obtém os detalhes do trade de conversão.

Fees

Method	Arguments	Descrição
GetTransactionSummary		Obtém o resumo das taxas de transação.

Products (Autenticado)

Method	Arguments	Descrição
ListProducts		Lista os produtos disponíveis.
GetProduct	aProductId: id do produto	Obtém um produto específico.
GetProductBook	aProductId: id do produto	Obtém o order book do produto.
GetProductCandles	aProductId: id do produto	Obter candles OHLCV do produto.
GetMarketTrades	aProductId: id do produto	Obtém negociações recentes do mercado.
GetBestBidAsk		Obtém os melhores preços de bid/ask.

Portfolios

Method	Arguments	Descrição
ListPortfolios		Lista todos os portfólios.
CreatePortfolio		Criar um novo portfólio.
DeletePortfolio		Excluir um portfólio.
GetPortfolioBreakdown		Obtém os detalhes do breakdown do portfólio.
MovePortfolioFunds		Move fundos entre portfólios.

Perpetuals

Method	Arguments	Descrição
GetPerpetualsPortfolioSummary		Obtém o resumo do portfólio de perpétuos.
ListPerpetualsPositions		Lista posições de perpétuos.
GetPerpetualsPosition		Obtém uma posição específica de perpétuos.