Skip to content

API

Kraky API module for Kraken's API implementation

KrakyApi

Source code in kraky/api.py
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
class KrakyApi:
    def __init__(
        self,
        api_key: str = "",
        secret: str = "",
        tfa: bool = False,
        logging_level: str = "INFO",
    ) -> None:
        """
        Generate first an API key pair : https://support.kraken.com/hc/en-us/articles/360000919966-How-to-generate-an-API-key-pair-

        Arguments:
            api_key: The API key.
            secret: The Private key.
            tfa: Handle or not two-factor authentication (2FA)
            logging_level: Change the log level
        """
        self.base_url: str = "https://api.kraken.com"
        self.api_key = api_key
        self.secret = secret
        self.tfa = tfa
        self.otp: str = ""
        self.logger = get_module_logger(__name__, logging_level)

    def _sign_message(self, api_path: str, data: dict) -> str:
        # START
        # Taken from Httpx httpx/_content.py#L140
        plain_data = []
        for key, value in data.items():
            if isinstance(value, (list, tuple)):
                plain_data.extend(
                    [(key, primitive_value_to_str(item)) for item in value]
                )
            else:
                plain_data.append((key, primitive_value_to_str(value)))
        # END
        post_data = urlencode(plain_data)
        encoded = (str(data["nonce"]) + post_data).encode()
        message = api_path.encode() + hashlib.sha256(encoded).digest()
        signature = hmac.new(base64.b64decode(self.secret), message, hashlib.sha512)
        sig_digest = base64.b64encode(signature.digest())

        return sig_digest.decode()

    def set_otp(self, otp: str) -> None:
        """
        Set a OTP for private requests. Must be called each time you want to make a private request.

        Arguments:
            otp: two-factor password (two-factor must be enabled)
        """
        self.otp = otp

__init__(api_key='', secret='', tfa=False, logging_level='INFO')

Generate first an API key pair : https://support.kraken.com/hc/en-us/articles/360000919966-How-to-generate-an-API-key-pair-

Parameters:

Name Type Description Default
api_key str

The API key.

''
secret str

The Private key.

''
tfa bool

Handle or not two-factor authentication (2FA)

False
logging_level str

Change the log level

'INFO'
Source code in kraky/api.py
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def __init__(
    self,
    api_key: str = "",
    secret: str = "",
    tfa: bool = False,
    logging_level: str = "INFO",
) -> None:
    """
    Generate first an API key pair : https://support.kraken.com/hc/en-us/articles/360000919966-How-to-generate-an-API-key-pair-

    Arguments:
        api_key: The API key.
        secret: The Private key.
        tfa: Handle or not two-factor authentication (2FA)
        logging_level: Change the log level
    """
    self.base_url: str = "https://api.kraken.com"
    self.api_key = api_key
    self.secret = secret
    self.tfa = tfa
    self.otp: str = ""
    self.logger = get_module_logger(__name__, logging_level)

set_otp(otp)

Set a OTP for private requests. Must be called each time you want to make a private request.

Parameters:

Name Type Description Default
otp str

two-factor password (two-factor must be enabled)

required
Source code in kraky/api.py
63
64
65
66
67
68
69
70
def set_otp(self, otp: str) -> None:
    """
    Set a OTP for private requests. Must be called each time you want to make a private request.

    Arguments:
        otp: two-factor password (two-factor must be enabled)
    """
    self.otp = otp

KrakyApiAsyncClient

Bases: KrakyApi

Kraken API AsyncClient implementation

Source code in kraky/api.py
 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
class KrakyApiAsyncClient(KrakyApi):
    """Kraken API AsyncClient implementation"""

    async def _request(
        self, uri: str, headers: Optional[dict] = None, data: Optional[dict] = None
    ) -> dict:
        async with httpx.AsyncClient() as client:
            result = await client.post(uri, headers=headers, data=data)
            if result.status_code not in (200, 201, 202):
                raise KrakyApiError(result.status_code)
            # check for error
            if len(result.json()["error"]) > 0:
                raise KrakyApiError(result.json()["error"])
            return result.json()["result"]

    async def _public_request(self, endpoint: str, data: Optional[dict] = None) -> Any:
        uri = f"{self.base_url}/0/public/{endpoint}"
        return await self._request(uri, data=data)

    async def _private_request(self, endpoint: str, data: Optional[dict] = None) -> Any:
        if not data:
            data = {}
        data["nonce"] = int(time.time() * 1000)
        if self.tfa:
            data["otp"] = self.otp
        api_path = f"/0/private/{endpoint}"
        uri = f"{self.base_url}{api_path}"
        headers = {
            "API-Key": self.api_key,
            "API-Sign": self._sign_message(api_path, data),
        }
        return await self._request(uri, headers=headers, data=data)

    async def get_server_time(self, *args, **kwargs) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getServerTime

        Return:
            Server's time

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        return await self._public_request(endpoint="Time")

    async def get_system_status(self, *args, **kwargs) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getSystemStatus

        Return:
            System's status

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        return await self._public_request(endpoint="SystemStatus")

    async def get_asset_info(
        self, asset: Optional[str] = None, aclass: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getAssetInfo

        Arguments:
            asset: Comma delimited list of assets to get info on.
            aclass: Asset class. (optional, default: currency)

        Example:
            asset=XBT,ETH
            aclass=currency

        Return:
            Asset Info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._public_request(endpoint="Assets", data=data)

    async def get_tradable_asset_pairs(
        self, pair: Optional[str] = None, info: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getTradableAssetPairs

        Arguments:
            pair: Asset pairs to get data for
            info: Info to retrieve. (optional)

        Example:
            pair=XXBTCZUSD,XETHXXBT

        Return:
            Array of pair names and their info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._public_request(endpoint="AssetPairs", data=data)

    async def get_ticker_information(self, pair: str, *args, **kwargs) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getTickerInformation

        Arguments:
            pair: Asset pair to get data for

        Example:
            pair=XBTUSD

        Return:
            Asset Ticker Info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._public_request(endpoint="Ticker", data=data)

    async def get_ohlc_data(
        self,
        pair: str,
        interval: Optional[int] = None,
        since: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getOHLCData

        Arguments:
            pair: Asset pair to get data for
            interval: Time frame interval in minutes
            since: Return committed OHLC data since given ID

        Example:
            pair=XBTUSD
            interval=60
            since=1548111600

        Return:
            Array of pair name and OHLC data

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._public_request(endpoint="OHLC", data=data)

    async def get_order_book(
        self, pair: str, count: Optional[int] = None, *args, **kwargs
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getOrderBook

        Arguments:
            pair: Asset pair to get data for
            count: maximum number of asks/bids

        Example:
            pair=XBTUSD
            count=2

        Return:
            Array of pair name and market depth

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._public_request(endpoint="Depth", data=data)

    async def get_recent_trades(
        self, pair: str, since: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getRecentTrades

        Arguments:
            pair: Asset pair to get data for
            since: Return trade data since given timestamp

        Example:
            pair=XBTUSD
            since=1616663618

        Return:
            Array of pair name and recent trade data

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._public_request(endpoint="Trades", data=data)

    async def get_recent_spread_data(
        self, pair: str, since: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-recent-spread-data

        Arguments:
            pair: Asset pair to get data for
            since: Return spread data since given ID

        Example:
            pair=XBTUSD
            since=1548122302

        Return:
            Array of pair name and recent spread data

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._public_request(endpoint="Spread", data=data)

    async def get_account_balance(self, *args, **kwargs) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getAccountBalance

        Return:
            Account Balance

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        return await self._private_request(endpoint="Balance")

    async def get_trade_balance(
        self, aclass: Optional[str] = None, asset: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-trade-balance

        Arguments:
            aclass: asset class (optional): currency (default)
            asset: base asset used to determine balance (default = ZUSD)

        Return:
            Array of trade balance info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="TradeBalance", data=data)

    async def get_open_orders(
        self, trades: bool = False, userref: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-open-orders

        Arguments:
            trades: whether or not to include trades in output (optional.  default = false)
            userref: restrict results to given user reference id (optional)

        Return:
            Array of order info in open array with txid as the key

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="OpenOrders", data=data)

    async def get_closed_orders(
        self,
        trades: bool = False,
        userref: Optional[str] = None,
        start: Optional[str] = None,
        end: Optional[str] = None,
        ofs: Optional[str] = None,
        closetime: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-closed-orders

        Arguments:
            trades: whether or not to include trades in output (optional.  default = false)
            userref: restrict results to given user reference id (optional)
            start: starting unix timestamp or order tx id of results (optional.  exclusive)
            end: ending unix timestamp or order tx id of results (optional.  inclusive)
            ofs: result offset
            closetime: which time to use (optional) open close both (default)

        Return: Array of order info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="ClosedOrders", data=data)

    async def query_orders_info(
        self,
        txid: str,
        trades: bool = False,
        userref: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#query-orders-info

        Arguments:
            txid: comma delimited list of transaction ids to query info about (50 maximum)
            trades: whether or not to include trades in output (optional.  default = false)
            userref: restrict results to given user reference id (optional)

        Return:
            Associative array of orders info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="TradesHistory", data=data)

    async def get_trades_history(
        self,
        type: Optional[str] = None,
        trades: bool = False,
        start: Optional[str] = None,
        end: Optional[str] = None,
        ofs: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-trades-history

        Arguments:
            type: type of trade (optional)
            trades: whether or not to include trades related to position in output (optional.  default = false)
            start: starting unix timestamp or trade tx id of results (optional.  exclusive)
            end: ending unix timestamp or trade tx id of results (optional.  inclusive)
            ofs: result offset

        Return:
            Array of trade info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="TradesHistory", data=data)

    async def query_trades_info(
        self, txid: str, trades: bool = False, *args, **kwargs
    ) -> dict:
        """
        https://www.kraken.com/features/api#query-trades-info

        Arguments:
            txid: comma delimited list of transaction ids to query info about (20 maximum)
            trades: whether or not to include trades related to position in output (optional.  default = false)

        Return:
            Associative array of trades info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="QueryTrades", data=data)

    async def get_open_positions(
        self,
        txid: str,
        docalcs: bool = False,
        consolidation: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-open-positions

        Arguments:
            txid: comma delimited list of transaction ids to restrict output to
            docalcs: whether or not to include profit/loss calculations (optional.  default = false)
            consolidation: what to consolidate the positions data around (optional.)

        Return:
            Associative array of open position info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="OpenPositions", data=data)

    async def get_ledgers_info(
        self,
        aclass: Optional[str] = None,
        asset: Optional[str] = None,
        type: Optional[str] = None,
        start: Optional[str] = None,
        end: Optional[str] = None,
        ofs: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-ledgers-info

        Arguments:
            aclass: asset class (optional): currency (default)
            asset: comma delimited list of assets to restrict output to (optional.  default = all)
            type: type of ledger to retrieve (optional)
            start: starting unix timestamp or ledger id of results (optional.  exclusive)
            end: ending unix timestamp or ledger id of results (optional.  inclusive)
            ofs: result offset

        Return:
            Associative array of ledgers info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="Ledgers", data=data)

    async def query_ledgers(self, id: str, *args, **kwargs) -> dict:
        """
        https://www.kraken.com/features/api#query-ledgers

        Arguments:
            id: comma delimited list of ledger ids to query info about (20 maximum)

        Return:
            Associative array of ledgers info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="QueryLedgers", data=data)

    async def get_trade_volume(
        self,
        pair: Optional[str] = None,
        fee_info: Optional[bool] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-trade-volume

        Arguments:
            pair: comma delimited list of asset pairs to get fee info on (optional)
            fee_info: whether or not to include fee info in results (optional)

        Return:
            Associative array

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="TradeVolume", data=data)

    async def request_export_report(
        self,
        description: str,
        report: str,
        format: Optional[str] = None,
        fields: Optional[str] = None,
        asset: Optional[str] = None,
        starttm: Optional[str] = None,
        endtm: Optional[str] = None,
        *args,
        **kwargs,
    ) -> str:
        """
        https://www.kraken.com/features/api#add-history-export

        Arguments:
            description: report description info
            report: report type (trades/ledgers)
            format: (CSV/TSV) (optional.  default = CSV)
            fields: comma delimited list of fields to include in report (optional.  default = all)
            asset: comma delimited list of assets to restrict output to (optional.  default = all)
            starttm: report start time (optional.  default = one year before now)
            endtm: report end time (optional.  default = now)

        Return:
            id: report id

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="AddExport", data=data)

    async def get_export_statuses(self, report: str, *args, **kwargs) -> dict:
        """
        https://www.kraken.com/features/api#add-history-export

        Arguments:
            report: report type (trades/ledgers)

        Return:
            id: report id

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="ExportStatus", data=data)

    async def get_export_report(self, id: str, *args, **kwargs) -> Any:
        """
        https://www.kraken.com/features/api#get-history-export
        Arguments:
            id: report id

        Return:
            Binary zip archive containing the report

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="RetrieveExport", data=data)

    async def remove_export_report(self, type: str, id: str, *args, **kwargs) -> str:
        """
        https://www.kraken.com/features/api#remove-history-export

        Arguments:
            type: remove type (cancel/delete)
            id: report id

        Return:
            Result of call

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="RemoveExport", data=data)

    async def add_standard_order(
        self,
        pair: str,
        type: str,
        ordertype: str,
        volume: float,
        price: Optional[float] = None,
        price2: Optional[float] = None,
        leverage: Optional[float] = None,
        oflags: Optional[str] = None,
        starttm: Optional[str] = None,
        expiretm: Optional[str] = None,
        userref: Optional[str] = None,
        validate: Optional[str] = None,
        close_ordertype: Optional[str] = None,
        close_price: Optional[float] = None,
        close_price2: Optional[float] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#add-standard-order

        Arguments:
            pair: asset pair
            type: type of order (buy/sell)
            ordertype: order type
            price: price (optional.  dependent upon ordertype)
            price2: secondary price (optional.  dependent upon ordertype)
            volume: order volume in lots
            leverage: amount of leverage desired (optional.  default = none)
            oflags: comma delimited list of order flags (optional)
            starttm: scheduled start time (optional)
            expiretm: expiration time (optional)
            userref: user reference id.  32-bit signed number.  (optional)
            validate: validate inputs only.  do not submit order (optional)
            close_ordertype: order type
            close_price: price
            close_price2: secondary price

        Return:
            descr: order description info
            txid: array of transaction ids for order (if order was added successfully)

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="AddOrder", data=data)

    async def cancel_open_order(self, txid: str, *args, **kwargs) -> dict:
        """
        https://www.kraken.com/features/api#cancel-open-order

        Arguments:
            txid: transaction id

        Return:
            count: number of orders canceled
            pending: if set, order(s) is/are pending cancellation

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="CancelOrder", data=data)

    async def cancel_all_open_orders(self, *args, **kwargs) -> dict:
        """
        https://www.kraken.com/features/api#cancel-all-open-orders

        Return:
            count: number of orders canceled

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return await self._private_request(endpoint="CancelAll", data=data)

    async def get_last_price(self, pair: str, *args, **kwargs) -> float:
        """
        Get last price for given pair

        Arguments:
            pair: currency to get last price

        Return:
            Last price in float

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        ohlc = await self.get_ohlc_data(pair)
        return float(list(ohlc.values())[0][-1][4])

    async def get_web_sockets_token(self, *args, **kwargs) -> str:
        """
        https://www.kraken.com/features/api#ws-auth

        Return:
            WS token

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        result = await self._private_request(endpoint="GetWebSocketsToken")
        return result["token"]

add_standard_order(pair, type, ordertype, volume, price=None, price2=None, leverage=None, oflags=None, starttm=None, expiretm=None, userref=None, validate=None, close_ordertype=None, close_price=None, close_price2=None, *args, **kwargs) async

https://www.kraken.com/features/api#add-standard-order

Parameters:

Name Type Description Default
pair str

asset pair

required
type str

type of order (buy/sell)

required
ordertype str

order type

required
price Optional[float]

price (optional. dependent upon ordertype)

None
price2 Optional[float]

secondary price (optional. dependent upon ordertype)

None
volume float

order volume in lots

required
leverage Optional[float]

amount of leverage desired (optional. default = none)

None
oflags Optional[str]

comma delimited list of order flags (optional)

None
starttm Optional[str]

scheduled start time (optional)

None
expiretm Optional[str]

expiration time (optional)

None
userref Optional[str]

user reference id. 32-bit signed number. (optional)

None
validate Optional[str]

validate inputs only. do not submit order (optional)

None
close_ordertype Optional[str]

order type

None
close_price Optional[float]

price

None
close_price2 Optional[float]

secondary price

None
Return

descr: order description info txid: array of transaction ids for order (if order was added successfully)

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def add_standard_order(
    self,
    pair: str,
    type: str,
    ordertype: str,
    volume: float,
    price: Optional[float] = None,
    price2: Optional[float] = None,
    leverage: Optional[float] = None,
    oflags: Optional[str] = None,
    starttm: Optional[str] = None,
    expiretm: Optional[str] = None,
    userref: Optional[str] = None,
    validate: Optional[str] = None,
    close_ordertype: Optional[str] = None,
    close_price: Optional[float] = None,
    close_price2: Optional[float] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#add-standard-order

    Arguments:
        pair: asset pair
        type: type of order (buy/sell)
        ordertype: order type
        price: price (optional.  dependent upon ordertype)
        price2: secondary price (optional.  dependent upon ordertype)
        volume: order volume in lots
        leverage: amount of leverage desired (optional.  default = none)
        oflags: comma delimited list of order flags (optional)
        starttm: scheduled start time (optional)
        expiretm: expiration time (optional)
        userref: user reference id.  32-bit signed number.  (optional)
        validate: validate inputs only.  do not submit order (optional)
        close_ordertype: order type
        close_price: price
        close_price2: secondary price

    Return:
        descr: order description info
        txid: array of transaction ids for order (if order was added successfully)

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="AddOrder", data=data)

cancel_all_open_orders(*args, **kwargs) async

https://www.kraken.com/features/api#cancel-all-open-orders

Return

count: number of orders canceled

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
async def cancel_all_open_orders(self, *args, **kwargs) -> dict:
    """
    https://www.kraken.com/features/api#cancel-all-open-orders

    Return:
        count: number of orders canceled

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="CancelAll", data=data)

cancel_open_order(txid, *args, **kwargs) async

https://www.kraken.com/features/api#cancel-open-order

Parameters:

Name Type Description Default
txid str

transaction id

required
Return

count: number of orders canceled pending: if set, order(s) is/are pending cancellation

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
async def cancel_open_order(self, txid: str, *args, **kwargs) -> dict:
    """
    https://www.kraken.com/features/api#cancel-open-order

    Arguments:
        txid: transaction id

    Return:
        count: number of orders canceled
        pending: if set, order(s) is/are pending cancellation

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="CancelOrder", data=data)

get_account_balance(*args, **kwargs) async

https://docs.kraken.com/rest/#operation/getAccountBalance

Return

Account Balance

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
321
322
323
324
325
326
327
328
329
330
331
async def get_account_balance(self, *args, **kwargs) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getAccountBalance

    Return:
        Account Balance

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    return await self._private_request(endpoint="Balance")

get_asset_info(asset=None, aclass=None, *args, **kwargs) async

https://docs.kraken.com/rest/#operation/getAssetInfo

Parameters:

Name Type Description Default
asset Optional[str]

Comma delimited list of assets to get info on.

None
aclass Optional[str]

Asset class. (optional, default: currency)

None
Example

asset=XBT,ETH aclass=currency

Return

Asset Info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_asset_info(
    self, asset: Optional[str] = None, aclass: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getAssetInfo

    Arguments:
        asset: Comma delimited list of assets to get info on.
        aclass: Asset class. (optional, default: currency)

    Example:
        asset=XBT,ETH
        aclass=currency

    Return:
        Asset Info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._public_request(endpoint="Assets", data=data)

get_closed_orders(trades=False, userref=None, start=None, end=None, ofs=None, closetime=None, *args, **kwargs) async

https://www.kraken.com/features/api#get-closed-orders

Parameters:

Name Type Description Default
trades bool

whether or not to include trades in output (optional. default = false)

False
userref Optional[str]

restrict results to given user reference id (optional)

None
start Optional[str]

starting unix timestamp or order tx id of results (optional. exclusive)

None
end Optional[str]

ending unix timestamp or order tx id of results (optional. inclusive)

None
ofs Optional[str]

result offset

None
closetime Optional[str]

which time to use (optional) open close both (default)

None

Return: Array of order info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_closed_orders(
    self,
    trades: bool = False,
    userref: Optional[str] = None,
    start: Optional[str] = None,
    end: Optional[str] = None,
    ofs: Optional[str] = None,
    closetime: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-closed-orders

    Arguments:
        trades: whether or not to include trades in output (optional.  default = false)
        userref: restrict results to given user reference id (optional)
        start: starting unix timestamp or order tx id of results (optional.  exclusive)
        end: ending unix timestamp or order tx id of results (optional.  inclusive)
        ofs: result offset
        closetime: which time to use (optional) open close both (default)

    Return: Array of order info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="ClosedOrders", data=data)

get_export_report(id, *args, **kwargs) async

https://www.kraken.com/features/api#get-history-export Arguments: id: report id

Return

Binary zip archive containing the report

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
async def get_export_report(self, id: str, *args, **kwargs) -> Any:
    """
    https://www.kraken.com/features/api#get-history-export
    Arguments:
        id: report id

    Return:
        Binary zip archive containing the report

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="RetrieveExport", data=data)

get_export_statuses(report, *args, **kwargs) async

https://www.kraken.com/features/api#add-history-export

Parameters:

Name Type Description Default
report str

report type (trades/ledgers)

required
Return

id: report id

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
async def get_export_statuses(self, report: str, *args, **kwargs) -> dict:
    """
    https://www.kraken.com/features/api#add-history-export

    Arguments:
        report: report type (trades/ledgers)

    Return:
        id: report id

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="ExportStatus", data=data)

get_last_price(pair, *args, **kwargs) async

Get last price for given pair

Parameters:

Name Type Description Default
pair str

currency to get last price

required
Return

Last price in float

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
async def get_last_price(self, pair: str, *args, **kwargs) -> float:
    """
    Get last price for given pair

    Arguments:
        pair: currency to get last price

    Return:
        Last price in float

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    ohlc = await self.get_ohlc_data(pair)
    return float(list(ohlc.values())[0][-1][4])

get_ledgers_info(aclass=None, asset=None, type=None, start=None, end=None, ofs=None, *args, **kwargs) async

https://www.kraken.com/features/api#get-ledgers-info

Parameters:

Name Type Description Default
aclass Optional[str]

asset class (optional): currency (default)

None
asset Optional[str]

comma delimited list of assets to restrict output to (optional. default = all)

None
type Optional[str]

type of ledger to retrieve (optional)

None
start Optional[str]

starting unix timestamp or ledger id of results (optional. exclusive)

None
end Optional[str]

ending unix timestamp or ledger id of results (optional. inclusive)

None
ofs Optional[str]

result offset

None
Return

Associative array of ledgers info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_ledgers_info(
    self,
    aclass: Optional[str] = None,
    asset: Optional[str] = None,
    type: Optional[str] = None,
    start: Optional[str] = None,
    end: Optional[str] = None,
    ofs: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-ledgers-info

    Arguments:
        aclass: asset class (optional): currency (default)
        asset: comma delimited list of assets to restrict output to (optional.  default = all)
        type: type of ledger to retrieve (optional)
        start: starting unix timestamp or ledger id of results (optional.  exclusive)
        end: ending unix timestamp or ledger id of results (optional.  inclusive)
        ofs: result offset

    Return:
        Associative array of ledgers info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="Ledgers", data=data)

get_ohlc_data(pair, interval=None, since=None, *args, **kwargs) async

https://docs.kraken.com/rest/#operation/getOHLCData

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
interval Optional[int]

Time frame interval in minutes

None
since Optional[str]

Return committed OHLC data since given ID

None
Example

pair=XBTUSD interval=60 since=1548111600

Return

Array of pair name and OHLC data

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_ohlc_data(
    self,
    pair: str,
    interval: Optional[int] = None,
    since: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getOHLCData

    Arguments:
        pair: Asset pair to get data for
        interval: Time frame interval in minutes
        since: Return committed OHLC data since given ID

    Example:
        pair=XBTUSD
        interval=60
        since=1548111600

    Return:
        Array of pair name and OHLC data

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._public_request(endpoint="OHLC", data=data)

get_open_orders(trades=False, userref=None, *args, **kwargs) async

https://www.kraken.com/features/api#get-open-orders

Parameters:

Name Type Description Default
trades bool

whether or not to include trades in output (optional. default = false)

False
userref Optional[str]

restrict results to given user reference id (optional)

None
Return

Array of order info in open array with txid as the key

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
async def get_open_orders(
    self, trades: bool = False, userref: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://www.kraken.com/features/api#get-open-orders

    Arguments:
        trades: whether or not to include trades in output (optional.  default = false)
        userref: restrict results to given user reference id (optional)

    Return:
        Array of order info in open array with txid as the key

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="OpenOrders", data=data)

get_open_positions(txid, docalcs=False, consolidation=None, *args, **kwargs) async

https://www.kraken.com/features/api#get-open-positions

Parameters:

Name Type Description Default
txid str

comma delimited list of transaction ids to restrict output to

required
docalcs bool

whether or not to include profit/loss calculations (optional. default = false)

False
consolidation Optional[str]

what to consolidate the positions data around (optional.)

None
Return

Associative array of open position info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_open_positions(
    self,
    txid: str,
    docalcs: bool = False,
    consolidation: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-open-positions

    Arguments:
        txid: comma delimited list of transaction ids to restrict output to
        docalcs: whether or not to include profit/loss calculations (optional.  default = false)
        consolidation: what to consolidate the positions data around (optional.)

    Return:
        Associative array of open position info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="OpenPositions", data=data)

get_order_book(pair, count=None, *args, **kwargs) async

https://docs.kraken.com/rest/#operation/getOrderBook

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
count Optional[int]

maximum number of asks/bids

None
Example

pair=XBTUSD count=2

Return

Array of pair name and market depth

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_order_book(
    self, pair: str, count: Optional[int] = None, *args, **kwargs
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getOrderBook

    Arguments:
        pair: Asset pair to get data for
        count: maximum number of asks/bids

    Example:
        pair=XBTUSD
        count=2

    Return:
        Array of pair name and market depth

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._public_request(endpoint="Depth", data=data)

get_recent_spread_data(pair, since=None, *args, **kwargs) async

https://www.kraken.com/features/api#get-recent-spread-data

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
since Optional[str]

Return spread data since given ID

None
Example

pair=XBTUSD since=1548122302

Return

Array of pair name and recent spread data

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_recent_spread_data(
    self, pair: str, since: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://www.kraken.com/features/api#get-recent-spread-data

    Arguments:
        pair: Asset pair to get data for
        since: Return spread data since given ID

    Example:
        pair=XBTUSD
        since=1548122302

    Return:
        Array of pair name and recent spread data

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._public_request(endpoint="Spread", data=data)

get_recent_trades(pair, since=None, *args, **kwargs) async

https://docs.kraken.com/rest/#operation/getRecentTrades

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
since Optional[str]

Return trade data since given timestamp

None
Example

pair=XBTUSD since=1616663618

Return

Array of pair name and recent trade data

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_recent_trades(
    self, pair: str, since: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getRecentTrades

    Arguments:
        pair: Asset pair to get data for
        since: Return trade data since given timestamp

    Example:
        pair=XBTUSD
        since=1616663618

    Return:
        Array of pair name and recent trade data

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._public_request(endpoint="Trades", data=data)

get_server_time(*args, **kwargs) async

https://docs.kraken.com/rest/#operation/getServerTime

Return

Server's time

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
106
107
108
109
110
111
112
113
114
115
116
async def get_server_time(self, *args, **kwargs) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getServerTime

    Return:
        Server's time

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    return await self._public_request(endpoint="Time")

get_system_status(*args, **kwargs) async

https://docs.kraken.com/rest/#operation/getSystemStatus

Return

System's status

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
118
119
120
121
122
123
124
125
126
127
128
async def get_system_status(self, *args, **kwargs) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getSystemStatus

    Return:
        System's status

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    return await self._public_request(endpoint="SystemStatus")

get_ticker_information(pair, *args, **kwargs) async

https://docs.kraken.com/rest/#operation/getTickerInformation

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
Example

pair=XBTUSD

Return

Asset Ticker Info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
async def get_ticker_information(self, pair: str, *args, **kwargs) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getTickerInformation

    Arguments:
        pair: Asset pair to get data for

    Example:
        pair=XBTUSD

    Return:
        Asset Ticker Info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._public_request(endpoint="Ticker", data=data)

get_tradable_asset_pairs(pair=None, info=None, *args, **kwargs) async

https://docs.kraken.com/rest/#operation/getTradableAssetPairs

Parameters:

Name Type Description Default
pair Optional[str]

Asset pairs to get data for

None
info Optional[str]

Info to retrieve. (optional)

None
Example

pair=XXBTCZUSD,XETHXXBT

Return

Array of pair names and their info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_tradable_asset_pairs(
    self, pair: Optional[str] = None, info: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getTradableAssetPairs

    Arguments:
        pair: Asset pairs to get data for
        info: Info to retrieve. (optional)

    Example:
        pair=XXBTCZUSD,XETHXXBT

    Return:
        Array of pair names and their info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._public_request(endpoint="AssetPairs", data=data)

get_trade_balance(aclass=None, asset=None, *args, **kwargs) async

https://www.kraken.com/features/api#get-trade-balance

Parameters:

Name Type Description Default
aclass Optional[str]

asset class (optional): currency (default)

None
asset Optional[str]

base asset used to determine balance (default = ZUSD)

None
Return

Array of trade balance info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
async def get_trade_balance(
    self, aclass: Optional[str] = None, asset: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://www.kraken.com/features/api#get-trade-balance

    Arguments:
        aclass: asset class (optional): currency (default)
        asset: base asset used to determine balance (default = ZUSD)

    Return:
        Array of trade balance info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="TradeBalance", data=data)

get_trade_volume(pair=None, fee_info=None, *args, **kwargs) async

https://www.kraken.com/features/api#get-trade-volume

Parameters:

Name Type Description Default
pair Optional[str]

comma delimited list of asset pairs to get fee info on (optional)

None
fee_info Optional[bool]

whether or not to include fee info in results (optional)

None
Return

Associative array

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_trade_volume(
    self,
    pair: Optional[str] = None,
    fee_info: Optional[bool] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-trade-volume

    Arguments:
        pair: comma delimited list of asset pairs to get fee info on (optional)
        fee_info: whether or not to include fee info in results (optional)

    Return:
        Associative array

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="TradeVolume", data=data)

get_trades_history(type=None, trades=False, start=None, end=None, ofs=None, *args, **kwargs) async

https://www.kraken.com/features/api#get-trades-history

Parameters:

Name Type Description Default
type Optional[str]

type of trade (optional)

None
trades bool

whether or not to include trades related to position in output (optional. default = false)

False
start Optional[str]

starting unix timestamp or trade tx id of results (optional. exclusive)

None
end Optional[str]

ending unix timestamp or trade tx id of results (optional. inclusive)

None
ofs Optional[str]

result offset

None
Return

Array of trade info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def get_trades_history(
    self,
    type: Optional[str] = None,
    trades: bool = False,
    start: Optional[str] = None,
    end: Optional[str] = None,
    ofs: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-trades-history

    Arguments:
        type: type of trade (optional)
        trades: whether or not to include trades related to position in output (optional.  default = false)
        start: starting unix timestamp or trade tx id of results (optional.  exclusive)
        end: ending unix timestamp or trade tx id of results (optional.  inclusive)
        ofs: result offset

    Return:
        Array of trade info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="TradesHistory", data=data)

get_web_sockets_token(*args, **kwargs) async

https://www.kraken.com/features/api#ws-auth

Return

WS token

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
814
815
816
817
818
819
820
821
822
823
824
825
async def get_web_sockets_token(self, *args, **kwargs) -> str:
    """
    https://www.kraken.com/features/api#ws-auth

    Return:
        WS token

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    result = await self._private_request(endpoint="GetWebSocketsToken")
    return result["token"]

query_ledgers(id, *args, **kwargs) async

https://www.kraken.com/features/api#query-ledgers

Parameters:

Name Type Description Default
id str

comma delimited list of ledger ids to query info about (20 maximum)

required
Return

Associative array of ledgers info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
async def query_ledgers(self, id: str, *args, **kwargs) -> dict:
    """
    https://www.kraken.com/features/api#query-ledgers

    Arguments:
        id: comma delimited list of ledger ids to query info about (20 maximum)

    Return:
        Associative array of ledgers info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="QueryLedgers", data=data)

query_orders_info(txid, trades=False, userref=None, *args, **kwargs) async

https://www.kraken.com/features/api#query-orders-info

Parameters:

Name Type Description Default
txid str

comma delimited list of transaction ids to query info about (50 maximum)

required
trades bool

whether or not to include trades in output (optional. default = false)

False
userref Optional[str]

restrict results to given user reference id (optional)

None
Return

Associative array of orders info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def query_orders_info(
    self,
    txid: str,
    trades: bool = False,
    userref: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#query-orders-info

    Arguments:
        txid: comma delimited list of transaction ids to query info about (50 maximum)
        trades: whether or not to include trades in output (optional.  default = false)
        userref: restrict results to given user reference id (optional)

    Return:
        Associative array of orders info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="TradesHistory", data=data)

query_trades_info(txid, trades=False, *args, **kwargs) async

https://www.kraken.com/features/api#query-trades-info

Parameters:

Name Type Description Default
txid str

comma delimited list of transaction ids to query info about (20 maximum)

required
trades bool

whether or not to include trades related to position in output (optional. default = false)

False
Return

Associative array of trades info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
async def query_trades_info(
    self, txid: str, trades: bool = False, *args, **kwargs
) -> dict:
    """
    https://www.kraken.com/features/api#query-trades-info

    Arguments:
        txid: comma delimited list of transaction ids to query info about (20 maximum)
        trades: whether or not to include trades related to position in output (optional.  default = false)

    Return:
        Associative array of trades info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="QueryTrades", data=data)

remove_export_report(type, id, *args, **kwargs) async

https://www.kraken.com/features/api#remove-history-export

Parameters:

Name Type Description Default
type str

remove type (cancel/delete)

required
id str

report id

required
Return

Result of call

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
async def remove_export_report(self, type: str, id: str, *args, **kwargs) -> str:
    """
    https://www.kraken.com/features/api#remove-history-export

    Arguments:
        type: remove type (cancel/delete)
        id: report id

    Return:
        Result of call

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="RemoveExport", data=data)

request_export_report(description, report, format=None, fields=None, asset=None, starttm=None, endtm=None, *args, **kwargs) async

https://www.kraken.com/features/api#add-history-export

Parameters:

Name Type Description Default
description str

report description info

required
report str

report type (trades/ledgers)

required
format Optional[str]

(CSV/TSV) (optional. default = CSV)

None
fields Optional[str]

comma delimited list of fields to include in report (optional. default = all)

None
asset Optional[str]

comma delimited list of assets to restrict output to (optional. default = all)

None
starttm Optional[str]

report start time (optional. default = one year before now)

None
endtm Optional[str]

report end time (optional. default = now)

None
Return

id: report id

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
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
async def request_export_report(
    self,
    description: str,
    report: str,
    format: Optional[str] = None,
    fields: Optional[str] = None,
    asset: Optional[str] = None,
    starttm: Optional[str] = None,
    endtm: Optional[str] = None,
    *args,
    **kwargs,
) -> str:
    """
    https://www.kraken.com/features/api#add-history-export

    Arguments:
        description: report description info
        report: report type (trades/ledgers)
        format: (CSV/TSV) (optional.  default = CSV)
        fields: comma delimited list of fields to include in report (optional.  default = all)
        asset: comma delimited list of assets to restrict output to (optional.  default = all)
        starttm: report start time (optional.  default = one year before now)
        endtm: report end time (optional.  default = now)

    Return:
        id: report id

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return await self._private_request(endpoint="AddExport", data=data)

KrakyApiClient

Bases: KrakyApi

Source code in kraky/api.py
 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
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
class KrakyApiClient(KrakyApi):
    def _request(
        self, uri: str, headers: Optional[dict] = None, data: Optional[dict] = None
    ) -> dict:
        with httpx.Client() as client:
            result = client.post(uri, headers=headers, data=data)
            if result.status_code not in (200, 201, 202):
                raise KrakyApiError(result.status_code)
            # check for error
            if len(result.json()["error"]) > 0:
                raise KrakyApiError(result.json()["error"])
            return result.json()["result"]

    def _public_request(self, endpoint: str, data: Optional[dict] = None) -> Any:
        uri = f"{self.base_url}/0/public/{endpoint}"
        return self._request(uri, data=data)

    def _private_request(self, endpoint: str, data: Optional[dict] = None) -> Any:
        if not data:
            data = {}
        data["nonce"] = int(time.time() * 1000)
        if self.tfa:
            data["otp"] = self.otp
        api_path = f"/0/private/{endpoint}"
        uri = f"{self.base_url}{api_path}"
        headers = {
            "API-Key": self.api_key,
            "API-Sign": self._sign_message(api_path, data),
        }
        return self._request(uri, headers=headers, data=data)

    def get_server_time(self, *args, **kwargs) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getServerTime

        Return:
            Server's time

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        return self._public_request(endpoint="Time")

    def get_system_status(self, *args, **kwargs) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getSystemStatus

        Return:
            System's status

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        return self._public_request(endpoint="SystemStatus")

    def get_asset_info(
        self, asset: Optional[str] = None, aclass: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getAssetInfo

        Arguments:
            asset: Comma delimited list of assets to get info on.
            aclass: Asset class. (optional, default: currency)

        Example:
            asset=XBT,ETH
            aclass=currency

        Return:
            Asset Info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._public_request(endpoint="Assets", data=data)

    def get_tradable_asset_pairs(
        self, pair: Optional[str] = None, info: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getTradableAssetPairs

        Arguments:
            pair: Asset pairs to get data for
            info: Info to retrieve. (optional)

        Example:
            pair=XXBTCZUSD,XETHXXBT

        Return:
            Array of pair names and their info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._public_request(endpoint="AssetPairs", data=data)

    def get_ticker_information(self, pair: str, *args, **kwargs) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getTickerInformation

        Arguments:
            pair: Asset pair to get data for

        Example:
            pair=XBTUSD

        Return:
            Asset Ticker Info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._public_request(endpoint="Ticker", data=data)

    def get_ohlc_data(
        self,
        pair: str,
        interval: Optional[int] = None,
        since: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getOHLCData

        Arguments:
            pair: Asset pair to get data for
            interval: Time frame interval in minutes
            since: Return committed OHLC data since given ID

        Example:
            pair=XBTUSD
            interval=60
            since=1548111600

        Return:
            Array of pair name and OHLC data

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._public_request(endpoint="OHLC", data=data)

    def get_order_book(
        self, pair: str, count: Optional[int] = None, *args, **kwargs
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getOrderBook

        Arguments:
            pair: Asset pair to get data for
            count: maximum number of asks/bids

        Example:
            pair=XBTUSD
            count=2

        Return:
            Array of pair name and market depth

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._public_request(endpoint="Depth", data=data)

    def get_recent_trades(
        self, pair: str, since: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getRecentTrades

        Arguments:
            pair: Asset pair to get data for
            since: Return trade data since given timestamp

        Example:
            pair=XBTUSD
            since=1616663618

        Return:
            Array of pair name and recent trade data

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._public_request(endpoint="Trades", data=data)

    def get_recent_spread_data(
        self, pair: str, since: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-recent-spread-data

        Arguments:
            pair: Asset pair to get data for
            since: Return spread data since given ID

        Example:
            pair=XBTUSD
            since=1548122302

        Return:
            Array of pair name and recent spread data

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._public_request(endpoint="Spread", data=data)

    def get_account_balance(self, *args, **kwargs) -> dict:
        """
        https://docs.kraken.com/rest/#operation/getAccountBalance

        Return:
            Account Balance

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        return self._private_request(endpoint="Balance")

    def get_trade_balance(
        self, aclass: Optional[str] = None, asset: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-trade-balance

        Arguments:
            aclass: asset class (optional): currency (default)
            asset: base asset used to determine balance (default = ZUSD)

        Return:
            Array of trade balance info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="TradeBalance", data=data)

    def get_open_orders(
        self, trades: bool = False, userref: Optional[str] = None, *args, **kwargs
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-open-orders

        Arguments:
            trades: whether or not to include trades in output (optional.  default = false)
            userref: restrict results to given user reference id (optional)

        Return:
            Array of order info in open array with txid as the key

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="OpenOrders", data=data)

    def get_closed_orders(
        self,
        trades: bool = False,
        userref: Optional[str] = None,
        start: Optional[str] = None,
        end: Optional[str] = None,
        ofs: Optional[str] = None,
        closetime: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-closed-orders

        Arguments:
            trades: whether or not to include trades in output (optional.  default = false)
            userref: restrict results to given user reference id (optional)
            start: starting unix timestamp or order tx id of results (optional.  exclusive)
            end: ending unix timestamp or order tx id of results (optional.  inclusive)
            ofs: result offset
            closetime: which time to use (optional) open close both (default)

        Return: Array of order info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="ClosedOrders", data=data)

    def query_orders_info(
        self,
        txid: str,
        trades: bool = False,
        userref: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#query-orders-info

        Arguments:
            txid: comma delimited list of transaction ids to query info about (50 maximum)
            trades: whether or not to include trades in output (optional.  default = false)
            userref: restrict results to given user reference id (optional)

        Return:
            Associative array of orders info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="TradesHistory", data=data)

    def get_trades_history(
        self,
        type: Optional[str] = None,
        trades: bool = False,
        start: Optional[str] = None,
        end: Optional[str] = None,
        ofs: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-trades-history

        Arguments:
            type: type of trade (optional)
            trades: whether or not to include trades related to position in output (optional.  default = false)
            start: starting unix timestamp or trade tx id of results (optional.  exclusive)
            end: ending unix timestamp or trade tx id of results (optional.  inclusive)
            ofs: result offset

        Return:
            Array of trade info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="TradesHistory", data=data)

    def query_trades_info(
        self, txid: str, trades: bool = False, *args, **kwargs
    ) -> dict:
        """
        https://www.kraken.com/features/api#query-trades-info

        Arguments:
            txid: comma delimited list of transaction ids to query info about (20 maximum)
            trades: whether or not to include trades related to position in output (optional.  default = false)

        Return:
            Associative array of trades info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="QueryTrades", data=data)

    def get_open_positions(
        self,
        txid: str,
        docalcs: bool = False,
        consolidation: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-open-positions

        Arguments:
            txid: comma delimited list of transaction ids to restrict output to
            docalcs: whether or not to include profit/loss calculations (optional.  default = false)
            consolidation: what to consolidate the positions data around (optional.)

        Return:
            Associative array of open position info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="OpenPositions", data=data)

    def get_ledgers_info(
        self,
        aclass: Optional[str] = None,
        asset: Optional[str] = None,
        type: Optional[str] = None,
        start: Optional[str] = None,
        end: Optional[str] = None,
        ofs: Optional[str] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-ledgers-info

        Arguments:
            aclass: asset class (optional): currency (default)
            asset: comma delimited list of assets to restrict output to (optional.  default = all)
            type: type of ledger to retrieve (optional)
            start: starting unix timestamp or ledger id of results (optional.  exclusive)
            end: ending unix timestamp or ledger id of results (optional.  inclusive)
            ofs: result offset

        Return:
            Associative array of ledgers info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="Ledgers", data=data)

    def query_ledgers(self, id: str, *args, **kwargs) -> dict:
        """
        https://www.kraken.com/features/api#query-ledgers

        Arguments:
            id: comma delimited list of ledger ids to query info about (20 maximum)

        Return:
            Associative array of ledgers info

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="QueryLedgers", data=data)

    def get_trade_volume(
        self,
        pair: Optional[str] = None,
        fee_info: Optional[bool] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#get-trade-volume

        Arguments:
            pair: comma delimited list of asset pairs to get fee info on (optional)
            fee_info: whether or not to include fee info in results (optional)

        Return:
            Associative array

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="TradeVolume", data=data)

    def request_export_report(
        self,
        description: str,
        report: str,
        format: Optional[str] = None,
        fields: Optional[str] = None,
        asset: Optional[str] = None,
        starttm: Optional[str] = None,
        endtm: Optional[str] = None,
        *args,
        **kwargs,
    ) -> str:
        """
        https://www.kraken.com/features/api#add-history-export

        Arguments:
            description: report description info
            report: report type (trades/ledgers)
            format: (CSV/TSV) (optional.  default = CSV)
            fields: comma delimited list of fields to include in report (optional.  default = all)
            asset: comma delimited list of assets to restrict output to (optional.  default = all)
            starttm: report start time (optional.  default = one year before now)
            endtm: report end time (optional.  default = now)

        Return:
            id: report id

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="AddExport", data=data)

    def get_export_statuses(self, report: str, *args, **kwargs) -> dict:
        """
        https://www.kraken.com/features/api#add-history-export

        Arguments:
            report: report type (trades/ledgers)

        Return:
            id: report id

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="ExportStatus", data=data)

    def get_export_report(self, id: str, *args, **kwargs) -> Any:
        """
        https://www.kraken.com/features/api#get-history-export
        Arguments:
            id: report id

        Return:
            Binary zip archive containing the report

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="RetrieveExport", data=data)

    def remove_export_report(self, type: str, id: str, *args, **kwargs) -> str:
        """
        https://www.kraken.com/features/api#remove-history-export

        Arguments:
            type: remove type (cancel/delete)
            id: report id

        Return:
            Result of call

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="RemoveExport", data=data)

    def add_standard_order(
        self,
        pair: str,
        type: str,
        ordertype: str,
        volume: float,
        price: Optional[float] = None,
        price2: Optional[float] = None,
        leverage: Optional[float] = None,
        oflags: Optional[str] = None,
        starttm: Optional[str] = None,
        expiretm: Optional[str] = None,
        userref: Optional[str] = None,
        validate: Optional[str] = None,
        close_ordertype: Optional[str] = None,
        close_price: Optional[float] = None,
        close_price2: Optional[float] = None,
        *args,
        **kwargs,
    ) -> dict:
        """
        https://www.kraken.com/features/api#add-standard-order

        Arguments:
            pair: asset pair
            type: type of order (buy/sell)
            ordertype: order type
            price: price (optional.  dependent upon ordertype)
            price2: secondary price (optional.  dependent upon ordertype)
            volume: order volume in lots
            leverage: amount of leverage desired (optional.  default = none)
            oflags: comma delimited list of order flags (optional)
            starttm: scheduled start time (optional)
            expiretm: expiration time (optional)
            userref: user reference id.  32-bit signed number.  (optional)
            validate: validate inputs only.  do not submit order (optional)
            close_ordertype: order type
            close_price: price
            close_price2: secondary price

        Return:
            descr: order description info
            txid: array of transaction ids for order (if order was added successfully)

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="AddOrder", data=data)

    def cancel_open_order(self, txid: str, *args, **kwargs) -> dict:
        """
        https://www.kraken.com/features/api#cancel-open-order

        Arguments:
            txid: transaction id

        Return:
            count: number of orders canceled
            pending: if set, order(s) is/are pending cancellation

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="CancelOrder", data=data)

    def cancel_all_open_orders(self, *args, **kwargs) -> dict:
        """
        https://www.kraken.com/features/api#cancel-all-open-orders

        Return:
            count: number of orders canceled

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        data = {
            arg: value
            for arg, value in locals().items()
            if arg != "self" and value is not None
        }
        return self._private_request(endpoint="CancelAll", data=data)

    def get_last_price(self, pair: str, *args, **kwargs) -> float:
        """
        Get last price for given pair

        Arguments:
            pair: currency to get last price

        Return:
            Last price in float

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        ohlc = self.get_ohlc_data(pair)
        return float(list(ohlc.values())[0][-1][4])

    def get_web_sockets_token(self, *args, **kwargs) -> str:
        """
        https://www.kraken.com/features/api#ws-auth

        Return:
            WS token

        Raises:
            KrakyApiError: If the error key's value is not empty
        """
        result = self._private_request(endpoint="GetWebSocketsToken")
        return result["token"]

add_standard_order(pair, type, ordertype, volume, price=None, price2=None, leverage=None, oflags=None, starttm=None, expiretm=None, userref=None, validate=None, close_ordertype=None, close_price=None, close_price2=None, *args, **kwargs)

https://www.kraken.com/features/api#add-standard-order

Parameters:

Name Type Description Default
pair str

asset pair

required
type str

type of order (buy/sell)

required
ordertype str

order type

required
price Optional[float]

price (optional. dependent upon ordertype)

None
price2 Optional[float]

secondary price (optional. dependent upon ordertype)

None
volume float

order volume in lots

required
leverage Optional[float]

amount of leverage desired (optional. default = none)

None
oflags Optional[str]

comma delimited list of order flags (optional)

None
starttm Optional[str]

scheduled start time (optional)

None
expiretm Optional[str]

expiration time (optional)

None
userref Optional[str]

user reference id. 32-bit signed number. (optional)

None
validate Optional[str]

validate inputs only. do not submit order (optional)

None
close_ordertype Optional[str]

order type

None
close_price Optional[float]

price

None
close_price2 Optional[float]

secondary price

None
Return

descr: order description info txid: array of transaction ids for order (if order was added successfully)

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
def add_standard_order(
    self,
    pair: str,
    type: str,
    ordertype: str,
    volume: float,
    price: Optional[float] = None,
    price2: Optional[float] = None,
    leverage: Optional[float] = None,
    oflags: Optional[str] = None,
    starttm: Optional[str] = None,
    expiretm: Optional[str] = None,
    userref: Optional[str] = None,
    validate: Optional[str] = None,
    close_ordertype: Optional[str] = None,
    close_price: Optional[float] = None,
    close_price2: Optional[float] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#add-standard-order

    Arguments:
        pair: asset pair
        type: type of order (buy/sell)
        ordertype: order type
        price: price (optional.  dependent upon ordertype)
        price2: secondary price (optional.  dependent upon ordertype)
        volume: order volume in lots
        leverage: amount of leverage desired (optional.  default = none)
        oflags: comma delimited list of order flags (optional)
        starttm: scheduled start time (optional)
        expiretm: expiration time (optional)
        userref: user reference id.  32-bit signed number.  (optional)
        validate: validate inputs only.  do not submit order (optional)
        close_ordertype: order type
        close_price: price
        close_price2: secondary price

    Return:
        descr: order description info
        txid: array of transaction ids for order (if order was added successfully)

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="AddOrder", data=data)

cancel_all_open_orders(*args, **kwargs)

https://www.kraken.com/features/api#cancel-all-open-orders

Return

count: number of orders canceled

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
def cancel_all_open_orders(self, *args, **kwargs) -> dict:
    """
    https://www.kraken.com/features/api#cancel-all-open-orders

    Return:
        count: number of orders canceled

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="CancelAll", data=data)

cancel_open_order(txid, *args, **kwargs)

https://www.kraken.com/features/api#cancel-open-order

Parameters:

Name Type Description Default
txid str

transaction id

required
Return

count: number of orders canceled pending: if set, order(s) is/are pending cancellation

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
def cancel_open_order(self, txid: str, *args, **kwargs) -> dict:
    """
    https://www.kraken.com/features/api#cancel-open-order

    Arguments:
        txid: transaction id

    Return:
        count: number of orders canceled
        pending: if set, order(s) is/are pending cancellation

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="CancelOrder", data=data)

get_account_balance(*args, **kwargs)

https://docs.kraken.com/rest/#operation/getAccountBalance

Return

Account Balance

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
def get_account_balance(self, *args, **kwargs) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getAccountBalance

    Return:
        Account Balance

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    return self._private_request(endpoint="Balance")

get_asset_info(asset=None, aclass=None, *args, **kwargs)

https://docs.kraken.com/rest/#operation/getAssetInfo

Parameters:

Name Type Description Default
asset Optional[str]

Comma delimited list of assets to get info on.

None
aclass Optional[str]

Asset class. (optional, default: currency)

None
Example

asset=XBT,ETH aclass=currency

Return

Asset Info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
def get_asset_info(
    self, asset: Optional[str] = None, aclass: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getAssetInfo

    Arguments:
        asset: Comma delimited list of assets to get info on.
        aclass: Asset class. (optional, default: currency)

    Example:
        asset=XBT,ETH
        aclass=currency

    Return:
        Asset Info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._public_request(endpoint="Assets", data=data)

get_closed_orders(trades=False, userref=None, start=None, end=None, ofs=None, closetime=None, *args, **kwargs)

https://www.kraken.com/features/api#get-closed-orders

Parameters:

Name Type Description Default
trades bool

whether or not to include trades in output (optional. default = false)

False
userref Optional[str]

restrict results to given user reference id (optional)

None
start Optional[str]

starting unix timestamp or order tx id of results (optional. exclusive)

None
end Optional[str]

ending unix timestamp or order tx id of results (optional. inclusive)

None
ofs Optional[str]

result offset

None
closetime Optional[str]

which time to use (optional) open close both (default)

None

Return: Array of order info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
def get_closed_orders(
    self,
    trades: bool = False,
    userref: Optional[str] = None,
    start: Optional[str] = None,
    end: Optional[str] = None,
    ofs: Optional[str] = None,
    closetime: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-closed-orders

    Arguments:
        trades: whether or not to include trades in output (optional.  default = false)
        userref: restrict results to given user reference id (optional)
        start: starting unix timestamp or order tx id of results (optional.  exclusive)
        end: ending unix timestamp or order tx id of results (optional.  inclusive)
        ofs: result offset
        closetime: which time to use (optional) open close both (default)

    Return: Array of order info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="ClosedOrders", data=data)

get_export_report(id, *args, **kwargs)

https://www.kraken.com/features/api#get-history-export Arguments: id: report id

Return

Binary zip archive containing the report

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
def get_export_report(self, id: str, *args, **kwargs) -> Any:
    """
    https://www.kraken.com/features/api#get-history-export
    Arguments:
        id: report id

    Return:
        Binary zip archive containing the report

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="RetrieveExport", data=data)

get_export_statuses(report, *args, **kwargs)

https://www.kraken.com/features/api#add-history-export

Parameters:

Name Type Description Default
report str

report type (trades/ledgers)

required
Return

id: report id

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
def get_export_statuses(self, report: str, *args, **kwargs) -> dict:
    """
    https://www.kraken.com/features/api#add-history-export

    Arguments:
        report: report type (trades/ledgers)

    Return:
        id: report id

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="ExportStatus", data=data)

get_last_price(pair, *args, **kwargs)

Get last price for given pair

Parameters:

Name Type Description Default
pair str

currency to get last price

required
Return

Last price in float

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
def get_last_price(self, pair: str, *args, **kwargs) -> float:
    """
    Get last price for given pair

    Arguments:
        pair: currency to get last price

    Return:
        Last price in float

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    ohlc = self.get_ohlc_data(pair)
    return float(list(ohlc.values())[0][-1][4])

get_ledgers_info(aclass=None, asset=None, type=None, start=None, end=None, ofs=None, *args, **kwargs)

https://www.kraken.com/features/api#get-ledgers-info

Parameters:

Name Type Description Default
aclass Optional[str]

asset class (optional): currency (default)

None
asset Optional[str]

comma delimited list of assets to restrict output to (optional. default = all)

None
type Optional[str]

type of ledger to retrieve (optional)

None
start Optional[str]

starting unix timestamp or ledger id of results (optional. exclusive)

None
end Optional[str]

ending unix timestamp or ledger id of results (optional. inclusive)

None
ofs Optional[str]

result offset

None
Return

Associative array of ledgers info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
def get_ledgers_info(
    self,
    aclass: Optional[str] = None,
    asset: Optional[str] = None,
    type: Optional[str] = None,
    start: Optional[str] = None,
    end: Optional[str] = None,
    ofs: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-ledgers-info

    Arguments:
        aclass: asset class (optional): currency (default)
        asset: comma delimited list of assets to restrict output to (optional.  default = all)
        type: type of ledger to retrieve (optional)
        start: starting unix timestamp or ledger id of results (optional.  exclusive)
        end: ending unix timestamp or ledger id of results (optional.  inclusive)
        ofs: result offset

    Return:
        Associative array of ledgers info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="Ledgers", data=data)

get_ohlc_data(pair, interval=None, since=None, *args, **kwargs)

https://docs.kraken.com/rest/#operation/getOHLCData

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
interval Optional[int]

Time frame interval in minutes

None
since Optional[str]

Return committed OHLC data since given ID

None
Example

pair=XBTUSD interval=60 since=1548111600

Return

Array of pair name and OHLC data

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
def get_ohlc_data(
    self,
    pair: str,
    interval: Optional[int] = None,
    since: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getOHLCData

    Arguments:
        pair: Asset pair to get data for
        interval: Time frame interval in minutes
        since: Return committed OHLC data since given ID

    Example:
        pair=XBTUSD
        interval=60
        since=1548111600

    Return:
        Array of pair name and OHLC data

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._public_request(endpoint="OHLC", data=data)

get_open_orders(trades=False, userref=None, *args, **kwargs)

https://www.kraken.com/features/api#get-open-orders

Parameters:

Name Type Description Default
trades bool

whether or not to include trades in output (optional. default = false)

False
userref Optional[str]

restrict results to given user reference id (optional)

None
Return

Array of order info in open array with txid as the key

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
def get_open_orders(
    self, trades: bool = False, userref: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://www.kraken.com/features/api#get-open-orders

    Arguments:
        trades: whether or not to include trades in output (optional.  default = false)
        userref: restrict results to given user reference id (optional)

    Return:
        Array of order info in open array with txid as the key

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="OpenOrders", data=data)

get_open_positions(txid, docalcs=False, consolidation=None, *args, **kwargs)

https://www.kraken.com/features/api#get-open-positions

Parameters:

Name Type Description Default
txid str

comma delimited list of transaction ids to restrict output to

required
docalcs bool

whether or not to include profit/loss calculations (optional. default = false)

False
consolidation Optional[str]

what to consolidate the positions data around (optional.)

None
Return

Associative array of open position info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
def get_open_positions(
    self,
    txid: str,
    docalcs: bool = False,
    consolidation: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-open-positions

    Arguments:
        txid: comma delimited list of transaction ids to restrict output to
        docalcs: whether or not to include profit/loss calculations (optional.  default = false)
        consolidation: what to consolidate the positions data around (optional.)

    Return:
        Associative array of open position info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="OpenPositions", data=data)

get_order_book(pair, count=None, *args, **kwargs)

https://docs.kraken.com/rest/#operation/getOrderBook

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
count Optional[int]

maximum number of asks/bids

None
Example

pair=XBTUSD count=2

Return

Array of pair name and market depth

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
def get_order_book(
    self, pair: str, count: Optional[int] = None, *args, **kwargs
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getOrderBook

    Arguments:
        pair: Asset pair to get data for
        count: maximum number of asks/bids

    Example:
        pair=XBTUSD
        count=2

    Return:
        Array of pair name and market depth

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._public_request(endpoint="Depth", data=data)

get_recent_spread_data(pair, since=None, *args, **kwargs)

https://www.kraken.com/features/api#get-recent-spread-data

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
since Optional[str]

Return spread data since given ID

None
Example

pair=XBTUSD since=1548122302

Return

Array of pair name and recent spread data

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
def get_recent_spread_data(
    self, pair: str, since: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://www.kraken.com/features/api#get-recent-spread-data

    Arguments:
        pair: Asset pair to get data for
        since: Return spread data since given ID

    Example:
        pair=XBTUSD
        since=1548122302

    Return:
        Array of pair name and recent spread data

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._public_request(endpoint="Spread", data=data)

get_recent_trades(pair, since=None, *args, **kwargs)

https://docs.kraken.com/rest/#operation/getRecentTrades

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
since Optional[str]

Return trade data since given timestamp

None
Example

pair=XBTUSD since=1616663618

Return

Array of pair name and recent trade data

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
def get_recent_trades(
    self, pair: str, since: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getRecentTrades

    Arguments:
        pair: Asset pair to get data for
        since: Return trade data since given timestamp

    Example:
        pair=XBTUSD
        since=1616663618

    Return:
        Array of pair name and recent trade data

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._public_request(endpoint="Trades", data=data)

get_server_time(*args, **kwargs)

https://docs.kraken.com/rest/#operation/getServerTime

Return

Server's time

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
859
860
861
862
863
864
865
866
867
868
869
def get_server_time(self, *args, **kwargs) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getServerTime

    Return:
        Server's time

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    return self._public_request(endpoint="Time")

get_system_status(*args, **kwargs)

https://docs.kraken.com/rest/#operation/getSystemStatus

Return

System's status

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
871
872
873
874
875
876
877
878
879
880
881
def get_system_status(self, *args, **kwargs) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getSystemStatus

    Return:
        System's status

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    return self._public_request(endpoint="SystemStatus")

get_ticker_information(pair, *args, **kwargs)

https://docs.kraken.com/rest/#operation/getTickerInformation

Parameters:

Name Type Description Default
pair str

Asset pair to get data for

required
Example

pair=XBTUSD

Return

Asset Ticker Info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
def get_ticker_information(self, pair: str, *args, **kwargs) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getTickerInformation

    Arguments:
        pair: Asset pair to get data for

    Example:
        pair=XBTUSD

    Return:
        Asset Ticker Info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._public_request(endpoint="Ticker", data=data)

get_tradable_asset_pairs(pair=None, info=None, *args, **kwargs)

https://docs.kraken.com/rest/#operation/getTradableAssetPairs

Parameters:

Name Type Description Default
pair Optional[str]

Asset pairs to get data for

None
info Optional[str]

Info to retrieve. (optional)

None
Example

pair=XXBTCZUSD,XETHXXBT

Return

Array of pair names and their info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
def get_tradable_asset_pairs(
    self, pair: Optional[str] = None, info: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://docs.kraken.com/rest/#operation/getTradableAssetPairs

    Arguments:
        pair: Asset pairs to get data for
        info: Info to retrieve. (optional)

    Example:
        pair=XXBTCZUSD,XETHXXBT

    Return:
        Array of pair names and their info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._public_request(endpoint="AssetPairs", data=data)

get_trade_balance(aclass=None, asset=None, *args, **kwargs)

https://www.kraken.com/features/api#get-trade-balance

Parameters:

Name Type Description Default
aclass Optional[str]

asset class (optional): currency (default)

None
asset Optional[str]

base asset used to determine balance (default = ZUSD)

None
Return

Array of trade balance info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
def get_trade_balance(
    self, aclass: Optional[str] = None, asset: Optional[str] = None, *args, **kwargs
) -> dict:
    """
    https://www.kraken.com/features/api#get-trade-balance

    Arguments:
        aclass: asset class (optional): currency (default)
        asset: base asset used to determine balance (default = ZUSD)

    Return:
        Array of trade balance info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="TradeBalance", data=data)

get_trade_volume(pair=None, fee_info=None, *args, **kwargs)

https://www.kraken.com/features/api#get-trade-volume

Parameters:

Name Type Description Default
pair Optional[str]

comma delimited list of asset pairs to get fee info on (optional)

None
fee_info Optional[bool]

whether or not to include fee info in results (optional)

None
Return

Associative array

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
def get_trade_volume(
    self,
    pair: Optional[str] = None,
    fee_info: Optional[bool] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-trade-volume

    Arguments:
        pair: comma delimited list of asset pairs to get fee info on (optional)
        fee_info: whether or not to include fee info in results (optional)

    Return:
        Associative array

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="TradeVolume", data=data)

get_trades_history(type=None, trades=False, start=None, end=None, ofs=None, *args, **kwargs)

https://www.kraken.com/features/api#get-trades-history

Parameters:

Name Type Description Default
type Optional[str]

type of trade (optional)

None
trades bool

whether or not to include trades related to position in output (optional. default = false)

False
start Optional[str]

starting unix timestamp or trade tx id of results (optional. exclusive)

None
end Optional[str]

ending unix timestamp or trade tx id of results (optional. inclusive)

None
ofs Optional[str]

result offset

None
Return

Array of trade info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
def get_trades_history(
    self,
    type: Optional[str] = None,
    trades: bool = False,
    start: Optional[str] = None,
    end: Optional[str] = None,
    ofs: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#get-trades-history

    Arguments:
        type: type of trade (optional)
        trades: whether or not to include trades related to position in output (optional.  default = false)
        start: starting unix timestamp or trade tx id of results (optional.  exclusive)
        end: ending unix timestamp or trade tx id of results (optional.  inclusive)
        ofs: result offset

    Return:
        Array of trade info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="TradesHistory", data=data)

get_web_sockets_token(*args, **kwargs)

https://www.kraken.com/features/api#ws-auth

Return

WS token

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
def get_web_sockets_token(self, *args, **kwargs) -> str:
    """
    https://www.kraken.com/features/api#ws-auth

    Return:
        WS token

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    result = self._private_request(endpoint="GetWebSocketsToken")
    return result["token"]

query_ledgers(id, *args, **kwargs)

https://www.kraken.com/features/api#query-ledgers

Parameters:

Name Type Description Default
id str

comma delimited list of ledger ids to query info about (20 maximum)

required
Return

Associative array of ledgers info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
def query_ledgers(self, id: str, *args, **kwargs) -> dict:
    """
    https://www.kraken.com/features/api#query-ledgers

    Arguments:
        id: comma delimited list of ledger ids to query info about (20 maximum)

    Return:
        Associative array of ledgers info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="QueryLedgers", data=data)

query_orders_info(txid, trades=False, userref=None, *args, **kwargs)

https://www.kraken.com/features/api#query-orders-info

Parameters:

Name Type Description Default
txid str

comma delimited list of transaction ids to query info about (50 maximum)

required
trades bool

whether or not to include trades in output (optional. default = false)

False
userref Optional[str]

restrict results to given user reference id (optional)

None
Return

Associative array of orders info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
def query_orders_info(
    self,
    txid: str,
    trades: bool = False,
    userref: Optional[str] = None,
    *args,
    **kwargs,
) -> dict:
    """
    https://www.kraken.com/features/api#query-orders-info

    Arguments:
        txid: comma delimited list of transaction ids to query info about (50 maximum)
        trades: whether or not to include trades in output (optional.  default = false)
        userref: restrict results to given user reference id (optional)

    Return:
        Associative array of orders info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="TradesHistory", data=data)

query_trades_info(txid, trades=False, *args, **kwargs)

https://www.kraken.com/features/api#query-trades-info

Parameters:

Name Type Description Default
txid str

comma delimited list of transaction ids to query info about (20 maximum)

required
trades bool

whether or not to include trades related to position in output (optional. default = false)

False
Return

Associative array of trades info

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
def query_trades_info(
    self, txid: str, trades: bool = False, *args, **kwargs
) -> dict:
    """
    https://www.kraken.com/features/api#query-trades-info

    Arguments:
        txid: comma delimited list of transaction ids to query info about (20 maximum)
        trades: whether or not to include trades related to position in output (optional.  default = false)

    Return:
        Associative array of trades info

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="QueryTrades", data=data)

remove_export_report(type, id, *args, **kwargs)

https://www.kraken.com/features/api#remove-history-export

Parameters:

Name Type Description Default
type str

remove type (cancel/delete)

required
id str

report id

required
Return

Result of call

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
def remove_export_report(self, type: str, id: str, *args, **kwargs) -> str:
    """
    https://www.kraken.com/features/api#remove-history-export

    Arguments:
        type: remove type (cancel/delete)
        id: report id

    Return:
        Result of call

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="RemoveExport", data=data)

request_export_report(description, report, format=None, fields=None, asset=None, starttm=None, endtm=None, *args, **kwargs)

https://www.kraken.com/features/api#add-history-export

Parameters:

Name Type Description Default
description str

report description info

required
report str

report type (trades/ledgers)

required
format Optional[str]

(CSV/TSV) (optional. default = CSV)

None
fields Optional[str]

comma delimited list of fields to include in report (optional. default = all)

None
asset Optional[str]

comma delimited list of assets to restrict output to (optional. default = all)

None
starttm Optional[str]

report start time (optional. default = one year before now)

None
endtm Optional[str]

report end time (optional. default = now)

None
Return

id: report id

Raises:

Type Description
KrakyApiError

If the error key's value is not empty

Source code in kraky/api.py
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
def request_export_report(
    self,
    description: str,
    report: str,
    format: Optional[str] = None,
    fields: Optional[str] = None,
    asset: Optional[str] = None,
    starttm: Optional[str] = None,
    endtm: Optional[str] = None,
    *args,
    **kwargs,
) -> str:
    """
    https://www.kraken.com/features/api#add-history-export

    Arguments:
        description: report description info
        report: report type (trades/ledgers)
        format: (CSV/TSV) (optional.  default = CSV)
        fields: comma delimited list of fields to include in report (optional.  default = all)
        asset: comma delimited list of assets to restrict output to (optional.  default = all)
        starttm: report start time (optional.  default = one year before now)
        endtm: report end time (optional.  default = now)

    Return:
        id: report id

    Raises:
        KrakyApiError: If the error key's value is not empty
    """
    data = {
        arg: value
        for arg, value in locals().items()
        if arg != "self" and value is not None
    }
    return self._private_request(endpoint="AddExport", data=data)

KrakyApiError

Bases: Exception

Raise an exception when Kraken's API raise an error

Source code in kraky/api.py
15
16
class KrakyApiError(Exception):
    """Raise an exception when Kraken's API raise an error"""