Introdução
A API pública e a API de comércio fornecem uma ferramenta conveniente para interagir com software de terceiros.
- A API Pública é usada para obter informações que não exigem acesso a dados de contas pessoais.
- A API de comércio é necessária para criar e cancelar pedidos, solicitar saldos atualizados, bem como obter informações que exijam acesso a dados de contas pessoais.
Public API
Atualmente, a API Pública existe em várias versões. Os desenvolvedores são incentivados a escolher a versão mais recente para usar em seus produtos de software.
v2
A API pública da segunda versão fornece a capacidade de obter: profundidade, comissão, ticker, comércios (métodos).
O link é assim:https://yobit.net/api/2/ par/nome do método
Apenas um par pode ser especificado no link.
Exemplos para o par ltc_btc:
v3
A principal diferença entre a terceira versão da API Pública e a segunda versão é a capacidade de obter informações sobre vários pares ao mesmo tempo para uma única solicitação ao servidor. Neste caso, a lista de pares desejados é indicada através de um traço.
As respostas do servidor são armazenadas em cache a cada 2 segundos, portanto, não faz sentido fazer solicitações com mais frequência.
Métodos disponíveis: profundidade, ticker, comércios, informações.
O link tem a seguinte aparência: https://yobit.net/api/3/nome do método/lista de pares
Vários pares podem ser especificados sem repetição, ou apenas um.
O método info não tem um parâmetro de lista de pares. Este método pode ser usado para obter uma lista de pares atuais.
Exemplos para a lista de pares ltc_btc-nmc_btc:
Aviso! Se desativarmos qualquer par da lista, a API retornará um erro. Para habilitar a ignorar tais erros, o parâmetro GET ignore_invalid está disponível.
Exemplo de uso: https://yobit.net/api/3/depth/ltc_btc-error_pair?ignore_invalid=1
info
Exemplo de solicitação: https://yobit.net/api/3/info
Exemplo de uma resposta:
{
"server_time":1418654531,
"pairs":{
"ltc_btc":{
"decimal_places":8,
"min_price":0.00000001,
"max_price":10000,
"min_amount":0.0001,
"hidden":0,
"fee":0.2
}
...
}
}
- casas_decimais: número de casas decimais permitidas
- min_price: preço mínimo permitido
- max_price: preço máximo permitido
- min_amount: quantidade mínima permitida para comprar ou vender
- hidden: par oculto (0 ou 1)
- fee: comissão do par
Pares ocultos não aparecem na lista na página principal do intercâmbio, mas as trocas nele continuam funcionando.
Se algum par for desconectado, ele desaparecerá da lista.
ticker
O método fornece informações estatísticas para as últimas 24 horas.
Exemplo de uma solicitação: https://yobit.net/api/3/ticker/ltc_btc
Exemplo de uma resposta:
{
"ltc_btc":{
"high":105.41,
"low":104.67,
"avg":105.04,
"vol":43398.22251455,
"vol_cur":4546.26962359,
"last":105.11,
"buy":104.2,
"sell":105.11,
"updated":1418654531
}
...
}
- alto: preço máximo
- baixo: preço mínimo
- médio: preço médio
- vol: volume de comércio
- vol_cur: volume de comércio em moeda
- last: preço da última transação
- comprar: preço de compra
- venda: preço de venda
- atualizado: última atualização de cache
depth
O método retorna informações sobre as listas de ordens ativas para os pares especificados.
O parâmetro GET limite especifica a profundidade de saque (padrão 150, máximo 2000).
Exemplo de uma solicitação: https://yobit.net/api/3/depth/ltc_btc
Exemplo de uma resposta:
{
"ltc_btc":{
"asks":[
[104.67,0.01],
[104.75,11],
[104.80,0.523],
...
],
"bids":[
[104.3,5.368783],
[104.212,2.57357],
[103.62,0.43663336],
[103.61,0.7255672],
...
]
}
...
}
- pedidos: pedidos de venda
- lances: ordens de compra
trades
O método retorna informações sobre transações recentes dos pares especificados.
O parâmetro GET limite especifica a profundidade de saída (padrão 150, máximo 2000).
Exemplo de uma solicitação: https://yobit.net/api/3/trades/ltc_btc
Exemplo de uma resposta:
{
"ltc_btc":[
{
"type":"ask",
"price":104.2,
"amount":0.101,
"tid":41234426,
"timestamp":1418654531
},
{
"type":"bid",
"price":103.53,
"amount":1.51414,
"tid":41234422,
"timestamp":1418654530
},
...
]
...
}
- tipo: perguntar - venda, oferta - compra
- preço: preço de compra/venda
- quantidade: quantidade
- tid: ID da transação
- timestamp: hora de unix da transação
Trade API
A API de Comércio é necessária para criar e cancelar pedidos, solicitar saldos atualizados, bem como obter informações que exijam acesso a dados de contas pessoais.
Para usar a API de Comércio você precisa criar uma chave na seção apropriada.
O segredo da chave só está disponível para visualização por uma hora após a criação, portanto, recomendamos que você o salve imediatamente após a geração da chave. As chaves e os segredos delas são usados para autenticação do usuário.
Endereço para envio de solicitações de API de Comércio: https://yobit.net/tapi/
A autenticação é necessária para cada solicitação.
O servidor envia todas as respostas no formato JSON
Exemplo de uma resposta de servidor bem-sucedida:
{"success":1,"return":{ответ}}
Exemplo de uma resposta informando sobre um erro:
{"success":0,"error":"ошибка"}
Autenticação
Cada solicitação de API de Comércio deve ser autenticada.
A autenticação é realizada enviando os seguintes cabeçalhos HTTP:
Chave - Chave de API, exemplo: FAF816D16FFDFBD1D46EEF5D5B10D8A2
Sinal - assinatura digital, parâmetros de POST (?param0=val0 & ...& nonce=1) assinados com uma chave secreta usando HMAC-SHA512
O parâmetro nonce (mínimo 1, máximo 2147483646) para cada nova solicitação deve ser maior que o valor da solicitação anterior.
Uma nova chave deve ser criada para redefinir a chave nova.
getInfo
O método retorna informações sobre os saldos do usuário e os privilégios da chave da API, bem como a hora do servidor.
Requisitos: privilégio de chave de informação
Parâmetros: Nenhum
Exemplo de uma resposta:
{
"success":1,
"return":{
"funds":{
"ltc":22,
"nvc":423.998,
"ppc":10,
...
},
"funds_incl_orders":{
"ltc":32,
"nvc":523.998,
"ppc":20,
...
},
"rights":{
"info":1,
"trade":0,
"withdraw":0
},
"transaction_count":0,
"open_orders":1,
"server_time":1418654530
}
}
- fundos: saldo da conta disponível para uso (não inclui dinheiro em pedidos abertos)
- funds_incl_orders: saldo da conta disponível para uso (inclui dinheiro em pedidos abertos)
- direitos: privilégios da chave. o saque não é usado (reservado)
- transaction_count: sempre 0 (obsoleto)
- open_orders: sempre 0 (obsoleto)
- server_time: hora do servidor
Trade
Um método pelo qual novas ordens são criadas para comércio em um intercâmbio
Requisitos: privilégios da chaveinformação&comércio
Parâmetros:
- par: par (exemplo: ltc_btc)
- tipo: tipo de operação (exemplo: comprar ou vender)
- comissão: comissão na qual comprar ou vender (valor: numérico)
- quantidade: quantidade para comprar ou vender (valor: numérico)
Exemplo de uma resposta:
{
"success":1,
"return":{
"received":0.1,
"remains":0,
"order_id":12345,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- recebido: quantas moedas compradas/vendidas
- permanece: quantas moedas restam para comprar/vender
- order_id: ID do pedido criado
- fundos: saldos que estão atuados após a solicitação
ActiveOrders
O método retorna uma lista de ordens de usuário ativas
Requisitos: privilégio de chave de informação
Parâmetros:
- par: par (exemplo: ltc_btc)
Exemplo de uma resposta:
{
"success":1,
"return":{
"100025362":{
"pair":"ltc_btc",
"type":"sell",
"amount":21.615,
"rate":0.258,
"timestamp_created":1418654530,
"status":0
},
...
}
}
- chaves de matriz: ID de ordens (no exemplo: 100025362)
- par: par (exemplo: ltc_btc)
- tipo: tipo de operação (exemplo: comprar ou vender)
- valor: comprar ou vender o restante
- tarifa: preço de compra ou venda
- timestamp_created: hora de criação do pedido
- estado: sempre 0 (obsoleto)
OrderInfo
O método retorna informações detalhadas sobre a ordem especificada
Requisitos: privilégio de chave de informação
Parâmetros:
- order_id: ID do pedido (valores: numéricos)
Exemplo de uma resposta:
{
"success":1,
"return":{
"100025362":{
"pair":ltc_btc,
"type":sell,
"start_amount":13.345,
"amount":12.345,
"rate":485,
"timestamp_created":1418654530,
"status":0
}
}
}
- chave da matriz: ID do pedido (exemplo: 100025362)
- par: par de ordem (exemplo: ltc_btc)
- tipo: tipo de pedido (exemplo: comprar ou vender)
- start_amount: valor inicial do pedido ao criar
- valor: deixe para comprar ou vender por ordem
- tarifa: preço de compra ou venda
- timestamp_created: hora de criação da ordem
- estado: 0 - ativo, 1 - executado e fechado, 2 - cancelado, 3 - cancelado, mas foi parcialmente executado.
CancelOrder
O método cancela a ordem especificada
Requisitos: privilégios de chave informação&comércio
Parâmetros:
- order_id: ID da ordem (valores: numéricos)
Exemplo de uma resposta:
{
"success":1,
"return":{
"order_id":100025362,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- order_id: ID da ordem
- fundos: saldos que estão atuais após a solicitação
TradeHistory
O método retorna o histórico de transações.
Requisitos: privilégio de chave de informação
Parâmetros:
- de: número da transação com a qual iniciar a saque (valores: numérico, padrão: 0)
- conta: número de transações para saque (valores: numérico, padrão: 1000)
- from_id: ID da transação a ser sacada (valores: numéricos, padrão: 0)
- end_id: ID da transação onde finalizar o saque (valores: numéricos, padrão: ∞)
- ordem: classificar no saque (valores: ASC ou DESC, padrão: DESC)
- desde: quando iniciar o saque (valores: hora unix, padrão: 0)
- fim: quando terminar o saque (valores: tempo unix, padrão: ∞)
- par: par (exemplo: ltc_btc)
Ao usar os parâmetros desde ou fim, o parâmetro ordem recebe automaticamente o valor ASC.
Ao usar o parâmetro desde, a data máxima a partir da qual você pode obter o histórico é uma semana atrás.
Exemplo de uma resposta:
{
"success":1,
"return":{
"24523":{
"pair":"ltc_btc",
"type":"sell",
"amount":11.4,
"rate":0.145,
"order_id":100025362,
"is_your_order":1,
"timestamp":1418654530
}
...
}
}
- chaves da matrix: IDs das transações (no exemplo: 24523)
- par: par (exemplo: ltc_btc)
- tipo: tipo de operação (exemplo: comprar ou vender)
- quantidade: quantidade comprada ou vendida
- tarifa: preço de compra ou venda
- order_id: ID da ordem
- is_your_order: se a ordem é seu (1 ou 0)
- timestamp: hora da transação
GetDepositAddress
O método retorna o endereço de reabastecimento.
Requisitos: privilégio da chave de depósitos
Parâmetros:
- nomeDeMoeda: ticker da moeda (exemplo: BTC)
- need_new: valor: 0 ou 1, padrão: 0
Exemplo de uma resposta:
{
"success":1,
"return":{
"address": 1UHAnAWvxDB9XXETsi7z483zRRBmcUZxb3,
"processed_amount": 1.00000000,
"server_time": 1437146228
}
}
WithdrawCoinsToAddress
O método cria uma solicitação do saque.
Requisitos: privilégio da chave de saques
Parâmetros:
- nomeDaMoeda: ticker da moeda (exemplo: BTC)
- valor: valor a sacar
- endereço: endereço de destino
Exemplo de uma resposta:
{
"success":1,
"return":{
"server_time": 1437146228
}
}
CreateYobicode
Este método é usado para criar Yobicodes (cupons).
Método alternativo de escrita: CriarCupom
Requisitos: privilégio da chave de saques
Parâmetros:
- moeda: ticker da moeda (exemplo: BTC)
- quantidade: quantidade de yobicode
Exemplo de uma resposta:
{
"success":1,
"return":{
"coupon": "YOBITUZ0HHSTBCOH5F6EAOENCRD8RGOQX3H01BTC",
"transID": 1,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- cupom: Yobicode
- transID: sempre 1 para compatibilidade com a api de outros intercâmbios
- fundos: saldos que estão atuais após a solicitação
RedeemYobicode
O método destina-se ao resgate de Yobicodes (cupons).
Método alternativo de escrita: ResgatarCupom
Requisitos: privilégio da chave de depósitos
Parâmetros:
- coupom: yobicode para creditar (exemplo: YOBITUZ0HHSTB...OQX3H01BTC)
Exemplo de uma resposta:
{
"success":1,
"return":{
"couponAmount": "1.2345",
"couponCurrency": "BTC",
"transID": 1,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- couponAmount: O valor que foi creditado.
- couponCurrency: A moeda yobicode que foi creditada.
- transID: sempre 1 para compatibilidade com a api de outros intercâmbios
- fundos: saldos que estão atuais após a solicitação
Defi Public API
Exemplo de solicitação de informações para todos os pools:
https://yobit.net/api/defi/info
Exemplo de solicitação de informações sobre pools específicos:
https://yobit.net/api/defi/info/btc_usdt-yo_btc
Exemplo de uma resposta:
{
"server_time":1418654531,
"pools":{
"usdt_spitz":{
"liq1":"45540230.71160736",
"liq2":"230.12172671",
"price1":"0.00000505",
"price2":"197896.26717427",
"fee":"0.003",
"price24high1":"0.00000512",
"price24low1":"0.00000505",
"price24high2":"197898.16740049",
"price24low2":"195199.11794729",
"vol1":"47.57434935",
"vol2":"2.61017416",
"algo1":"erc20",
"tokenid1":"0xdac17f958d2ee523a2206206994597c13d831ec7",
"algo2":"bep20",
"tokenid2":"0x9d1d63501e3490aeedf0dba24f60c29918caf965",
}
...
}
}
- liq1: provedores de liquidez investiram moedas 1 no pool
- liq2: provedores de liquidez investiram moedas 2 no pool
- preço1: preço atual 1
- price2: preço atual 2
- comissão: comissão em % (0,003 significa 0,3%)
- price24high1: maior preço 1 nas últimas 24 horas
- price24low1: menor preço 1 nas últimas 24 horas
- price24high2: o maior preço 2 nas últimas 24 horas
- price24low2: menor preço 2 nas últimas 24 horas
- vol1: volume de trocas em moeda 1 nas últimas 24 horas
- vol2: volume de trocas em moeda 2 nas últimas 24 horas
- algo1: erc20, trc20, bep20 ou SHA256/Scrypt/X11
- tokenid1: para moeda 1 endereço de token para algoritmos erc20, trc20, bep20 ou vazio para outros
- algo2: erc20, trc20, bep20 ou SHA256/Scrypt/X11
- tokenid2: para moeda 2 endereço de token para algoritmos erc20, trc20, bep20 ou vazio para outros
Pools ocultos não são exibidos na lista na página principal da exchange.
Se qualquer pool estiver desativado, ele desaparecerá da lista.
DefiSwapInfo
O método é usado para obter informações sobre uma possível troca antes de chamá-la com a função DefiSwap.
Requisitos: privilégio da chave informação&comércio
Parâmetros:
- pool: nome do pool no formato cur1_cur2 (exemplo: btc_usdt)
- PayCurrency: a moeda que você dá ao trocar. Deve ser cur1 OU cur2 (exemplo: usdt)
- PayAmount: o valor que você dá ao trocar (exemplo: 1,123)
Exemplo de uma resposta:
{
"success":1,
"swap_made":0,
"info":{
"desc": "SWAP 1.12300000 USDT to 0.00002567 BTC with price 43732.86034952",
"pay_amount": "1.12300000",
"pay_currency": "USDT",
"get_amount": "0.00002567",
"get_currency": "BTC",
"price_of_swap": "43732.86034952",
"fee_total": "0.00000007",
"fee_total_currency": "BTC",
"price1_before": "43601.61783433",
"price1_after": "43601.70585432",
"price2_before": "0.00002293",
"price2_after": "0.00002294",
}
}
- swap_made: sempre igual a 0. Indica que a troca não foi efetivamente realizado.
- pay_amount: o valor que você dá ao trocar
- pay_currency: a moeda que você dá ao trocar
- get_amount: o valor que você recebe quando troca
- get_currency: a moeda que você obtém ao trocar
- price_of_swap: preço de troca (
- fee_total: valor da comissão
- fee_total_currency: moeda da comissão
- price1_before: o preço atual de 1 pool antes da troca
- price1_after: o preço atual dos 2 pools antes do swap
- price2_before: mostra qual seria o preço de 1 pool após a troca
- price2_after: mostra qual seria o preço de 2 pools após a troca
DefiSwap
O método destina-se a trocas Defi (Swaps).
Requisitos: privilégio da chave informação&comércio
Parâmetros:
- pool: nome do pool no formato cur1_cur2 (exemplo: btc_usdt)
- PayCurrency: a moeda que você dá ao trocar. Deve ser cur1 OU cur2 (exemplo: usdt)
- PayAmount: o valor que você dá ao trocar (exemplo: 1.123)
Exemplo de uma resposta:
{
"success":1,
"swap_made":0,
"info":{
"desc": "SWAP 1.12300000 USDT to 0.00002567 BTC with price 43732.86034952",
"pay_amount": "1.12300000",
"pay_currency": "USDT",
"get_amount": "0.00002567",
"get_currency": "BTC",
"price_of_swap": "43732.86034952",
"fee_total": "0.00000007",
"fee_total_currency": "BTC",
"price1_before": "43601.61783433",
"price1_after": "43601.70585432",
"price2_before": "0.00002293",
"price2_after": "0.00002294",
},
"user":{
"new_balance1": "12.07789855",
"new_balance1_currency": "BTC",
"new_balance2": "497908.66928976",
"new_balance2_currency": "USDT",
"pooled1": "1.07518709",
"pooled2": "46729.28782075",
"pooled_est": "$93,233.91955017",
"pooled_pr": "2.1456",
"comfee1": "4.1894",
"comfee2": "625.3309128",
"comfee_est": "$1,207.09775086",
}
}
- pay_amount: o valor que você dá ao trocar
- pay_currency: a moeda que você dá ao trocar
- get_amount: o valor que você recebe quando troca
- get_currency: a moeda que você obtém ao trocar
- price_of_swap: preço de troca (
- fee_total: valor da comissão
- fee_total_currency: moeda da comissão
- price1_before: preço de 1 pool antes da troca
- price1_after: preço de 2 pools antes da troca
- price2_before: preço de 1 pool após a troca
- price2_after: preço de 2 pools após a troca
- new_balance1: seu novo saldo de moeda 1 após a troca
- new_balance1_currency: nome da moeda 1
- new_balance2: seu novo saldo de moeda 2 após a troca
- new_balance2_currency: nome da moeda 2
- pooled1: sua parte da moeda 1 no pool de liquidez
- pooled2: sua parte da moeda 2 no pool de liquidez
- pooled_est: quantidade aproximada de pooled1+pooled2 em USD
- pooled_pr: sua porcentagem de pool de liquidez (exemplo: 2,1456 significa 2,1456% do pool de liquidez)
- comfee1: comissão ganha (total de moedas 1)
- comfee2: comissão ganha (total de moedas 2)
- comfee_est: número aproximado de comfee1+comfee2 em USD
mandobro: The surprising fact is that Larry Ellison's wife, if she hadn't sold 500 shares of her husband's company, would now be a billionaire