API

Introduction

Public API et Trade API offrent un moyen pratique d'interagir avec l'échange de logiciels tiers.

• Public API est utilisé pour obtenir des informations qui ne nécessitent pas l'accès aux données personnelles du compte.
• Trade API est nécessaire pour créer et annuler des ordres, demander des soldes actuels, ainsi que pour obtenir des informations nécessitant l'accès aux données de compte personnel.

Public API

Public API existe actuellement en plusieurs versions. Les développeurs sont encouragés à choisir la dernière version à utiliser dans leurs produits logiciels.

v2

de la deuxième version offre la possibilité d'obtenir : depth, fee, ticker, trades (méthodes).

Le lien ressemble à ceci : https://yobit.net/api/2/paire/nom de la méthode

Une seule paire peut être spécifiée dans un lien.
Exemples pour une paire ltc_btc:

• Depth: https://yobit.net/api/2/ltc_btc/depth
• Ticker: https://yobit.net/api/2/ltc_btc/ticker
• Trades: https://yobit.net/api/2/ltc_btc/trades
• Fee: https://yobit.net/api/2/ltc_btc/fee

v3

La principale différence entre Public API de la troisième version et la seconde est la possibilité d'obtenir des informations sur plusieurs paires à la fois en une seule requête au serveur. Dans ce cas, la liste des paires souhaitées est indiquée par un tiret.

Les réponses du serveur sont mises en cache toutes les 2 secondes, il est donc inutile de faire des demandes plus souvent.

Méthodes disponibles : depth, ticker, trades, info.

Le lien ressemble à ceci : https://yobit.net/api/3/nom de la méthode/énumération des paires
Plusieurs paires peuvent être spécifiées sans répétition, ou une seule.

La méthode info n'a pas de paramètre d'énumération de paire. Cette méthode peut être utilisée pour obtenir une liste de paires réelles.

Exemples pour une liste de paires ltc_btc-nmc_btc:

• Info: https://yobit.net/api/3/info
• Depth: https://yobit.net/api/3/depth/ltc_btc-nmc_btc
• Ticker: https://yobit.net/api/3/ticker/ltc_btc-nmc_btc
• Trades: https://yobit.net/api/3/trades/ltc_btc-nmc_btc

Attention ! Si nous désactivons une paire de la liste, l'API générera une erreur. Un paramètre GET est disponible pour permettre d'ignorer ces erreurs ignore_invalid.
Exemple d'utilisation : https://yobit.net/api/3/depth/ltc_btc-error_pair?ignore_invalid=1

info

Exemple de demande : https://yobit.net/api/3/info

Exemple de réponse :

{
	"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: nombre de décimales autorisé
• min_price: prix minimum autorisé
• max_price: prix maximum autorisé
• min_amount: quantité minimale autorisée à acheter ou à vendre
• hidden: paire cachée (0 ou 1)
• fee: commission de paire

Les paires cachées ne sont pas affichées dans la liste sur la page principale de l'échange, mais les échanges continuent de fonctionner.
Si vous désactivez une paire, elle disparaîtra de la liste.

ticker

La méthode renvoie des informations statistiques pour les dernières 24 heures.

Exemple de demande : https://yobit.net/api/3/ticker/ltc_btc

Exemple de réponse :

{
	"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: prix maximum
• low: prix minimum
• avg: prix moyen
• vol: volume d'échanges
• vol_cur: volume d'échanges en devises
• last: prix de dernière transaction
• buy: prix d'achat
• sell: prix de vente
• updated: dernière mise à jour du cache

depth

La méthode renvoie des informations sur les listes d'ordres actifs des paires spécifiées.

Paramètre GET limit définit la profondeur de retrait (par défaut 150, maximum 2 000).

Exemple de demande : https://yobit.net/api/3/depth/ltc_btc

Exemple de réponse :

{
	"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: ordres à vendre
• bids: ordres à acheter

trades

La méthode renvoie des informations sur les dernières transactions des paires spécifiées.

Le paramètre GET limit définit la profondeur de retrait (par défaut 150, maximum 2000).

Exemple de demande : https://yobit.net/api/3/trades/ltc_btc

Exemple de réponse :

{
	"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 - vente, bid - achat
• price: prix d'achat/vente
• amount: montant
• tid: ID de transaction
• timestamp: unix time de transaction

Trade API

Trade API est nécessaire pour créer et annuler des ordres, demander les soldes actuels, ainsi que pour obtenir des informations nécessitant l'accès aux données personnelles du compte.

Pour utiliser Trade API, vous devez créer une clé dans la section appropriée.
Le secret de la clé n'est disponible que pour consultation dans l'heure qui suit sa création, nous vous recommandons donc de l'enregistrer immédiatement après la génération de la clé. Les clés et leurs secrets sont utilisés pour authentifier l'utilisateur.

Adresse d'envoi des demandes Trade API : https://yobit.net /tapi/

Une authentification est requise pour chaque demande.

Le serveur renvoie toutes les réponses au format JSON

Exemple de réponse réussie du serveur :

{"success":1,"return":{response}}

Exemple de réponse d'erreur :

{"success":0,"error":"erreur"}

Authentification

Chaque demande Trade API doit être authentifiée.
L'authentification se produit en envoyant les en-têtes HTTP suivants :

Key - Clé API, exemple : FAF816D16FFDFBD1D46EEF5D5B10D8A2

Sign - signature numérique, paramètres POST (?param0=val0 & ...& nonce=1) signés avec une clé privée à l'aide de HMAC-SHA512

Le paramètre nonce (minimum 1, maximum 2147483646) doit être supérieur à la valeur de la demande précédente pour chaque nouvelle demande.
Pour réinitialiser le nonce, vous devez créer une nouvelle clé.

getInfo

La méthode renvoie des informations sur les soldes de l'utilisateur et les privilèges de la clé API, ainsi que sur l'heure du serveur.

Exigences : privilège de la clé info

Paramètres : aucun

Exemple de réponse :

{
	"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: solde du compte disponible pour utilisation (n'inclut pas l'argent sur les ordres ouvertes)
• funds_incl_orders: solde du compte disponible pour utilisation (inclut l'argent sur les ordres ouvertes)
• rights: privilège de la clé. withdraw n'est pas utilisé (réservé)
• transaction_count: toujours 0 (obsolète)
• open_orders: toujours 0 (obsolète)
• server_time: heure du serveur

Trade

La méthode par laquelle de nouveaux ordres sont créés pour être négociés en bourse

Exigences : privilèges de la clé info&trade

Paramètres:

• pair: paire (exemple : ltc_btc)
• type: type d'opération (exemple : buy ou sell)
• rate: le taux auquel acheter ou vendre (valeur : numérique)
• amount: quantité à acheter ou à vendre (valeur : numérique)

Exemple de réponse :

{
	"success":1,
	"return":{
		"received":0.1,
		"remains":0,
		"order_id":12345,
		"funds":{
			"btc":15,
			"ltc":51.82,
			"nvc":0,
			...
		}
	}
}

• received: combien de devises ont été achetées/vendues
• remains: combien de devises il reste à acheter/vendre
• order_id: ID d'ordre créé
• funds: soldes à jour après une demande

ActiveOrders

La méthode renvoie une liste des commandes actives de l'utilisateur

Exigences : privilège de la clé info

Paramètres :

• pair: paire (exemple : ltc_btc)

Exemple de réponse :

{
	"success":1,
	"return":{
		"100025362":{
			"pair":"ltc_btc",
			"type":"sell",
			"amount":21.615,
			"rate":0.258,
			"timestamp_created":1418654530,
			"status":0
		},
		...
	}
}

• clés de tableau: ID des ordres (dans l'exemple : 100025362)
• pair: paire (exemple : ltc_btc)
• type: type d'opération (exemple :buy ou sell)
• amount: reste à acheter ou à vendre
• rate: prix d'achat ou de vente
• timestamp_created: heure de création de l'ordre
• status: toujours 0 (obsolète)

OrderInfo

La méthode renvoie des informations détaillées sur l'ordre spécifié

Exigences : privilège de la clé info

Paramètres:

• order_id: ID de l'ordre (valeurs : numériques)

Exemple de réponse :

{
	"success":1,
	"return":{
		"100025362":{
			"pair":ltc_btc,
			"type":sell,
			"start_amount":13.345,
			"amount":12.345,
			"rate":485,
			"timestamp_created":1418654530,
			"status":0
		}
	}
}

• clé de tableau : ID de l'ordre (dans l'exemple : 100025362)
• pair: paire de l'ordre (exemple : ltc_btc)
• type: type d'ordre (exemple : buy ou sell)
• start_amount: Montant initial de l'ordre lors de la création
• amount: reste à acheter ou à vendre par ordre
• rate: prix d'achat ou de vente
• timestamp_created: heure de création de l'ordre
• status: 0 - actif, 1 - exécuté et fermé, 2 - annulé, 3 - annulé, mais a été partiellement exécuté.

CancelOrder

La méthode annule l'ordre spécifié

Exigences : privilèges de la clé info&trade

Paramètres :

• order_id: ID de l'ordre (valeurs : numériques)

Exemple de réponse :

{
	"success":1,
	"return":{
		"order_id":100025362,
		"funds":{
			"btc":15,
			"ltc":51.82,
			"nvc":0,
			...
		}
	}
}

• order_id: ID de l'ordre
• funds: soldes à jour après une demande

TradeHistory

La méthode renvoie l'historique des échanges.

Exigences : privilège de la clé info

Paramètres :

• from: numéro de la transaction à partir de laquelle commencer le retrait (valeurs : numériques, par défaut : 0)
• count: nombre de transactions à retirer (valeurs : numériques, par défaut : 1000)
• from_id: ID de la transaction à partir de laquelle commencer le retrait (valeurs : numériques, par défaut : 0)
• end_id: ID de la transaction où terminer le retrait (valeurs : numériques, par défaut : ∞)
• order: tri lors du retrait (valeurs : ASC ou DESC, par défaut : DESC)
• since: à partir de quelle heure commencer le retrait (valeurs : heure unix, par défaut : 0)
• end: à quelle heure terminer le retrait (valeurs : unix time, par défaut : ∞)
• pair: paire (exemple : ltc_btc)

Lors de l'utilisation des paramètres since ou end, le paramètre order prend automatiquement la valeur ASC.

Lorsque vous utilisez le paramètre depuis, la date maximale pour laquelle un historique peut être récupéré - il y a une semaine..

Exemple de réponse :

{
	"success":1,
	"return":{
		"24523":{
			"pair":"ltc_btc",
			"type":"sell",
			"amount":11.4,
			"rate":0.145,
			"order_id":100025362,
			"is_your_order":1,
			"timestamp":1418654530
		}
		...
	}
}

• clés de tableau : ID de transactions (dans l'exemple : 24523)
• pair: paire (exemple : ltc_btc)
• type: type d'opération (exemple : buy ou sell)
• amount: quantité achetée ou vendue
• rate: prix d'achat ou de vente
• order_id: ID de l'ordre
• is_your_order: si l'ordre est le vôtre (1 ou 0)
• timestamp: heure de transaction

GetDepositAddress

La méthode renvoie l'adresse de recharge.

Exigences : privilège de la clé deposits

Paramètres :

• coinName: mnémo de la devise (exemple : BTC)
• need_new: value: 0 ou 1, par défaut : 0

Exemple de réponse :

{
	"success":1,
	"return":{
		"address": 1UHAnAWvxDB9XXETsi7z483zRRBmcUZxb3,
		"processed_amount": 1.00000000,		
		"server_time": 1437146228
	}
}

WithdrawCoinsToAddress

La méthode crée une demande de retrait.

Exigences : privilège de la clé withdrawals

Paramètres :

• coinName: mnémo de la devise (exemple : BTC)
• amount: montant de retrait
• address: adresse de destination

Exemple de réponse :

{
	"success":1,
	"return":{
		"server_time": 1437146228
	}
}

CreateYobicode

La méthode est destinée pour créer des Yobicodes (coupons).

Variante orthographique de la méthode : CreateCoupon

Exigences : privilège de la clé withdrawals

Paramètres :

• currency: mnémo de la devise (exemple : BTC)
• amount: montant de yobicode

Exemple de réponse :

{
	"success":1,
	"return":{
		"coupon": "YOBITUZ0HHSTBCOH5F6EAOENCRD8RGOQX3H01BTC",
		"transID": 1,	
		"funds":{
			"btc":15,
			"ltc":51.82,
			"nvc":0,
			...
		}
	}
}

• coupon: Yobicode
• transID: toujours 1 pour la compatibilité avec les API des autres échanges
• funds: soldes à jour après une demande

RedeemYobicode

La méthode est conçue pour échanger des Yobicodes (coupons).

Variante orthographique de la méthode : RedeemCoupon

Exigences : privilège de la clé deposits

Paramètres :

• coupon: yobicode pour créditer (exemple : YOBITUZ0HHSTB...OQX3H01BTC)

Exemple de réponse :

{
	"success":1,
	"return":{
		"couponAmount": "1.2345",
		"couponCurrency": "BTC",
		"transID": 1,	
		"funds":{
			"btc":15,
			"ltc":51.82,
			"nvc":0,
			...
		}
	}
}

• couponAmount: Le montant qui a été crédité.
• couponCurrency: La devise yobicode qui a été créditée.
• transID: toujours 1 pour la compatibilité avec les API des autres échanges
• funds: soldes à jour après la demande

Defi Public API

Un exemple de demande d'informations sur tous les pools :
https://yobit.net/api/defi/info

Un exemple de demande d'informations sur des pools spécifiques :
https://yobit.net/api/defi/info/btc_usdt-yo_btc

Exemple de réponse :

{
	"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: les fournisseurs de liquidité ont investi des devises 1 dans le pool
• liq2: les fournisseurs de liquidité ont investi des devises 2 dans le pool
• price1: price actuel 1
• price2: price actuel 2
• fee: commission en % (0.003 signifie 0.3%)
• price24high1: price 1 le plus élevé au cours des dernières 24 heures
• price24low1: price 1 le plus bas au cours des dernières 24 heures
• price24high2: price 2 le plus élevé au cours des dernières 24 heures
• price24low2: price 2 le plus bas au cours des dernières 24 heures
• vol1: volume de swaps en devise 1 sur les dernières 24 heures
• vol2: volume de swaps en devise 2 sur les dernières 24 heures
• algo1: erc20, trc20, bep20 ou SHA256/Scrypt/X11
• tokenid1: pour la devise 1 adresse du token pour les algorithmes erc20, trc20, bep20 ou vide pour les autres
• algo2: erc20, trc20, bep20 or SHA256/Scrypt/X11
• tokenid2: pour la devise 2 adresse du token pour les algorithmes erc20, trc20, bep20 ou vide pour les autres

Les pools cachés ne sont pas affichés dans la liste sur la page principale de l'échange.
Lorsqu'un pool est désactivé, il disparaît de la liste.

DefiSwapInfo

Le but de la méthode est d'obtenir des informations sur un éventuel Swap avant de l'appeler avec la fonction DefiSwap.

Exigences : privilège de la clé info&trade

Paramètres :

• pool: nom du pool au format cur1_cur2 (exemple : btc_usdt)
• PayCurrency: la devise que vous donnez lors du swap. Elle doit être cur1 OU cur2 (exemple : usdt)
• PayAmount: le montant que vous donnez lors du swap (exemple : 1.123)

Exemple de réponse :

{
	"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: est toujours égal à 0. Indique qu'aucun échange n'a eu lieu.
• pay_amount : le montant que vous payez lors lors du swap
• pay_currency: la devise que vous donnez lors du swap
• get_amount: le montant que vous recevez lors du swap
• get_currency: la devise que vous obtenez lors du swap
• price_of_swap: prix du swap (
• fee_total: montant de la commission
• fee_total_currency: devise de la commission
• price1_before: prix actuel 1 du pool avant le swap
• price1_after: prix actuel 2 du pool avant le swap
• price2_before: montre quel serait le prix 1 du pool après le swap
• price2_after: montre quel serait le prix 2 du pool après le swap

DefiSwap

La méthode est destinée à effectuer des échanges Defi (Swaps).

Exigences : privilège de la clé info&trade

Paramètres :

• pool: nom du pool au format cur1_cur2 (exemple : btc_usdt)
• PayCurrency: la devise que vous donnez lors du swap. Elle doit être cur1 OU cur2 (exemple : usdt)
• PayAmount: le montant que vous donnez lors du swap (exemple : 1.123)

Exemple de réponse :

{
	"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: le montant que vous payez lors lors du swap
• pay_currency: la devise que vous donnez lors du swap
• get_amount: le montant que vous recevez lors du swap
• get_currency: la devise que vous obtenez lors du swap
• price_of_swap: prix du swap (
• fee_total: montant de la commission
• fee_total_currency: devise de la commission
• price1_before: prix 1 du pool avant le swap
• price1_after: prix 2 du pool avant le swap
• price2_before: prix 1 du pool après le swap
• price2_after: prix 2 du pool après le swap
• new_balance1: votre nouveau solde de devise 1 après le swap
• new_balance1_currency: nom de la devise 1
• new_balance2: votre nouveau solde de devise 2 après le swap
• new_balance2_currency: nom de la devise 2
• pooled1: votre part de la devise 1 dans le pool de liquidités
• pooled2: votre part de la devise 2 dans le pool de liquidités
• pooled_est: montant approximatif pooled1+pooled2 en USD
• pooled_pr: votre pourcentage de pool de liquidités (exemple : 2,1456 signifie 2,1456 % du pool de liquidités)
• comfee1: commission gagnée (total devises 1)
• comfee2: commission gagnée (total devises 2)
• comfee_est: montant approximatif comfee1+comfee2 en USD