API

Introduction

Public API and Trade API are useful device for communicating with the third party software stock exchange.

• Public API is used to obtain information that does not require access to personal data of the account.
• Trade API is necessary for creation and cancellation of orders, actual balance information request as well as for obtaining information that requires access to personal data of the account.

Public API

At the present moment Public API is developed in several editions. Programmers are recommended to choose the latest edition for use in their software products.

v2

Public API of the second edition provides the possibility to obtain: depth, fee, ticker, trades (methods).

The link looks like: https://yobit.net/api/2/pair/method name

Only one pair can be stipulated in the link.
Examples for pair 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

Major difference between Public API of the third edition from that of the second one is possibility to obtain information on several pairs at one request to the server. The list of the needed pairs is stipulated in hyphenated form.

Server responses are cashed every 2 seconds that is why there is no sense in making requests faster.

Available methods: depth, ticker, trades, info.

The link looks like: https://yobit.net/api/3/method name/pair list
Several pairs can be stipulated without repetitions or only one pair can be stipulated.

Method info has no pair list parameter. The given method can be used for obtaining list of active pairs.

Examples of pair lists 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

Note! If we disable any pair from the list API will throw an error message. To enable the ignoration of such errors GET-parameter is available ignore_invalid.
Example of use: https://yobit.net/api/3/depth/ltc_btc-error_pair?ignore_invalid=1

info

Example of request: https://yobit.net/api/3/info

Example of response:

{
	"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: Quantity of permitted numbers after decimal point
• min_price: minimal permitted price
• max_price: maximal permitted price
• min_amount: minimal permitted buy or sell amount
• hidden: pair is hidden (0 or 1)
• fee: pair commission

Hidden pairs are not shown in the list at Stock Exchange home page, but exchange transactions continue.
In case if any pair is disabled it disappears from the list.

ticker

Method provides statistic data for the last 24 hours.

Example of request: https://yobit.net/api/3/ticker/ltc_btc

Example of response:

{
	"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: maximal price
• low: minimal price
• avg: average price
• vol: traded volume
• vol_cur: traded volume in currency
• last: last transaction price
• buy: buying price
• sell: selling price
• updated: last cache upgrade

depth

Method returns information about lists of active orders for selected pairs.

GET-parameter limit stipulates size of withdrawal (on default 150 to 2000 maximum).

Example of request: https://yobit.net/api/3/depth/ltc_btc

Example of response:

{
	"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: selling orders
• bids: buying orders

trades

Method returns information about the last transactions of selected pairs.

GET-parameter limit stipulates size of withdrawal (on default 150 to 2000 maximum).

Example of request: https://yobit.net/api/3/trades/ltc_btc

Example of response:

{
	"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 - sell, bid - buy
• price: buying / selling price
• amount: amount
• tid: transaction id
• timestamp: transaction timestamp

Trade API

Trade API is necessary for creation and cancellation of orders, request of active balances as well as for obtaining the information that requires access to account personal data.

To use Trade API it is necessary to create key in corresponding Section.
Key secret is available to see only within one hour after its generation therefore we recommend that you save it just after key generation. Keys and their secrets are used for user authentication.

Address for sending requests to Trade API is https://yobit.net/tapi/

For each request authentication is needed.

All the responses are created by the server in JSON format

Example of server's successful response:

{"success":1,"return":{%answer%}}

Example of error informing response:

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

Authentication

Each Trade API request should pass authentication.
Authentication is fulfilled by sending the following HTTP-titles:

Key - API-key, example: FAF816D16FFDFBD1D46EEF5D5B10D8A2

Sign - digital signature, POST-parameters (?param0=val0 & ...& nonce=1) signed by secret key through HMAC-SHA512

Parameter nonce (1 minimum to 2147483646 maximum) in succeeding request should exceed that in the previous one.
To null nonce it is necessary to generate new key.

getInfo

Method returns information about user's balances and priviledges of API-key as well as server time.

Requirements: priviledge of key info

Parameters are absent

Example of response:

{
	"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: available account balance (does not include money on open orders)
• funds_incl_orders: available account balance (include money on open orders)
• rights: priviledges of key. withdraw is not used (reserved)
• transaction_count: always 0 (outdated)
• open_orders: always 0 (outdated)
• server_time: server time

Trade

Method that allows creating new orders for stock exchange trading

Requirements: priviledges of key info&trade

Parameters:

• pair: pair (example: ltc_btc)
• type: transaction type (example: buy or sell)
• rate: exchange rate for buying or selling (value: numeral)
• amount: amount needed for buying or selling (value: numeral)

Example of response:

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

• received: amount of currency bought / sold
• remains: amount of currency to buy / to sell
• order_id: created order ID
• funds: funds active after request

ActiveOrders

Method returns list of user's active orders

Requirements: priviledges of key info

Parameters:

• pair: pair (example: ltc_btc)

Example of response:

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

• keys of array: order ID (in example: 100025362)
• pair: pair (example: ltc_btc)
• type: transaction type (example: buy or sell)
• amount: remains to buy or to sell
• rate: price of buying or selling
• timestamp_created: order creation time
• status: always 0 (outdated

OrderInfo

Method returns detailed information about the chosen order

Requirements: priviledges of key info

Parameters:

• order_id: order ID (value: numeral)

Example of response:

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

• array key: order ID (in example: 100025362)
• pair: order pair (example: ltc_btc)
• type: order type (example: buy or sell)
• start_amount: starting amout at order creation
• amount: order amount remaining to buy or to sell
• rate: price of buying or selling
• timestamp_created: order creation time
• status: 0 - active, 1 - fulfilled and closed, 2 - cancelled, 3 - cancelled after partially fulfilled.

CancelOrder

Method cancells the chosen order

Requirements: priviledges of key info&trade

Parameters:

• order_id: order ID (value: numeral)

Example of response:

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

• order_id: order ID
• funds: balances active after request

TradeHistory

Method returns transaction history.

Requirements: priviledges of key info

Parameters:

• from: No. of transaction from which withdrawal starts (value: numeral, on default: 0)
• count: quantity of withrawal transactions (value: numeral, on default: 1000)
• from_id: ID of transaction from which withdrawal starts (value: numeral, on default: 0)
• end_id: ID of transaction at which withdrawal finishes (value: numeral, on default: ∞)
• order: sorting at withdrawal (value: ASC or DESC, on default: DESC)
• since: the time to start the display (value: unix time, on default: 0)
• end: the time to end the display (value: unix time, on default: ∞)
• pair: pair (example: ltc_btc)

While using parameters since or end parameter order automatically takes the value ASC.

While using parameters sincethe earliest date available to get transaction history is one week ago.

Example of response:

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

• array keys: order IDs (in example: 24523)
• pair: pair (example: ltc_btc)
• type: transaction type (example: buy or sell)
• amount: bought or sold amount
• rate: price of buying or selling
• order_id: order ID
• is_your_order: is the order yours (1 or 0)
• timestamp: transaction time

GetDepositAddress

Method returns deposit address.

Requirements: priviledges of key deposits

Parameters:

• coinName: ticker (example: BTC)
• need_new: value: 0 or 1, on default: 0

Example of response:

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

WithdrawCoinsToAddress

Method creates withdrawal request.

Requirements: priviledges of key withdrawals

Parameters:

• coinName: ticker (example: BTC)
• amount: amount to withdraw
• address: destination address

Example of response:

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

CreateYobicode

Method allows you to create Yobicodes (coupons).

Method alias: CreateCoupon

Requirements: priviledges of key withdrawals

Parameters:

• currency: ticker (example: BTC)
• amount: amount of yobicode

Example of response:

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

• coupon: Yobicode
• transID: always 1 for compatibility with api of other exchanges
• funds: balances active after request

RedeemYobicode

Method is used to redeem Yobicodes (coupons).

Method alias: RedeemCoupon

Requirements: priviledges of key deposits

Parameters:

• coupon: yobicode to redeem (example: YOBITUZ0HHSTB...OQX3H01BTC)

Example of response:

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

• couponAmount: The amount that has been redeemed.
• couponCurrency: The currency of the yobicode that has been redeemed.
• transID: always 1 for compatibility with api of other exchanges
• funds: balances active after request

Defi Public API

Example of request all pools:
https://yobit.net/api/defi/info

Example of request specific pools:
https://yobit.net/api/defi/info/btc_usdt-yo_btc

Example of response:

{
	"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: liquidity providers invested currency 1 in the pool
• liq2: liquidity providers invested currency 2 in the pool
• price1: actual price 1
• price2: actual price 2
• fee: in % (0.003 means 0.3%)
• price24high1: the highest price 1 at last 24 hours
• price24low1: the lowest price 1 at last 24 hours
• price24high2: the highest price 2 at last 24 hours
• price24low2: the lowest price 2 at last 24 hours
• vol1: volume of swaps in currency 1 at last 24 hours
• vol2: volume of swaps in currency 2 at last 24 hours
• algo1: erc20, trc20, bep20 or SHA256/Scrypt/X11
• tokenid1: currency 1 token address for erc20, trc20, bep20 algos or empty for others
• algo2: erc20, trc20, bep20 or SHA256/Scrypt/X11
• tokenid2: currency 2 token address for erc20, trc20, bep20 algos or empty for others

Hidden pools are not shown in the list at Exchange home page.
In case if any pair is disabled it disappears from the list.

DefiSwapInfo

Method is used to get info about Swap before processing of it with DefiSwap function.

Requirements: priviledges of key info&trade

Parameters:

• pool: pool name in format cur1_cur2 (example: btc_usdt)
• PayCurrency: currency that you pay for swap. It should be cur1 OR cur2 (example: usdt)
• PayAmount: amount that you pay for swap (example: 1.123)

Example of response:

{
	"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: is always 0. It shows that swap hasn't been processed.
• pay_amount: amount that you pay for swap
• pay_currency: currency that you pay for swap
• get_amount: amount that you get during swap
• get_currency: currency that you get during swap
• price_of_swap: price of swap
• fee_total: amount of fee
• fee_total_currency: currency of fee
• price1_before: actual price 1 of pool before swap
• price1_after: actual price 2 of pool before swap
• price2_before: shows what the price 1 would be if the swap processed
• price2_after: shows what the price 2 would be if the swap processed

DefiSwap

Method is used to make Swaps.

Requirements: priviledges of key info&trade

Parameters:

• pool: pool name in format cur1_cur2 (example: btc_usdt)
• PayCurrency: currency that you pay for swap. It should be cur1 OR cur2 (example: usdt)
• PayAmount: amount that you pay for swap (example: 1.123)

Example of response:

{
	"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: amount that you pay for swap
• pay_currency: currency that you pay for swap
• get_amount: amount that you get during swap
• get_currency: currency that you get during swap
• price_of_swap: price of swap
• fee_total: amount of fee
• fee_total_currency: currency of fee
• price1_before: actual price 1 of pool before swap
• price1_after: actual price 2 of pool before swap
• price2_before: shows what the price 1 would be if the swap processed
• price2_after: shows what the price 2 would be if the swap processed
• new_balance1: your new balance of currency 1 after swap
• new_balance1_currency: currency 1 name
• new_balance2: your new balance of currency 2 after swap
• new_balance2_currency: currency 2 name
• pooled1: your part of currency 1 in defi pool
• pooled2: your part of currency 2 in defi pool
• pooled_est: estimated amount of pooled1+pooled2 in USD
• pooled_pr: your percentage of defi pool (example: 2.1456 means 2.1456%)
• comfee1: fees earned (cumulative of currency 1)
• comfee2: fees earned (cumulative of currency 2)
• comfee_est: estimated amount of comfee1+comfee2 in USD