bittrex.py

"""
   See https://bittrex.com/Home/Api
"""

import urllib
import time
import requests
import hmac
import hashlib

BUY_ORDERBOOK = 'buy'
SELL_ORDERBOOK = 'sell'
BOTH_ORDERBOOK = 'both'

PUBLIC_SET = ['getmarkets', 'getcurrencies', 'getticker', 'getmarketsummaries', 'getorderbook',
			  'getmarkethistory', 'getticks']

MARKET_SET = ['getopenorders', 'cancel', 'sellmarket', 'selllimit', 'buymarket', 'buylimit']

ACCOUNT_SET = ['getbalances', 'getbalance', 'getdepositaddress', 'withdraw', 'getorder', 'getorderhistory', 'getwithdrawalhistory', 'getdeposithistory']


class Bittrex(object):
	"""
	Used for requesting Bittrex with API key and API secret
	"""
	def __init__(self, api_key, api_secret):
		self.api_key = str(api_key) if api_key is not None else ''
		self.api_secret = str(api_secret) if api_secret is not None else ''
		self.public_set = set(PUBLIC_SET)
		self.market_set = set(MARKET_SET)
		self.account_set = set(ACCOUNT_SET)

	def api_query(self, method, options=None):
		"""
		Queries Bittrex with given method and options

		:param method: Query method for getting info
		:type method: str

		:param options: Extra options for query
		:type options: dict

		:return: JSON response from Bittrex
		:rtype : dict
		"""
		if not options:
			options = {}
		nonce = str(int(time.time() * 1000))
		base_url = 'https://bittrex.com/api/v1.1/%s/'
		request_url = ''

		if method in self.public_set:
			request_url = (base_url % 'public') + method + '?'
		elif method in self.market_set:
			request_url = (base_url % 'market') + method + '?apikey=' + self.api_key + "&nonce=" + nonce + '&'
		elif method in self.account_set:
			request_url = (base_url % 'account') + method + '?apikey=' + self.api_key + "&nonce=" + nonce + '&'

		request_url += urllib.parse.urlencode(options)
		signature = hmac.new(self.api_secret.encode('utf-8'), request_url.encode('utf-8'), hashlib.sha512).hexdigest()
		
		headers = {"apisign": signature}

		ret = requests.get(request_url, headers=headers)
		return ret.json()
		
	def api_query2(self, method, market, options=None):
		"""
		DEZE METHOD TOEGEVOEGD DOOR KARUN
		----
		Met de standaard wrapper heb je niet toegang tot alle info, zoals:
		https://bittrex.com/Api/v2.0/pub/market/GetTicks?marketName=BTC-WAVES&tickInterval=thirtyMin&_=1499127220008
		
		Deze functie en get_ticks heb ik toegevoegd om dit beschikbaar te maken.
		Roep aan met: api.get_ticks('BTC-DOGE')
		Of als je 1 veld wil bijv.: api.get_ticks('BTC-DOGE')['success']
		----
		
		
		Queries Bittrex with given method and options

		:param method: Query method for getting info
		:type method: str

		:param options: Extra options for query
		:type options: dict

		:return: JSON response from Bittrex
		:rtype : dict
		"""
		if not options:
			options = {}
		nonce = str(int(time.time() * 1000))
		base_url = 'https://bittrex.com/api/v2.0/%s/'
		request_url = ''

		if method in self.public_set:
			request_url = (base_url % 'pub/market') + method + '?' + 'marketName=' + "{0[market]}".format(market) + '&tickInterval=fiveMin'
		elif method in self.market_set:
			request_url = (base_url % 'market') + method + '?apikey=' + self.api_key + "&nonce=" + nonce + '&'
		elif method in self.account_set:
			request_url = (base_url % 'account') + method + '?apikey=' + self.api_key + "&nonce=" + nonce + '&'

		# uncomment voor debuggen:	
		#print(request_url)	

		#request_url += urllib.parse.urlencode(options)
		signature = hmac.new(self.api_secret.encode('utf-8'), request_url.encode('utf-8'), hashlib.sha512).hexdigest()
		
		headers = {"apisign": signature}
		
		ret = requests.get(request_url, headers=headers)
		return ret.json()

	def get_markets(self):
		"""
		Used to get the open and available trading markets
		at Bittrex along with other meta data.

		:return: Available market info in JSON
		:rtype : dict
		"""
		return self.api_query('getmarkets')

	def get_currencies(self):
		"""
		Used to get all supported currencies at Bittrex
		along with other meta data.

		:return: Supported currencies info in JSON
		:rtype : dict
		"""
		return self.api_query('getcurrencies')

	def get_ticker(self, market):
		"""
		Used to get the current tick values for a market.

		:param market: String literal for the market (ex: BTC-LTC)
		:type market: str

		:return: Current values for given market in JSON
		:rtype : dict
		"""
		return self.api_query('getticker', {'market': market})
		
	def get_ticks(self, market):	
		return self.api_query2('getticks', {'market': market})

	def get_market_summaries(self):
		"""
		Used to get the last 24 hour summary of all active exchanges

		:return: Summaries of active exchanges in JSON
		:rtype : dict
		"""
		return self.api_query('getmarketsummaries')

	def get_orderbook(self, market, depth_type, depth=20):
		"""
		Used to get retrieve the orderbook for a given market

		:param market: String literal for the market (ex: BTC-LTC)
		:type market: str

		:param depth_type: buy, sell or both to identify the type of orderbook to return.
			Use constants BUY_ORDERBOOK, SELL_ORDERBOOK, BOTH_ORDERBOOK
		:type depth_type: str

		:param depth: how deep of an order book to retrieve. Max is 100, default is 20
		:type depth: int

		:return: Orderbook of market in JSON
		:rtype : dict
		"""
		return self.api_query('getorderbook', {'market': market, 'type': depth_type, 'depth': depth})

	def get_market_history(self, market, count):
		"""
		Used to retrieve the latest trades that have occured for a
		specific market.

		/market/getmarkethistory

		:param market: String literal for the market (ex: BTC-LTC)
		:type market: str

		:param count: Number between 1-100 for the number of entries to return (default = 20)
		:type count: int

		:return: Market history in JSON
		:rtype : dict
		"""
		return self.api_query('getmarkethistory', {'market': market, 'count': count})

	def buy_market(self, market, quantity, rate):
		"""
		Used to place a buy order in a specific market. Use buymarket to
		place market orders. Make sure you have the proper permissions
		set on your API keys for this call to work

		/market/buymarket

		:param market: String literal for the market (ex: BTC-LTC)
		:type market: str

		:param quantity: The amount to purchase
		:type quantity: float

		:param rate: The rate at which to place the order.
			This is not needed for market orders
		:type rate: float

		:return:
		:rtype : dict
		"""
		return self.api_query('buymarket', {'market': market, 'quantity': quantity, 'rate': rate})

	def buy_limit(self, market, quantity, rate):
		"""
		Used to place a buy order in a specific market. Use buylimit to place
		limit orders Make sure you have the proper permissions set on your
		API keys for this call to work

		/market/buylimit

		:param market: String literal for the market (ex: BTC-LTC)
		:type market: str

		:param quantity: The amount to purchase
		:type quantity: float

		:param rate: The rate at which to place the order.
			This is not needed for market orders
		:type rate: float

		:return:
		:rtype : dict
		"""
		return self.api_query('buylimit', {'market': market, 'quantity': quantity, 'rate': rate})

	def sell_market(self, market, quantity, rate):
		"""
		Used to place a sell order in a specific market. Use sellmarket to place
		market orders. Make sure you have the proper permissions set on your
		API keys for this call to work

		/market/sellmarket

		:param market: String literal for the market (ex: BTC-LTC)
		:type market: str

		:param quantity: The amount to purchase
		:type quantity: float

		:param rate: The rate at which to place the order.
			This is not needed for market orders
		:type rate: float

		:return:
		:rtype : dict
		"""
		return self.api_query('sellmarket', {'market': market, 'quantity': quantity, 'rate': rate})

	def sell_limit(self, market, quantity, rate):
		"""
		Used to place a sell order in a specific market. Use selllimit to place
		limit orders Make sure you have the proper permissions set on your
		API keys for this call to work

		/market/selllimit

		:param market: String literal for the market (ex: BTC-LTC)
		:type market: str

		:param quantity: The amount to purchase
		:type quantity: float

		:param rate: The rate at which to place the order.
			This is not needed for market orders
		:type rate: float

		:return:
		:rtype : dict
		"""
		return self.api_query('selllimit', {'market': market, 'quantity': quantity, 'rate': rate})

	def cancel(self, uuid):
		"""
		Used to cancel a buy or sell order

		/market/cancel

		:param uuid: uuid of buy or sell order
		:type uuid: str

		:return:
		:rtype : dict
		"""
		return self.api_query('cancel', {'uuid': uuid})

	def get_open_orders(self, market):
		"""
		Get all orders that you currently have opened. A specific market can be requested

		/market/getopenorders

		:param market: String literal for the market (ie. BTC-LTC)
		:type market: str

		:return: Open orders info in JSON
		:rtype : dict
		"""
		return self.api_query('getopenorders', {'market': market})

	def get_balances(self):
		"""
		Used to retrieve all balances from your account

		/account/getbalances

		:return: Balances info in JSON
		:rtype : dict
		"""
		return self.api_query('getbalances', {})

	def get_balance(self, currency):
		"""
		Used to retrieve the balance from your account for a specific currency

		/account/getbalance

		:param currency: String literal for the currency (ex: LTC)
		:type currency: str

		:return: Balance info in JSON
		:rtype : dict
		"""
		return self.api_query('getbalance', {'currency': currency})

	def get_deposit_address(self, currency):
		"""
		Used to generate or retrieve an address for a specific currency

		/account/getdepositaddress

		:param currency: String literal for the currency (ie. BTC)
		:type currency: str

		:return: Address info in JSON
		:rtype : dict
		"""
		return self.api_query('getdepositaddress', {'currency': currency})

	def withdraw(self, currency, quantity, address):
		"""
		Used to withdraw funds from your account

		/account/withdraw

		:param currency: String literal for the currency (ie. BTC)
		:type currency: str

		:param quantity: The quantity of coins to withdraw
		:type quantity: float

		:param address: The address where to send the funds.
		:type address: str

		:return:
		:rtype : dict
		"""
		return self.api_query('withdraw', {'currency': currency, 'quantity': quantity, 'address': address})

	def get_order(self, uuid):
		"""
		Used to get an order from your account

		/account/getorder

		:param uuid: The order UUID to look for
		:type uuid: str

		:return:
		:rtype : dict
		"""
		return self.api_query('getorder', {'uuid': uuid})

	def get_order_history(self, market = ""):
		"""
		Used to retrieve your order history

		/account/getorderhistory

		:param market: Bittrex market identifier (i.e BTC-DOGE)
		:type market: str

		:return:
		:rtype : dict
		"""
		return self.api_query('getorderhistory', {"market": market})
	
	def get_withdrawal_history(self, currency = ""):
		"""
		Used to retrieve your withdrawal history

		/account/getwithdrawalhistory

		:param currency: String literal for the currency (ie. BTC) (defaults to all)
		:type currency: str

		:return:
		:rtype : dict
		"""
		return self.api_query('getwithdrawalhistory', {"currency": currency})

	def get_deposit_history(self, currency = ""):
		"""
		Used to retrieve your deposit history

		/account/getdeposithistory

		:param currency: String literal for the currency (ie. BTC) (defaults to all)
		:type currency: str

		:return:
		:rtype : dict
		"""
		return self.api_query('getdeposithistory', {"currency": currency})