Por favor habilite o JavaScript / Please enable JavaScript.

API de Dados

Introdução

Essa referência da API inclui a documentação técnica necessária para formular/padronizar o desfecho das APIs de uma exchange. Abaixo estão descritos os requisitos recomendados e obrigatórios - por favor verifique com atenção. Exchanges devem suportar minimamente os requisitos obrigatórios estabelecidos abaixo, juntamente aos dados obrigatórios de integração dos mesmo.

Os requisitos públicos GET têm a intenção de possibilitar o acesso à dados de mercado. O retorno de endpoints resultam no formato JSON. Referenciado no /assets e /ticker endpoints são IDs de Cripto-ativos unificados (Unified Cryptoasset ID - UCID).


Padrões e Convenções

  • Nenhuma autenticação de API necessária em endpoints no mercado.
  • Consultas de mercado completas disponíveis a cada every 60 segundos.
  • Informações disponíveis em formato JSON.
  • Se aplicável, colocar o nível de segurança do Cloudflare em OFF para os endpoints da API. Veja esse artigo sobre Cloudlfare Support para mais informações.
  • Versionamento necessário para evitar mudanças (api/v1/asset, api/v2/asset, etc.)
  • Conteúdo da codificação: gzip suportado para optimizar a transferência de dados.
  • Nenhuma região de endpoint bloqueado da API ou lista de permissão do endereço de IP necessários.

Visão Geral do Endpoint

Nome Categoria Status Descrição
Sumário do Endpoint Sumário Obrigatório Visão geral dos dados de mercado para todos os tickers
Endpoint 1 /asset Recomendado Detalhes aprofundados das criptomoedas disponíveis na exchange.
Endpoint 2 /ticker Obrigatório Estatística de 24 horas da variação de preço para todos os mercados.
Endpoint 3 /orderbook Obrigatório Abrangência de mercado de um par de trade. Uma lista com o conjunto de preços solicitados e outra com os preços oferecidos. Consulta para o order book nível 2 com a abrangência completa como requisito mínimo.
Endpoint 4 /trades Obrigatório Trades completos recentemente em um mercado específico. Histórico de 24 horas com os trades disponíveis completos como requisito mínimo.

ENDPOINT 1

ASSETS /assets

O endpoint do ativo é para fornecer um sumário detalhado para cada moeda disponível na exchange.

https://exchange.intertradec.com.br/api/public/assets

                                {  
                                   "BTC":{  
                                      "name":"bitcoin",
                                      "unified_cryptoasset_id" :"1",
                                      "can_withdraw":"true",
                                      "can_deposit":"true",
                                      "min_withdraw":"0.01",
                                      "max_withdraw ":"100" 
                                      "name":"bitcoin",
                                      "maker_fee":"0.01",
                                      "taker_fee":"0.01",
                                   },
                                   "ETH":{  
                                      "name":"ethereum",
                                      "unified_cryptoasset_id":"1027",
                                      "can_withdraw":"false",
                                      "can_deposit":"false",
                                      "min_withdraw":"10.00",
                                      "max_withdraw ":"0.00" 
                                      "maker_fee":"0.01",
                                      "taker_fee":"0.01",
                                   }
                                }
                                
                            

Nome Cadeia Recomendação Nome da Criptomoeda
unified_cryptoasset_id Integral Obrigatório ID única da criptomoeda atribuído pelo Unified Cryptoasset ID.
can_withdraw Boolean Recomendado Identifica se saques estão habilitados ou desabilitados.
can_deposit Boolean Recomendado Identifica se depósitos estão habilitados ou desabilitados.
min_withdraw Decimal Recomendado Identifica o saque mínimo da quantidade da criptomoeda.
max_withdraw Decimal Recomendado Identifica o saque máximo da quantidade da criptomoeda.
maker_fee Decimal Recomendado Taxas aplicadas quando a liquidez é adicionada ao registro de ordens.
taker_fee Decimal Recomendado Taxas aplicadas quando a liquidez é removida ao registro de ordens.

ENDPOINT 2

TICKER /ticker

O endpoint do ticker é para fornecer um sumário do preço e volume durante 24 horas para cada mercado disponível na exchange.

https://exchange.intertradec.com.br/api/public/ticker

                                {  
                                       "BTC_USDT":{  
                                          "base_id":"1",
                                          "quote_id":"825",
                                          "last_price":"10000",
                                          "quote_volume":"20000",
                                          "base_volume":"2",
                                          "isFrozen":"0"
                                       },
                                       "LTC_BTC":{  
                                          "base_id":"2",
                                          "quote_id":"1",
                                          "last_price":"0.00699900",
                                          "base_volume":"20028,526",
                                          "quote_volume":"279594",
                                          "isFrozen":"0"
                                       }
                                    }
                                
                            

Nome Tipo Status Descrição
base_id Integral Recomendado O par de cotações Unified Cryptoasset ID.
quote_id Integral Recomendado O par de bases Unified Cryptoasset ID.
last_price Decimal Obrigatório O preço da última ordem executada.
base_volume Decimal Obrigatório Volume de trade em 24 horas no par de base de volume.
quote_volume Decimal Obrigatório Volume de trade em 24 horas no par de cotação de volume.
isFrozen Integral Recomendado Indica se o mercado atualmente está habilitado (1) ou desabilitado (0).

ENDPOINT 3

ORDERBOOK /orderbook/market_pair

O endpoint dos registros de ordens é para fornecer um registro de ordens de nível 2 (organizado por melhor solicitação/oferta) com a profundidade completa voltada para um par específico de mercado.

https://exchange.intertradec.com.br/api/public/orderbook/BTC_BRL

                                {  
                                       "timestamp":"1566359163",
                                       "bids":[  
                                          [  
                                             "12462000",
                                             "0.04548320"
                                          ],
                                          [  
                                             "12457000",
                                             "3.00000000"
                                          ]
                                       ],
                                       "asks":[  
                                          [  
                                             "12506000",
                                             "2.73042000"
                                          ],
                                          [  
                                             "12508000",
                                             "0.33660000"
                                          ]
                                       ]
                                    }
                                
                            

Nome Tipo Status Descrição
market_pair Cadeia Obrigatório Um par como “LTC_BTC”
depth Integral Recomendado Orders depth quantity:[0,5,10,20,50,100,500] Not defined or 0 = full order book
level Integral Obrigatório Nível 1 – Apenas as melhores ofertas e solicitações.
Nível 2 – Organizado por melhores ofertas e solicitações.
Nível 3 – Registro de ordens completo, sem agregação.
Nome Tipo Status Descrição
timestamp registro de tempo Obrigatório Registro de tempo Unixem milissegundos para quando a última atualização ocorrer.
bids decimal Obrigatório Um compilado contendo 2 elementos. O preço e quantidade de cada ordem de oferta.
asks decimal Obrigatório Um compilado contendo 2 elementos. O preço e quantidade de cada ordem de solicitação.

ENDPOINT 4

TRADES /trades/market_pair

Os endpoints do tarde são para retornar a informação com todos os trades completos para um par de mercado específico.

https://exchange.intertradec.com.br/api/public/trades/BTC_BRL

                                [   
                                       {         
                                          "tradeID":3523643,
                                          "price":"0.01",
                                          "base_volume":"569000",
                                          "quote_volume":"0.01000000",
                                          "trade_timestamp":"1566360780",
                                          "type":"sell"
                                       }
                                    ]
                                
                            

Nome Tipo Status Descrição
market_pair Cadeia Obrigatório Um par como LTC_BTC.
type/side Cadeia Recomendado Consultar o lado de compra ou venda apenas.
Nome Tipo Status Descrição
trade_id Integral Obrigatório Uma ID única associada com o par de transação do trade da moeda.
Obs: o sistema Unix não se qualifica como trade_id.
price Decimal Obrigatório Preço da transação no volume do par base.
base_volume Decimal Obrigatório Valor da transação no volume do par de base.
quote_volume Decimal Obrigatório Valor da transação no volume do par de cotações.
trade_timestamp Registro de Tempo Obrigatório Unix data e hora em milissegundos para quando a transação acontece.
type Cadeia Obrigatório Usado para determinar se uma transação foi ou não originada de uma compra ou venda.
Compra – Identifica que uma solicitação foi removida do registro de ordens.
Venda – Identifica que uma oferta foi removida do registro de ordens.