-
-
Notifications
You must be signed in to change notification settings - Fork 166
/
__init__.py
873 lines (775 loc) · 34.1 KB
/
__init__.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# Poloniex API wrapper tested on Python 2.7+ & 3.5+
# https://github.com/s4w3d0ff/python-poloniex
# BTC: 1A7K4kgXLSSzvDRjvoGwomvhrNU4CKezEp
# TODO:
# [x] PEP8ish
# [x] Add better logger access
# [x] Improve logging output
# [x] Add websocket support
#
# Copyright (C) 2016 https://github.com/s4w3d0ff
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
# python 2
try:
from urllib import urlencode as _urlencode
str = unicode
# python 3
except:
from urllib.parse import urlencode as _urlencode
from json import loads as _loads
from json import dumps as _dumps
from hmac import new as _new
from hashlib import sha512 as _sha512
from time import time, sleep
from itertools import chain as _chain
from functools import wraps as _wraps
from threading import Thread
import logging
# 3rd party
from requests.exceptions import RequestException
from requests import Session
from websocket import WebSocketApp
# local
from .coach import Coach
# logger
logger = logging.getLogger(__name__)
retryDelays = (0, 2, 5, 30)
# Possible Commands
PUBLIC_COMMANDS = [
'returnTicker',
'return24hVolume',
'returnOrderBook',
'marketTradeHist',
'returnChartData',
'returnCurrencies',
'returnLoanOrders']
PRIVATE_COMMANDS = [
'returnBalances',
'returnCompleteBalances',
'returnDepositAddresses',
'generateNewAddress',
'returnDepositsWithdrawals',
'returnOpenOrders',
'returnTradeHistory',
'returnAvailableAccountBalances',
'returnTradableBalances',
'returnOpenLoanOffers',
'returnOrderTrades',
'returnOrderStatus',
'returnActiveLoans',
'returnLendingHistory',
'createLoanOffer',
'cancelLoanOffer',
'toggleAutoRenew',
'buy',
'sell',
'cancelOrder',
'cancelAllOrders',
'moveOrder',
'withdraw',
'returnFeeInfo',
'transferBalance',
'returnMarginAccountSummary',
'marginBuy',
'marginSell',
'getMarginPosition',
'closeMarginPosition']
class PoloniexError(Exception):
""" Exception for handling poloniex api errors """
pass
class RetryException(PoloniexError):
""" Exception for retry decorator """
pass
class PoloniexBase(object):
"""The PoloniexBase Object!"""
def __init__(
self, key=False, secret=False,
timeout=None, coach=True, jsonNums=False, proxies=None):
"""
key = str api key supplied by Poloniex
secret = str secret hash supplied by Poloniex
timeout = int time in sec to wait for an api response
(otherwise 'requests.exceptions.Timeout' is raised)
coach = bool to indicate if the api coach should be used
jsonNums = datatype to use when parsing json ints and floats
# Time Placeholders: (MONTH == 30*DAYS)
self.MINUTE, self.HOUR, self.DAY, self.WEEK, self.MONTH, self.YEAR
"""
# session
self.session = Session()
# set logger and coach
self.logger = logger
self.coach = coach
self.proxies = proxies
if self.coach is True:
self.coach = Coach()
# create nonce
self._nonce = int("{:.6f}".format(time()).replace('.', ''))
# json number datatypes
self.jsonNums = jsonNums
# grab keys, set timeout
self.key, self.secret, self.timeout = key, secret, timeout
# set time labels
self.MINUTE, self.HOUR, self.DAY = 60, 60 * 60, 60 * 60 * 24
self.WEEK, self.MONTH = self.DAY * 7, self.DAY * 30
self.YEAR = self.DAY * 365
# -----------------Meat and Potatos---------------------------------------
def _retry(func):
""" retry decorator """
@_wraps(func)
def retrying(*args, **kwargs):
problems = []
for delay in _chain(retryDelays, [None]):
try:
# attempt call
return func(*args, **kwargs)
# we need to try again
except RequestException as problem:
problems.append(problem)
if delay is None:
logger.debug(problems)
raise RetryException(
'retryDelays exhausted ' + str(problem))
else:
# log exception and wait
logger.debug(problem)
logger.info("-- delaying for %ds", delay)
sleep(delay)
return retrying
@_retry
def __call__(self, command, args={}):
""" Main Api Function
- encodes and sends <command> with optional [args] to Poloniex api
- raises 'poloniex.PoloniexError' if an api key or secret is missing
(and the command is 'private'), if the <command> is not valid, or
if an error is returned from poloniex.com
- returns decoded json api message """
# get command type
cmdType = self._checkCmd(command)
# pass the command
args['command'] = command
payload = {}
# add timeout
payload['timeout'] = self.timeout
# private?
if cmdType == 'Private':
payload['url'] = 'https://poloniex.com/tradingApi'
# wait for coach
if self.coach:
self.coach.wait()
# set nonce
args['nonce'] = self.nonce
# add args to payload
payload['data'] = args
# sign data with our Secret
sign = _new(
self.secret.encode('utf-8'),
_urlencode(args).encode('utf-8'),
_sha512)
# add headers to payload
payload['headers'] = {'Sign': sign.hexdigest(),
'Key': self.key}
# add proxies if needed
if self.proxies:
payload['proxies'] = self.proxies
# send the call
ret = self.session.post(**payload)
# return data
return self._handleReturned(ret)
# public?
if cmdType == 'Public':
# encode url
payload['url'] = 'https://poloniex.com/public?' + _urlencode(args)
# wait for coach
if self.coach:
self.coach.wait()
# add proxies if needed
if self.proxies:
payload['proxies'] = self.proxies
# send the call
ret = self.session.get(**payload)
# return data
return self._handleReturned(ret)
@property
def nonce(self):
""" Increments the nonce"""
self._nonce += 42
return self._nonce
def _checkCmd(self, command):
""" Returns if the command is private of public, raises PoloniexError
if command is not found """
global PUBLIC_COMMANDS, PRIVATE_COMMANDS
if command in PRIVATE_COMMANDS:
# check for keys
if not self.key or not self.secret:
raise PoloniexError("An Api Key and Secret needed for command '%s'" % command)
return 'Private'
if command in PUBLIC_COMMANDS:
return 'Public'
raise PoloniexError("Invalid Command!: %s" % command)
def _handleReturned(self, data):
""" Handles returned data from poloniex raising exceptions if needed """
# Cloudfare reported a bad gateway or gateway timeout error.
if hasattr(data,'status_code') and (data.status_code == 502 or data.status_code == 504 or data.status_code in range(520, 527, 1)):
# log and try again
self.logger.error(data.text)
raise RequestException('Poloniex Network Error %s' % str(data.status_code))
try:
if not self.jsonNums:
out = _loads(data.text, parse_float=str)
else:
out = _loads(data.text,
parse_float=self.jsonNums,
parse_int=self.jsonNums)
except:
self.logger.error(data.text)
raise PoloniexError('Invalid json response returned')
# check if poloniex returned an error
if 'error' in out:
self.logger.error(out['error'])
# update nonce if we fell behind
if "Nonce must be greater" in out['error']:
self._nonce = int(
out['error'].split('.')[0].split()[-1])
# raise RequestException so we try again
raise RequestException('PoloniexError ' + out['error'])
# connection timeout from poloniex
if "please try again" in out['error'].lower():
# raise RequestException so we try again
raise RequestException('PoloniexError ' + out['error'])
# raise other poloniex errors, ending retry loop
else:
raise PoloniexError(out['error'])
return out
@_retry
def marketTradeHist(self, currencyPair, start=False, end=False):
""" Returns the past 200 trades for a given market, or up to 50,000
trades between a range specified in UNIX timestamps by the "start" and
"end" parameters. """
if self.coach:
self.coach.wait()
args = {'command': 'returnTradeHistory',
'currencyPair': str(currencyPair).upper()}
if start:
args['start'] = start
if end:
args['end'] = end
ret = self.session.get(
'https://poloniex.com/public?' + _urlencode(args),
timeout=self.timeout)
# decode json
return self._handleReturned(ret)
class Poloniex(PoloniexBase):
# --PUBLIC COMMANDS-------------------------------------------------------
def returnTicker(self):
""" Returns the ticker for all markets. """
return self.__call__('returnTicker')
def return24hVolume(self):
""" Returns the 24-hour volume for all markets,
plus totals for primary currencies. """
return self.__call__('return24hVolume')
def returnOrderBook(self, currencyPair='all', depth=20):
""" Returns the order book for a given market as well as a sequence
number for use with the Push API and an indicator specifying whether the
market is frozen. (defaults to 'all' markets, at a 'depth' of 20 orders)
"""
return self.__call__('returnOrderBook', {
'currencyPair': str(currencyPair).upper(),
'depth': str(depth)
})
def returnChartData(self, currencyPair, period=False,
start=False, end=False):
""" Returns candlestick chart data. Parameters are "currencyPair",
"period" (candlestick period in seconds; valid values are 300, 900,
1800, 7200, 14400, and 86400), "start", and "end". "Start" and "end"
are given in UNIX timestamp format and used to specify the date range
for the data returned (default date range is start='1 day ago' to
end='now') """
if period not in [300, 900, 1800, 7200, 14400, 86400]:
raise PoloniexError("%s invalid candle period" % str(period))
if not start:
start = time() - self.DAY
if not end:
end = time()
return self.__call__('returnChartData', {
'currencyPair': str(currencyPair).upper(),
'period': str(period),
'start': str(start),
'end': str(end)
})
def returnCurrencies(self):
""" Returns information about all currencies. """
return self.__call__('returnCurrencies')
def returnLoanOrders(self, currency):
""" Returns the list of loan offers and demands for a given currency,
specified by the "currency" parameter """
return self.__call__('returnLoanOrders', {
'currency': str(currency).upper()})
# --PRIVATE COMMANDS------------------------------------------------------
def returnBalances(self):
""" Returns all of your available balances."""
return self.__call__('returnBalances')
def returnCompleteBalances(self, account='all'):
""" Returns all of your balances, including available balance, balance
on orders, and the estimated BTC value of your balance. By default,
this call is limited to your exchange account; set the "account"
parameter to "all" to include your margin and lending accounts. """
return self.__call__('returnCompleteBalances',
{'account': str(account)})
def returnDepositAddresses(self):
""" Returns all of your deposit addresses. """
return self.__call__('returnDepositAddresses')
def generateNewAddress(self, currency):
""" Generates a new deposit address for the currency specified by the
"currency" parameter. """
return self.__call__('generateNewAddress', {
'currency': currency})
def returnDepositsWithdrawals(self, start=False, end=False):
""" Returns your deposit and withdrawal history within a range,
specified by the "start" and "end" parameters, both of which should be
given as UNIX timestamps. (defaults to 1 month)"""
if not start:
start = time() - self.MONTH
if not end:
end = time()
args = {'start': str(start), 'end': str(end)}
return self.__call__('returnDepositsWithdrawals', args)
def returnOpenOrders(self, currencyPair='all'):
""" Returns your open orders for a given market, specified by the
"currencyPair" parameter, e.g. "BTC_XCP". Set "currencyPair" to
"all" to return open orders for all markets. """
return self.__call__('returnOpenOrders', {
'currencyPair': str(currencyPair).upper()})
def returnTradeHistory(
self, currencyPair='all', start=False, end=False, limit=None
):
""" Returns your trade history for a given market, specified by the
"currencyPair" POST parameter. You may specify "all" as the
currencyPair to receive your trade history for all markets. You may
optionally specify a range via "start" and/or "end" POST parameters,
given in UNIX timestamp format; if you do not specify a range, it will
be limited to one day. You may optionally limit the number of entries
returned using the "limit" parameter, up to a maximum of 10,000. If the
"limit" parameter is not specified, no more than 500 entries will be
returned. """
args = {'currencyPair': str(currencyPair).upper()}
if start:
args['start'] = start
if end:
args['end'] = end
if limit:
args['limit'] = limit
return self.__call__('returnTradeHistory', args)
def returnOrderTrades(self, orderNumber):
""" Returns all trades involving a given order, specified by the
"orderNumber" parameter. If no trades for the order have occurred
or you specify an order that does not belong to you, you will receive
an error. """
return self.__call__('returnOrderTrades', {
'orderNumber': str(orderNumber)})
def returnOrderStatus(self, orderNumber):
""" Returns the status of a given order, specified by the "orderNumber"
POST parameter. If the specified orderNumber is not open, or it is not
yours, you will receive an error. """
return self.__call__('returnOrderStatus', {
'orderNumber': str(orderNumber)})
def buy(self, currencyPair, rate, amount, orderType=False):
""" Places a limit buy order in a given market. Required parameters are
"currencyPair", "rate", and "amount". You may optionally set "orderType"
to "fillOrKill", "immediateOrCancel" or "postOnly". A fill-or-kill order
will either fill in its entirety or be completely aborted. An
immediate-or-cancel order can be partially or completely filled, but
any portion of the order that cannot be filled immediately will be
canceled rather than left on the order book. A post-only order will
only be placed if no portion of it fills immediately; this guarantees
you will never pay the taker fee on any part of the order that fills.
If successful, the method will return the order number. """
args = {
'currencyPair': str(currencyPair).upper(),
'rate': str(rate),
'amount': str(amount),
}
# order type specified?
if orderType:
possTypes = ['fillOrKill', 'immediateOrCancel', 'postOnly']
# check type
if not orderType in possTypes:
raise PoloniexError('Invalid orderType')
args[orderType] = 1
return self.__call__('buy', args)
def sell(self, currencyPair, rate, amount, orderType=False):
""" Places a sell order in a given market. Parameters and output are
the same as for the buy method. """
args = {
'currencyPair': str(currencyPair).upper(),
'rate': str(rate),
'amount': str(amount),
}
# order type specified?
if orderType:
possTypes = ['fillOrKill', 'immediateOrCancel', 'postOnly']
# check type
if not orderType in possTypes:
raise PoloniexError('Invalid orderType')
args[orderType] = 1
return self.__call__('sell', args)
def cancelOrder(self, orderNumber):
""" Cancels an order you have placed in a given market. Required
parameter is "orderNumber". """
return self.__call__('cancelOrder', {'orderNumber': str(orderNumber)})
def cancelAllOrders(self, currencyPair=None):
""" Cancels all open orders in a given market or, if no market is
provided, all open orders in all markets. Optional POST parameter is
"currencyPair". If successful, the method will return a success of 1
along with a json array of orderNumbers representing the orders that
were canceled. Please note that cancelAllOrders can only be called 1
time per 2 minutes. """
if not currencyPair:
return self.__call__('cancelAllOrders')
return self.__call__('cancelAllOrders',
{'currencyPair': str(currencyPair).upper()})
def moveOrder(self, orderNumber, rate, amount=False, orderType=False):
""" Cancels an order and places a new one of the same type in a single
atomic transaction, meaning either both operations will succeed or both
will fail. Required parameters are "orderNumber" and "rate"; you may
optionally specify "amount" if you wish to change the amount of the new
order. "postOnly" or "immediateOrCancel" may be specified as the
"orderType" param for exchange orders, but will have no effect on
margin orders. """
args = {
'orderNumber': str(orderNumber),
'rate': str(rate)
}
if amount:
args['amount'] = str(amount)
# order type specified?
if orderType:
possTypes = ['immediateOrCancel', 'postOnly']
# check type
if not orderType in possTypes:
raise PoloniexError('Invalid orderType: %s' % str(orderType))
args[orderType] = 1
return self.__call__('moveOrder', args)
def withdraw(self, currency, amount, address, paymentId=False, currencyToWithdrawAs=False ):
""" Immediately places a withdrawal for a given currency, with no email
confirmation. In order to use this method, the withdrawal privilege
must be enabled for your API key. Required parameters are
"currency", "amount", and "address". For XMR withdrawals, you may
optionally specify "paymentId". """
args = {
'currency': str(currency).upper(),
'amount': str(amount),
'address': str(address)
}
if paymentId:
args['paymentId'] = str(paymentId)
if currencyToWithdrawAs:
args['currencyToWithdrawAs'] = str(currencyToWithdrawAs)
return self.__call__('withdraw', args)
def returnFeeInfo(self):
""" If you are enrolled in the maker-taker fee schedule, returns your
current trading fees and trailing 30-day volume in BTC. This
information is updated once every 24 hours. """
return self.__call__('returnFeeInfo')
def returnAvailableAccountBalances(self, account=False):
""" Returns your balances sorted by account. You may optionally specify
the "account" parameter if you wish to fetch only the balances of
one account. Please note that balances in your margin account may not
be accessible if you have any open margin positions or orders. """
if account:
return self.__call__('returnAvailableAccountBalances',
{'account': account})
return self.__call__('returnAvailableAccountBalances')
def returnTradableBalances(self):
""" Returns your current tradable balances for each currency in each
market for which margin trading is enabled. Please note that these
balances may vary continually with market conditions. """
return self.__call__('returnTradableBalances')
def transferBalance(self, currency, amount,
fromAccount, toAccount, confirmed=False):
""" Transfers funds from one account to another (e.g. from your
exchange account to your margin account). Required parameters are
"currency", "amount", "fromAccount", and "toAccount" """
args = {
'currency': str(currency).upper(),
'amount': str(amount),
'fromAccount': str(fromAccount),
'toAccount': str(toAccount)
}
if confirmed:
args['confirmed'] = 1
return self.__call__('transferBalance', args)
def returnMarginAccountSummary(self):
""" Returns a summary of your entire margin account. This is the same
information you will find in the Margin Account section of the Margin
Trading page, under the Markets list """
return self.__call__('returnMarginAccountSummary')
def marginBuy(self, currencyPair, rate, amount, lendingRate=2):
""" Places a margin buy order in a given market. Required parameters are
"currencyPair", "rate", and "amount". You may optionally specify a
maximum lending rate using the "lendingRate" parameter (defaults to 2).
If successful, the method will return the order number and any trades
immediately resulting from your order. """
return self.__call__('marginBuy', {
'currencyPair': str(currencyPair).upper(),
'rate': str(rate),
'amount': str(amount),
'lendingRate': str(lendingRate)
})
def marginSell(self, currencyPair, rate, amount, lendingRate=2):
""" Places a margin sell order in a given market. Parameters and output
are the same as for the marginBuy method. """
return self.__call__('marginSell', {
'currencyPair': str(currencyPair).upper(),
'rate': str(rate),
'amount': str(amount),
'lendingRate': str(lendingRate)
})
def getMarginPosition(self, currencyPair='all'):
""" Returns information about your margin position in a given market,
specified by the "currencyPair" parameter. You may set
"currencyPair" to "all" if you wish to fetch all of your margin
positions at once. If you have no margin position in the specified
market, "type" will be set to "none". "liquidationPrice" is an
estimate, and does not necessarily represent the price at which an
actual forced liquidation will occur. If you have no liquidation price,
the value will be -1. (defaults to 'all')"""
return self.__call__('getMarginPosition', {
'currencyPair': str(currencyPair).upper()})
def closeMarginPosition(self, currencyPair):
""" Closes your margin position in a given market (specified by the
"currencyPair" parameter) using a market order. This call will also
return success if you do not have an open position in the specified
market. """
return self.__call__(
'closeMarginPosition', {'currencyPair': str(currencyPair).upper()})
def createLoanOffer(self, currency, amount,
lendingRate, autoRenew=0, duration=2):
""" Creates a loan offer for a given currency. Required parameters are
"currency", "amount", "lendingRate", "duration" (num of days, defaults
to 2), "autoRenew" (0 or 1, defaults to 0 'off'). """
return self.__call__('createLoanOffer', {
'currency': str(currency).upper(),
'amount': str(amount),
'duration': str(duration),
'autoRenew': str(autoRenew),
'lendingRate': str(lendingRate)
})
def cancelLoanOffer(self, orderNumber):
""" Cancels a loan offer specified by the "orderNumber" parameter. """
return self.__call__(
'cancelLoanOffer', {'orderNumber': str(orderNumber)})
def returnOpenLoanOffers(self):
""" Returns your open loan offers for each currency. """
return self.__call__('returnOpenLoanOffers')
def returnActiveLoans(self):
""" Returns your active loans for each currency."""
return self.__call__('returnActiveLoans')
def returnLendingHistory(self, start=False, end=False, limit=False):
""" Returns your lending history within a time range specified by the
"start" and "end" parameters as UNIX timestamps. "limit" may also
be specified to limit the number of rows returned. (defaults to the last
months history)"""
if not start:
start = time() - self.MONTH
if not end:
end = time()
args = {'start': str(start), 'end': str(end)}
if limit:
args['limit'] = str(limit)
return self.__call__('returnLendingHistory', args)
def toggleAutoRenew(self, orderNumber):
""" Toggles the autoRenew setting on an active loan, specified by the
"orderNumber" parameter. If successful, "message" will indicate
the new autoRenew setting. """
return self.__call__(
'toggleAutoRenew', {'orderNumber': str(orderNumber)})
class PoloniexSocketed(Poloniex):
""" Child class of Poloniex with support for the websocket api """
def __init__(self, key=None, secret=None, subscribe={}, start=False, *args, **kwargs):
super(PoloniexSocketed, self).__init__(key, secret, *args, **kwargs)
self.socket = WebSocketApp(url="wss://api2.poloniex.com/",
on_open=self.on_open,
on_message=self.on_message,
on_error=self.on_error,
on_close=self.on_close)
self._t = None
self._running = False
self.channels = {
'account': {'id': '1000'},
'ticker': {'id': '1002'},
'24hvolume': {'id': '1003'},
'heartbeat': {'id': '1010',
'callback': self.on_heartbeat},
}
# add each market to channels list by id
tick = self.returnTicker()
for market in tick:
self.channels[market] = {'id': str(tick[market]['id'])}
# handle init subscribes
if subscribe:
self.setSubscribes(**subscribe)
if start:
self.startws()
def _getChannelName(self, id):
return next(
(chan for chan in self.channels if self.channels[chan]['id'] == id),
False)
def on_open(self, *ws):
for chan in self.channels:
if 'sub' in self.channels[chan] and self.channels[chan]['sub']:
self.subscribe(chan)
def on_message(self, data):
if not self.jsonNums:
message = _loads(data, parse_float=str)
else:
message = _loads(data,
parse_float=self.jsonNums,
parse_int=self.jsonNums)
# catch errors
if 'error' in message:
return self.logger.error(message['error'])
chan = self._getChannelName(str(message[0]))
# handle sub/unsub
# skip heartbeats
if not chan == 'heartbeat':
# Subscribed
if message[1] == 1:
self.logger.debug('Subscribed to %s', chan)
# return False so no callback trigger
return False
# Unsubscribed
if message[1] == 0:
self.logger.debug('Unsubscribed to %s', chan)
# return False so no callback trigger
return False
if 'callback' in self.channels[chan]:
# activate chan callback
if chan == 'heartbeat':
# show whole heartbeat
self.socket._callback(self.channels[chan]['callback'], message)
elif chan in ['ticker', '24hvolume']:
# ticker and 24hvolume dont need seq id
message = message[2:]
else:
# show seq id for everything else
message = message[1:]
self.socket._callback(self.channels[chan]['callback'], message)
def on_error(self, error):
self.logger.error(error)
def on_close(self, *args):
self.logger.info('Websocket Closed')
def on_heartbeat(self, args):
self.logger.debug(args)
def setCallback(self, chan, callback):
""" Sets the callback function for <chan> """
if isinstance(chan, int):
chan = self._getChannelName(str(chan))
self.channels[chan]['callback'] = callback
def setSubscribes(self, **subs):
for sub in subs:
if not sub in self.channels:
self.logger.warning('Invalid channel: %s', sub)
else:
self.channels[sub]['sub'] = True
self.channels[sub]['callback'] = subs[sub]
def subscribe(self, chan, callback=None):
""" Sends the 'subscribe' command for <chan> """
if isinstance(chan, int):
chan = self._getChannelName(str(chan))
# account chan?
if chan == 'account':
# sending commands to 'account' requires a key, secret and nonce
if not self.key or not self.secret:
raise PoloniexError(
"self.key and self.secret needed for 'account' channel"
)
self.channels[chan]['sub'] = True
if callback:
self.channels[chan]['callback'] = callback
payload = {'nonce': self.nonce}
payload_encoded = _urlencode(payload)
sign = _new(
self.secret.encode('utf-8'),
payload_encoded.encode('utf-8'),
_sha512)
self.socket.send(_dumps({
'command': 'subscribe',
'channel': self.channels[chan]['id'],
'sign': sign.hexdigest(),
'key': self.key,
'payload': payload_encoded}))
else:
self.channels[chan]['sub'] = True
if callback:
self.channels[chan]['callback'] = callback
self.socket.send(_dumps({'command': 'subscribe',
'channel': self.channels[chan]['id']}))
def unsubscribe(self, chan):
""" Sends the 'unsubscribe' command for <chan> """
if isinstance(chan, int):
chan = self._getChannelName(str(chan))
# account chan?
if chan == 'account':
# sending commands to 'account' requires a key, secret and nonce
if not self.key or not self.secret:
raise PoloniexError(
"self.key and self.secret needed for 'account' channel"
)
self.channels[chan]['sub'] = False
payload = {'nonce': self.nonce}
payload_encoded = _urlencode(payload)
sign = _new(
self.secret.encode('utf-8'),
payload_encoded.encode('utf-8'),
_sha512)
self.socket.send(_dumps({
'command': 'unsubscribe',
'channel': self.channels[chan]['id'],
'sign': sign.hexdigest(),
'key': self.key,
'payload': payload_encoded}))
else:
self.channels[chan]['sub'] = False
self.socket.send(_dumps({'command': 'unsubscribe',
'channel': self.channels[chan]['id']}))
def startws(self, subscribe=False):
"""
Run the websocket in a thread, use 'subscribe' arg to subscribe
to channels on start
"""
self._t = Thread(target=self.socket.run_forever)
self._t.daemon = True
self._running = True
# set subscribes
if subscribe:
self.setSubscribes(**subscribe)
self._t.start()
self.logger.info('Websocket thread started')
def stopws(self, wait=1):
""" Stop/join the websocket thread """
self._running = False
# unsubscribe from subs
for chan in self.channels:
if 'sub' in self.channels[chan] and self.channels[chan]['sub']:
self.unsubscribe(chan)
sleep(wait)
try:
self.socket.close()
except Exception as e:
self.logger.exception(e)
self._t.join()
self.logger.info('Websocket thread stopped/joined')