{"id":25425299,"url":"https://github.com/veox/python3-krakenex","last_synced_at":"2025-05-14T06:11:41.383Z","repository":{"id":15855455,"uuid":"18595716","full_name":"veox/python3-krakenex","owner":"veox","description":"REST Exchange API for Kraken.com, Python 3","archived":false,"fork":false,"pushed_at":"2024-07-01T18:50:10.000Z","size":241,"stargazers_count":720,"open_issues_count":23,"forks_count":231,"subscribers_count":50,"default_branch":"master","last_synced_at":"2025-04-14T14:59:36.165Z","etag":null,"topics":["api-client","cryptocurrency","exchange-api","kraken","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/veox.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE-GPLv3.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-04-09T12:04:44.000Z","updated_at":"2025-03-08T04:18:28.000Z","dependencies_parsed_at":"2024-06-18T12:39:04.246Z","dependency_job_id":"29f28867-0135-44c6-9d48-27f081910f4c","html_url":"https://github.com/veox/python3-krakenex","commit_stats":{"total_commits":215,"total_committers":13,"mean_commits":16.53846153846154,"dds":"0.13023255813953494","last_synced_commit":"158219dfd14cbd2eb7950ee4adf593d0a289a508"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veox%2Fpython3-krakenex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veox%2Fpython3-krakenex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veox%2Fpython3-krakenex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veox%2Fpython3-krakenex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/veox","download_url":"https://codeload.github.com/veox/python3-krakenex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254080038,"owners_count":22011310,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","cryptocurrency","exchange-api","kraken","python"],"created_at":"2025-02-16T23:45:40.996Z","updated_at":"2025-05-14T06:11:41.296Z","avatar_url":"https://github.com/veox.png","language":"Python","readme":".. image:: https://travis-ci.org/veox/python3-krakenex.svg?branch=master\n   :alt: Latest Travis continuous integration build\n   :target: https://travis-ci.org/veox/python3-krakenex\n.. image:: https://readthedocs.org/projects/python3-krakenex/badge/\n   :alt: Read latest documentation\n   :target: https://python3-krakenex.readthedocs.io/\n.. image:: https://badge.fury.io/py/krakenex.svg\n   :alt: Latest PyPI release\n   :target: https://badge.fury.io/py/krakenex\n.. image:: https://badges.gitter.im/python3-krakenex/Lobby.svg\n   :alt: Development discussion at https://gitter.im/python3-krakenex/Lobby\n   :target: https://gitter.im/python3-krakenex/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge\n\n\n`krakenex`\n==========\n\nKraken.com exchange REST API, Python 3 package.\n\nThis package is intentionally as lean as possible, and only\nprovides a minimal interface to the `Kraken`_ cryptocurrency\nexchange.\n\nIntended for developers, not traders.\n\n.. _Kraken: https://kraken.com/\n\n\nSoftware that uses ``krakenex``\n-------------------------------\n\nLibraries\n^^^^^^^^^\n\n* pykrakenapi_ - nicely wraps API methods into regular Python methods, and JSON\n  responses into Pandas_ dataframes (available on PyPI!)\n* CurrencyViewer_ - short python3 framework for data extraction, conversion, and\n  smooth development experience (available on PyPI!)\n\n.. _pykrakenapi: https://github.com/dominiktraxl/pykrakenapi\n.. _Pandas: http://pandas.pydata.org/\n.. _CurrencyViewer: https://github.com/smechaab/CurrencyViewer\n\nClients\n^^^^^^^\n\n* clikraken_ - command-line client for the Kraken exchange (available on PyPI!)\n* Telegram-Kraken-Bot_ - Telegram bot to trade on Kraken exchange\n\n.. _clikraken: https://github.com/zertrin/clikraken\n.. _Telegram-Kraken-Bot: https://github.com/Endogen/Telegram-Kraken-Bot\n\n\nDocumentation\n-------------\n\nView the latest_ or stable_ online at ReadTheDocs.\n\nThe code is documented in docstrings, and can be viewed with a text editor.\n\nYou can also generate your own with, e.g., ``make html`` in ``doc``.\nThis requires ``sphinx`` and its ``rtd`` theme.\n\nFor the most up-to-date list of public/private Kraken API methods, see\ntheir `API documentation`_.\n\n.. _latest: https://python3-krakenex.readthedocs.io/en/latest/\n.. _stable: https://python3-krakenex.readthedocs.io/en/stable/\n.. _API documentation: https://docs.kraken.com/rest/\n\n\nExamples\n--------\n\nA few package use examples are available in the examples_ directory.\n\n.. _examples: examples/\n\n\nInstallation\n------------\n\nThis package requires Python 3.3 or later. The module will be called\n``krakenex``.\n\nA `PyPI package`_ is available.\n\nFor general use, there is only one direct dependency: `requests`_.\n\n.. _PyPI package: https://pypi.python.org/pypi/krakenex\n.. _requests: http://docs.python-requests.org/\n\n\nLocally for a project, in a virtual environment (recommended)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis requires ``python-virtualenv`` and ``python-pip``.\n\nIn a terminal:\n\n.. code-block:: sh\n\n   # create directory for a project that'll be using krakenex\n   mkdir my-project\n   cd my-project\n   # bootstrap virtualenv\n   export VIRTUAL_ENV=.virtualenv/krakenex\n   mkdir -p $VIRTUAL_ENV\n   virtualenv $VIRTUAL_ENV\n   source $VIRTUAL_ENV/bin/activate\n   # install from PyPI\n   pip install krakenex\n\nFor more information on ``virtualenv``, see `its documentation`_.\n\n.. _its documentation: https://virtualenv.pypa.io/en/stable/\n\nFor the user\n^^^^^^^^^^^^\n\nUsing ``pip``:\n\n.. code-block:: sh\n\n   # install from PyPI\n   pip install --user krakenex\n   # ... or from local git repo clone\n   cd CLONE-OF-GIT-REPO\n   pip install --user .\n\nSystem-wide (not recommended)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nIn general, use the distribution's package manager.\n\nIf it's unavailable, one can use ``pip``:\n\n.. code-block:: sh\n\n   # install from PyPI\n   pip install krakenex\n   # ... or from local copy\n   pip install /path/to/clone/of/repo\n\n   \nAttribution\n-----------\n\n\"Core\" code is licensed under LGPLv3. See ``LICENSE.txt`` and\n``LICENSE-GPLv3.txt``.\n\nExamples are licensed under the Simplified BSD license. See\n``examples/LICENSE.txt``.\n\n`Payward's PHP API`_, Alan McIntyre's `BTC-e API`_,\nand ScriptProdigy's `Cryptsy Python API`_ were used as\nexamples when writing the original python2-krakenex_ package.\nIt was then ported to Python 3.\n\n.. _Payward's PHP API: https://github.com/payward/kraken-api-client\n.. _BTC-e API: https://github.com/alanmcintyre/btce-api\n.. _Cryptsy Python API: https://github.com/ScriptProdigy/CryptsyPythonAPI\n.. _python2-krakenex: https://github.com/veox/python2-krakenex\n\n\nDevelopment notes\n-----------------\n\nDo not annoy the Kraken with tests\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nSome tests may be making queries to the Kraken API server.\n\nIf you intend to do development on this package, and have tests enabled\non `Travis CI`_, be sure to limit concurrent jobs to 1, and enable all\npossible auto-cancellations.\n\n(Better yet, don't rely on public infrastructure, but run the tests\nlocally first.)\n\n.. _Travis CI: https://travis-ci.org\n\nNo Python 2\n^^^^^^^^^^^\n\nThis package will never support Python 2. There will be no changes made\nto enable compatibility with Python 2. Python 3.0 was `released in\n2008`_, before Bitcoin was.\n\nThere is no reason to support Python 2 except for compatibility with\nsystems from the pre-blockchain era.\n\nThe fact that some GNU/Linux distributions still ship with Python 2 as\nthe default seems unfortunate to me. However, I will not support this\nmadness with my precious time.\n\nIf you have a valid reason to use Python 2, see python2-krakenex_. Be\nwarned, though, that it is unmaintained.\n\n.. _released in 2008: https://en.wikipedia.org/wiki/History_of_Python#Version_3.0\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveox%2Fpython3-krakenex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fveox%2Fpython3-krakenex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveox%2Fpython3-krakenex/lists"}