{ "info": { "author": "Carsten Klein", "author_email": "", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Python Bitfinex API client\n\n---\nThis is a simple Python client for the Bitfinex REST API (V1 and V2). It supports public as well as private endpoints.\n\n---\n## Installation\n\nYou can either clone the repository directly from the Github webpage or run the following command(s) in your terminal:\n\nPip Installation:\n```\npip install bitfinex-tencars\n```\n\nAlternatively you can clone the Git repository:\n```\ngit clone https://github.com/akcarsten/bitfinex_api.git\n```\n\nThen go to the folder to which you cloned the repository and run:\n\n```\npython setup.py install\n```\n\nNow you can run Python and import the Bitfinex client.\n\n---\n## Examples of how to use the interface\n\n### Public endpoints\nPublic endpoints can be used without entering any keys as shown in the examples below.\n\n#### Example 1: Retrieving current tick data\n```python\nimport bitfinex\n\n# Initialize the api\napi = bitfinex.api_v1()\n\n# Select a trading pair\npair = 'btcusd'\n\n# Get the current ticker data for the pair\napi.ticker(pair)\n```\n\n#### Example 2: Available currency pairs\n```python\nimport bitfinex\n\n# Initialize the api\napi = bitfinex.api_v1()\n\n# Get all available currency pairs\nsymbols = api.symbols()\n```\n\nAll available public endpoints are included in this client. For a full documentation check the Bitfinex API [webpage](\nhttps://docs.bitfinex.com/docs/public-endpoints)\n\n### Private endpoints\nIn order to use private endpoints the public- and secrete keys need to be provided while initializing the API as shown in the example below in which the current account balance can be retrieved.\n\n#### Example 1: Check account balance\n```python\nimport bitfinex\n\nkey = 'YOUR_PUBLIC_KEY'\nsecrete = 'YOUR_SECRETE_KEY'\n\napi = bitfinex.api_v1(key, secrete)\nmy_balance = api_bitfinex.balance()\n```\n\n#### Example 2: Place an buy order\n```python\nimport bitfinex\n\nsymbol = 'btcusd' # Currency pair to trade\namount = '0' # Amount to buy\nprice = '0' # Buy price\nside = 'buy' # Buy or sell\ntype = 'exchange market' # Which type\n\n# Send the order\napi.place_order(symbol, amount, price, side, type)\n```\n\n---\n## Further information\n\nFor a full documentation of all API commands and what parameters are needed to run them, check out the Bitfinex API documentation for [public endpoints](https://docs.bitfinex.com/docs/public-endpoints) and the documentation for the [private endpoints](https://docs.bitfinex.com/docs/rest-auth) of the V1 API.\n\nFor the V2 API you can find the reference [here](https://docs.bitfinex.com/v2/reference).\n\nAll endpoints should be included in this API. In case of changes or bugs please let me know.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/akcarsten/bitfinex_api", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "bitfinex-tencars", "package_url": "https://pypi.org/project/bitfinex-tencars/", "platform": "", "project_url": "https://pypi.org/project/bitfinex-tencars/", "project_urls": { "Homepage": "https://github.com/akcarsten/bitfinex_api" }, "release_url": "https://pypi.org/project/bitfinex-tencars/0.0.3/", "requires_dist": null, "requires_python": "", "summary": "Bitfinex REST API client", "version": "0.0.3" }, "last_serial": 4800340, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "c49fd0d2384401142fa976d4f2f830e3", "sha256": "5edbf8112e227c53f297ffd8511f00bc3c36feba23c9a8a4c24fa3c417d05a3b" }, "downloads": -1, "filename": "bitfinex_tencars-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "c49fd0d2384401142fa976d4f2f830e3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7477, "upload_time": "2019-02-09T20:46:28", "url": "https://files.pythonhosted.org/packages/12/2c/3ccb552772983b2c35c28df317cc4ce9f9b05aceb24e17afa39cadab78d0/bitfinex_tencars-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "303404a71f3cf66ba3e678344417f239", "sha256": "016a28b217e71c6e6d4feda26a0add17a1dd083797d0a327e4a7cbb10e6951f6" }, "downloads": -1, "filename": "bitfinex-tencars-0.0.2.tar.gz", "has_sig": false, "md5_digest": "303404a71f3cf66ba3e678344417f239", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4479, "upload_time": "2019-02-09T20:46:30", "url": "https://files.pythonhosted.org/packages/7c/02/e87c1598f40a16a8c2d97a03af782e59b6d58be1cf34a1a25a2acd6e363b/bitfinex-tencars-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "7acf57329c04cb5af9e62b3446fc123a", "sha256": "f84342967a84f763adb22178bde341d450568737f7da07e931a99bfbf96b2667" }, "downloads": -1, "filename": "bitfinex_tencars-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "7acf57329c04cb5af9e62b3446fc123a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7562, "upload_time": "2019-02-09T20:55:57", "url": "https://files.pythonhosted.org/packages/1e/a3/319c3b268bf5672ff0a6655359418ea8a00037323dd4258aa8bd2123aabd/bitfinex_tencars-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "32b1801e2855614024411dc95959bc85", "sha256": "ad967777ebc25602dd10ed38d46f7a443647979d0c0d1bd6eed11c57fea402b1" }, "downloads": -1, "filename": "bitfinex-tencars-0.0.3.tar.gz", "has_sig": false, "md5_digest": "32b1801e2855614024411dc95959bc85", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4520, "upload_time": "2019-02-09T20:55:58", "url": "https://files.pythonhosted.org/packages/e8/dc/a20f84c56c04150c1b8b74e49ca359a557bfa44555f0c1fee38f4cdbf866/bitfinex-tencars-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7acf57329c04cb5af9e62b3446fc123a", "sha256": "f84342967a84f763adb22178bde341d450568737f7da07e931a99bfbf96b2667" }, "downloads": -1, "filename": "bitfinex_tencars-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "7acf57329c04cb5af9e62b3446fc123a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7562, "upload_time": "2019-02-09T20:55:57", "url": "https://files.pythonhosted.org/packages/1e/a3/319c3b268bf5672ff0a6655359418ea8a00037323dd4258aa8bd2123aabd/bitfinex_tencars-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "32b1801e2855614024411dc95959bc85", "sha256": "ad967777ebc25602dd10ed38d46f7a443647979d0c0d1bd6eed11c57fea402b1" }, "downloads": -1, "filename": "bitfinex-tencars-0.0.3.tar.gz", "has_sig": false, "md5_digest": "32b1801e2855614024411dc95959bc85", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4520, "upload_time": "2019-02-09T20:55:58", "url": "https://files.pythonhosted.org/packages/e8/dc/a20f84c56c04150c1b8b74e49ca359a557bfa44555f0c1fee38f4cdbf866/bitfinex-tencars-0.0.3.tar.gz" } ] }