krakenex documentation¶
Classes and methods¶
These are the classes defined by krakenex. Every class is in a separate module.
-
class
krakenex.
API
(key='', secret='', conn=None)[source]¶ Kraken.com cryptocurrency Exchange API.
-
__init__
(key='', secret='', conn=None)[source]¶ Create an object with authentication information.
Parameters: - key (str) – key required to make queries to the API
- secret (str) – private key used to sign API messages
- conn (krakenex.Connection) – connection TODO
-
__weakref__
¶ list of weak references to the object (if defined)
-
_query
(urlpath, req={}, conn=None, headers={})[source]¶ Low-level query handling.
Parameters: - urlpath (str) – API URL path sans host
- req (dict) – additional API request parameters
- conn (krakenex.Connection) – connection TODO
- headers (dict) – HTTPS headers
-
query_private
(method, req={}, conn=None)[source]¶ API queries that require a valid key/secret pair.
Parameters: - method (str) – API method name
- req (dict) – additional API request parameters
- conn (krakenex.Connection) – connection TODO
-
query_public
(method, req={}, conn=None)[source]¶ API queries that do not require a valid key/secret pair.
Parameters: - method (str) – API method name
- req (dict) – additional API request parameters
- conn (krakenex.Connection) – connection TODO
-
set_connection
(conn)[source]¶ Set an existing connection to be used as a default in queries.
Parameters: conn (krakenex.Connection) – connection TODO
-
-
class
krakenex.
Connection
(uri='api.kraken.com', timeout=30)[source]¶ Kraken.com connection handler.
-
__init__
(uri='api.kraken.com', timeout=30)[source]¶ Create an object for reusable connections.
Parameters: Returns: TODO
Raises: TODO
-
__weakref__
¶ list of weak references to the object (if defined)
-