Introducción
Public API y Trade API son un medio práctico para interactuar con el exchange de un software de terceros.
- Public API se utiliza para obtener información que no requiera acceso a los datos de la cuenta personal.
- Trade API es necesaria para la creación y cancelación de órdenes, la solicitud de saldos actuales, así como para obtener información que requiera acceso a los datos de la cuenta personal.
Public API
Actualmente, la Public API está disponible en varias versiones. Se recomienda a los desarrolladores a elegir la última versión para utilizarla en sus productos de software.
v2
La API pública de la segunda versión brinda la oportunidad de obtener: depth, fee, ticker, trades (métodos).
El enlace tiene el siguiente aspecto: https://yobit.net/api/2/par/nombre del método
Solo se puede especificar un par en el enlace.
Ejemplos para el par ltc_btc:
v3
La principal diferencia entre la tercera versión de la Public API y la segunda versión es la capacidad de recibir información sobre varios pares a la vez en una sola solicitud al servidor. Al mismo tiempo, la lista de pares deseados se indica por medio de un símbolo de guion.
Las respuestas del servidor se almacenan en caché cada 2 segundos, por lo que no tiene sentido hacer solicitudes con más frecuencia.
Métodos disponibles: depth, ticker, trades, info.
El enlace posee el siguiente aspecto: https://yobit.net/api/3/nombre del método/enumeración de pares
Se pueden especificar varios pares sin repeticiones, o solo uno.
El método info no posee el parámetro de enumeración de pares. Este método se puede usar para obtener una lista de pares actuales.
Ejemplos para la lista de pares ltc_btc-nmc_btc:
¡Atención! En el caso de la desactivación por nosotros de cualquier par del listado, la API generará un error. Para ignorar tales errores está disponible el parámetro GET ignore_invalid.
Ejemplo de uso: https://yobit.net/api/3/depth/ltc_btc-error_pair?ignore_invalid=1
info
Ejemplo de solicitud: https://yobit.net/api/3/info
Ejemplo de respuesta:
{
"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
}
...
}
}
- decimal_places: cantidad de decimales permitidos después de la coma
- min_price: precio mínimo permitido
- max_price: precio máximo permitido
- min_amount: cantidad mínima permitida para compra o venta
- hidden: par oculto (0 o 1)
- fee: comisión del par
Los pares ocultos no aparecen en la página principal del exchange, pero las operaciones de intercambio continúan.
En el caso de la desactivación de cualquier par, el mismo será eliminado del listado.
ticker
El método proporciona información estadística de las últimas 24 horas.
Ejemplo de solicitud: https://yobit.net/api/3/ticker/ltc_btc
Ejemplo de respuesta:
{
"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
}
...
}
- high: precio máximo
- low: precio mínimo
- avg: precio promedio
- vol: volumen de negociaciones
- vol_cur: volumen de negociaciones en moneda
- last: valor de la última operación
- buy: precio de compra
- sell: precio de venta
- updated: última actualización de caché
depth
El método devuelve información sobre las listas de órdenes activas de los pares especificados.
El parámetro GET limit establece la profundidad de retiro (150 por defecto, 2000 como máximo).
Ejemplo de solicitud: https://yobit.net/api/3/depth/ltc_btc
Ejemplo de respuesta:
{
"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],
...
]
}
...
}
- asks: órdenes de venta
- bids: órdenes de compra
trades
El método devuelve información sobre las últimas operaciones de los pares especificados.
El parámetro GET limit establece la profundidad de retiro (150 por defecto, 2000 como máximo).
Ejemplo de solicitud: https://yobit.net/api/3/trades/ltc_btc
Ejemplo de respuesta:
{
"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
},
...
]
...
}
- type: ask - venta, bid - compra
- price: precio de compra/venta
- amount: cantidad
- tid: identificador de la operación
- timestamp: unix time de la operación
Trade API
Trade API es necesaria para la creación y cancelación de órdenes, la solicitud de saldos actuales, así como para obtener información que requiera acceso a los datos de la cuenta personal.
Para utilizar la Trade API se debe crear una clave en la sección correspondiente.
El secreto de la clave solo está disponible durante una hora después de su creación, por lo que recomendamos guardarla inmediatamente después de que se genere la clave. Las claves y sus secretos se utilizan para autenticar al usuario.
Dirección para el envío de solicitudes Trade API: https://yobit.net/tapi/
Se requiere autenticación para cada solicitud.
El servidor emite todas las respuestas en formato JSON
Ejemplo de una respuesta correcta del servidor:
{"success":1,"return":{respuesta}}
Ejemplo de una respuesta de error:
{"success":0,"error":"error"}
Autenticación
Todas las solicitudes de Trade API deben estar autenticadas..
La autenticación se lleva a cabo mediante el método de envío de los siguientes encabezados HTTP:
Key - clave API, ejemplo: FAF816D16FFDFBD1D46EEF5D5B10D8A2
Sign - firma digital, parámetros POST (?param0=val0 & ...& nonce=1) firmados con una clave privada con la ayuda de HMAC-SHA512
Parámetro nonce (mínimo 1, máximo 2147483646) durante cada nueva solicitud debe ser mayor al valor de la solicitud anterior.
Para restablecer el nonce es necesario crear una nueva clave.
getInfo
El método devuelve la información sobre los saldos de los usuarios y los privilegios de la clave API, así como la hora del servidor.
Requisitos: privilegio de la clave info
Parámetros: ninguno
Ejemplo de respuesta:
{
"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
}
}
- funds: saldo de la cuenta disponible para su uso (no incluye el dinero en las órdenes abiertas)
- funds_incl_orders: saldo de la cuenta disponible para su uso (incluye el dinero en las órdenes abiertas)
- rights: privilegios de la clave. no se utiliza retiro de dinero (reservado)
- transaction_count: siempre 0 (obsoleto)
- open_orders: siempre 0 (obsoleto)
- server_time: hora del servidor
Trade
Método en base al cual se crean nuevas órdenes para operar en el exchange
Requisitos: privilegios de la clave info&trade
Parámetros:
- pair: par (ejemplo: ltc_btc)
- type: tipo de operación (ejemplo: buy o sell)
- rate: cotización a la cual se debe comprar o vender (valor: numérico)
- amount: cantidad que se debe comprar o vender (valor: numérico)
Ejemplo de respuesta:
{
"success":1,
"return":{
"received":0.1,
"remains":0,
"order_id":12345,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- received: cantidad de dinero comprado/vendido
- remains: cuando dinero queda para comprar/vender
- order_id: ID de la orden creada
- funds: saldos relevantes después de la solicitud
ActiveOrders
El método devuelve la lista de órdenes activas del usuario
Requisitos: privilegio de la clave info
Parámetros:
- pair: par (ejemplo: ltc_btc)
Ejemplo de respuesta:
{
"success":1,
"return":{
"100025362":{
"pair":"ltc_btc",
"type":"sell",
"amount":21.615,
"rate":0.258,
"timestamp_created":1418654530,
"status":0
},
...
}
}
- claves de matriz: ID de las órdenes (en el ejemplo: 100025362)
- pair: par (ejemplo: ltc_btc)
- type: tipo de operación (ejemplo: buy o sell)
- amount: monto restante a comprar o vender
- rate: precio de compra o venta
- timestamp_created: hora de creación de la orden
- status: siempo 0 (obsoleto)
OrderInfo
El método devuelve información detallada sobre la orden especificada.
Requisitos: privilegio de la clave info
Parámetros:
- order_id: ID de la orden (valores: numéricos)
Ejemplo de respuesta:
{
"success":1,
"return":{
"100025362":{
"pair":ltc_btc,
"type":sell,
"start_amount":13.345,
"amount":12.345,
"rate":485,
"timestamp_created":1418654530,
"status":0
}
}
}
- clave de matriz: ID de la orden (en el ejemplo: 100025362)
- pair: par de la orden (ejemplo: ltc_btc)
- type: tipo de orden (ejemplo: buy o sell)
- start_amount: monto inicial de la orden durante su creación
- amount: monto restante a comprar o vender según la orden
- rate: precio de compra o venta
- timestamp_created: hora de creación de la orden
- status: 0 - activo, 1 - ejecutado y cerrado, 2 - cancelado, 3 - cancelado pero parcialmente ejecutado.
CancelOrder
El método cancela la orden especificada
Requisitos: privilegios de la clave info&trade
Parámetros:
- order_id: ID de la orden (valores: numéricos)
Ejemplo de respuesta:
{
"success":1,
"return":{
"order_id":100025362,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- order_id: ID de la orden
- funds: saldos relevantes después de la solicitud
TradeHistory
El método devuelve el historial de operaciones.
Requisitos: privilegio de la clave info
Parámetros:
- from: número de la operación desde la que se debe iniciar el retiro (valores: numéricos, por defecto: 0)
- count: cantidad de operaciones de retiro (valores: numéricos, por defecto: 1000)
- from_id: ID de la operación desde la cual se inicia el retiro (valores: numéricos, por defecto: 0)
- end_id: ID de la operación en la que se finaliza el retiro (valores: numéricos, por defecto: ∞)
- order: clasificación durante retiro (valores: ASC o DESC, por defecto: DESC)
- since: desde que hora comenzar el retiro (valores: unix time, por defecto: 0)
- end: a que hora finalizar el retiro (valores: unix time, por defecto: ∞)
- pair: par (ejemplo: ltc_btc)
Durante el uso de los parámetros since o end, parámetro order adopta automáticamente el valor ASC.
Durante el uso del parámetro since, la fecha máxima durante la cual se puede recuperar el historial es de una semana.
Ejemplo de respuesta:
{
"success":1,
"return":{
"24523":{
"pair":"ltc_btc",
"type":"sell",
"amount":11.4,
"rate":0.145,
"order_id":100025362,
"is_your_order":1,
"timestamp":1418654530
}
...
}
}
- claves de la matriz: ID de las operaciones (en el ejemplo: 24523)
- pair: par (ejemplo: ltc_btc)
- type: tipo de operaicón (ejemplo: buy o sell)
- amount: cantidad de comprado o vendido
- rate: precio de compra o venta
- order_id: ID de la orden
- is_your_order: es el pedido tuyo (1 o 0)
- timestamp: hora de la operación
GetDepositAddress
El método devuelve la dirección de depósito.
Requisitos: privilegio de la clave deposits
Parámetros:
- coinName: ticker de la moneda (ejemplo: BTC)
- need_new: value: 0 o 1, por defecto: 0
Ejemplo de respuesta:
{
"success":1,
"return":{
"address": 1UHAnAWvxDB9XXETsi7z483zRRBmcUZxb3,
"processed_amount": 1.00000000,
"server_time": 1437146228
}
}
WithdrawCoinsToAddress
El método crea una solicitud de retiro de fondos.
Requisitos: privilegio de la clave withdrawals
Parámetros:
- coinName: ticker de la moneda (ejemplo: BTC)
- amount: monto a retirar
- address: dirección de destino
Ejemplo de respuesta:
{
"success":1,
"return":{
"server_time": 1437146228
}
}
CreateYobicode
El método está diseñado para la creación de Yobicodes (cupones).
Programación alternativa del método: CreateCoupon
Requisitos: privilegio de la clave withdrawals
Parámetros:
- currency: ticker de la moneda (ejemplo: BTC)
- amount: monto de yobicode
Ejemplo de respuesta:
{
"success":1,
"return":{
"coupon": "YOBITUZ0HHSTBCOH5F6EAOENCRD8RGOQX3H01BTC",
"transID": 1,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- coupon: Yobicode
- transID: siempre 1 para la compatibilidad con la API de otros exchanges
- funds: saldos relevantes después de la solicitud
RedeemYobicode
El método está diseñado para canjear Yobicodes (cupones).
Programación alternativa del método: RedeemCoupon
Requisitos: privilegio de la clave deposits
Parámetros:
- coupon: yobicode para acreditar (ejemplo: YOBITUZ0HHSTB...OQX3H01BTC)
Ejemplo de respuesta:
{
"success":1,
"return":{
"couponAmount": "1.2345",
"couponCurrency": "BTC",
"transID": 1,
"funds":{
"btc":15,
"ltc":51.82,
"nvc":0,
...
}
}
}
- couponAmount: El monto que se ha acreditado.
- couponCurrency: La moneda yobicode que ha sido acreditada.
- transID: siempre 1 para la compatibilidad con la API de otros Exchanges
- funds: saldos relevantes después de la solicitud
Defi Public API
Ejemplo de solicitud de información para todos los pools:
https://yobit.net/api/defi/info
Ejemplo de solicitud de información para pools específicos:
https://yobit.net/api/defi/info/btc_usdt-yo_btc
Ejemplo de respuesta:
{
"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: los proveedores de liquidez han invertido las monedas 1 en el pool
- liq2: los proveedores de liquidez han invertido las monedas 2 en el pool
- price1: price 1 actual
- price2: price 2 actual
- fee: comisión en % (0,003 significa 0.3%)
- price24high1: price 1 más alto en las últimas 24 horas
- price24low1: price 1 más bajo en las últimas 24 horas
- price24high2: price 2 más alto en las últimas 24 horas
- price24low2: price 2 más bajo en las últimas 24 horas
- vol1: volumen de swap en moneda 1 en las últimas 24 horas
- vol2: volumen de swap en moneda 2 en las últimas 24 horas
- algo1: erc20, trc20, bep20 o SHA256/Scrypt/X11
- tokenid1: dirección para los algoritmos erc20, trc20, bep20 para el token de la moneda 1, o vacío para el resto
- algo2: erc20, trc20, bep20 or SHA256/Scrypt/X11
- tokenid2: dirección para los algoritmos erc20, trc20, bep20 para el token de la moneda 2, o vacío para el resto
Los pools ocultos no se muestran en la lista de la página principal del exchange.
Cuando se deshabilita un pool, se eliminará de la lista.
DefiSwapInfo
El método está diseñado para obtener información sobre un posible Swap antes de que sea llamado por la función DefiSwap.
Requisitos: privilegio de la clave info&trade
Parámetros:
- pool: nombre del pool en el formato cur1_cur2 (ejemplo: btc_usdt)
- PayCurrency: moneda que entregas durante el swap. Debe ser cur1 O cur2 (ejemplo: usdt)
- PayAmount: monto que entregas durante un swap (ejemplo: 1.123)
Ejemplo de respuesta:
{
"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: siempre igual a 0. Indica que el swap no se realizó realmente.
- pay_amount: monto que pagas durante el swap
- pay_currency: moneda que pagas al realizar el swap
- get_amount: monto que recibes al realizar el swap
- get_currency: moneda que recibes al realizar el swap
- price_of_swap: valor del swap (
- fee_total: monto de la comisión
- fee_total_currency: moneda de la comisión
- price1_before: precio actual 1 del pool antes del swap
- price1_after: precio actual 2 del pool antes del swap
- price2_before: muestra cuál sería el precio 1 del pool después de la realización del swap
- price2_after: muestra cuál sería el precio 2 del pool después de la realización del swap
DefiSwap
El método está diseñado para la realización de swaps Defi (Swaps).
Requisitos: privilegio de la clave info&trade
Parámetros:
- pool: nombre del pool en el formato cur1_cur2 (ejemplo: btc_usdt)
- PayCurrency: moneda que entregas durante el swap. Debe ser cur1 O cur2 (ejemplo: usdt)
- PayAmount: monto que entregas durante un swap (ejemplo: 1.123)
Ejemplo de respuesta:
{
"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: monto que entregas durante el swap
- pay_currency: moneda que entregas durante el swap
- get_amount: monto que recibes durante el swap
- get_currency: moneda que recibes durante el swap
- price_of_swap: precio del swap (
- fee_total: importe de la comisión
- fee_total_currency: moneda de la comisión
- price1_before: precio del pool 1 antes del swap
- price1_after: precio del pool 2 antes del swap
- price2_before: precio del pool 1 después del swap
- price2_after: precio del pool 2 después del swap
- new_balance1: tu nuevo saldo de la moneda 1 después del swap
- new_balance1_currency: nombre de la moneda 1
- new_balance2: tu nuevo saldo de la moneda 2 después del swap
- new_balance2_currency: nombre de la moneda 2
- pooled1: tu parte de la moneda 1 en el pool de liquidez
- pooled2: tu parte de la moneda 2 en el pool de liquidez
- pooled_est: cantidad estimada de pooled1+pooled2 en USD
- pooled_pr: tu porcentaje del pool de liquidez (ejemplo: 2.1456 significa 2.1456% del pool de liquidez)
- comfee1: comisión ganada (total de moneda 1)
- comfee2: comisión ganada (total de moneda 2)
- comfee_est: importe aproximado de comfee1+comfee2 en USD