{ "info": { "author": "faberquisque", "author_email": "faberquisque@hotmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "pyfinex\n======\nPython wrapper for Bitfinex API.\n\nDependencies\n======\nRequests library is required.\n\nUsage\n======\nInclude the pyfinex module and use it as a toolbox. For trading, a key and a secret key must be provided.\n\n\n```python\nimport pyfinex\n\nAPI_KEY = 'insert key'\nAPI_SECRET = 'insert secret'\n\nresp = pyfinex.v1.positions.active(key=API_KEY, secret_key=API_SECRET)\nresp = pyfinex.v1.public.ticker(symbol='btcusd')\n```\n\nFunction names are organized for better coding\n\n**Function names are referred in part to the api doc's html, which you can see [Bitfinex API web page](http://docs.bitfinex.com/).**\n**Required params to build the request's url are coded in the function's args, other query params are to be added acording to api doc**\n\n**BEWARE: some inputs varies from v1 to v2. Example: v1>> 'BTCUSD' v2>> 'tBTCUSD'**\n\nAll documented API calls are implemented!\n\nExamples\n======\n### Get the latest BTCUSD price\n```python\nresp = pyfinex.v1.public.ticker(symbol='btcusd')\n```\n### View your active orders\n```python\nresp = pyfinex.v1.positions.active(API_KEY,API_SECRET)\n```\n### Get the BTCUSD order book\n```python\nresp = pyfinex.v1.public.order_book(symbol='btcusd')\n```\n### Get the last BTCUSD 1m candle \n```python\nresp = pyfinex.v2.public.candles(Symbol='tBTCUSD', TimeFrame='1m', Section='last')\n```\n\nNote: in v2 the parameters are capital case.\n### Submit a new order\nFor example, if you'd like to buy 0.001 BTC as 0.01 BTC/USD, you need to specify the parameters acording to the api doc. You may parse the response to get the order id for future use.\n\n\tresp = pyfinex.v1.orders.new(symbol=\"BTCUSD\", amount=0.001, price=0.01, side='buy', type='market')\n\n### In case there is a new call you can do it yourself!:\n```python\npyfinex.api.request(authenticate=True, \n key=API_KEY, \n secret_key=API_SECRET, \n version=1, \n endpoint='new/api/call/here', \n method='POST', \n body_params={}, \n query_params={})\n```\n\nTest\n======\n1. Replace your keys in .env.example file, and rename it to .env\n1. Include your unit tests as functions in a test_vX_*.py file\n ```python\n def test_ticker():\n resp = pyfinex.v1.public.ticker(symbol='btcusd')\n resp['mid']\n ```\n1. Run the tests using pytest\n\nKnown Issues\n======\n- No\n\nTODO\n=====\n- Test every endpoint\n\n\nContributing\n======\n1. Create an issue and discuss.\n1. Create a feature branch containing only your fix or feature.\n1. Add tests, please!!\n1. Create a pull request.\n1. Thanks!\n\nReferences\n======\n- [https://github.com/scottjbarr/bitfinex](https://github.com/scottjbarr/bitfinex)\n- [https://github.com/jimako1989/bitfinexpy](https://github.com/jimako1989/bitfinexpy)\n- [Bitfinex official API wrapper for Ruby](https://github.com/bitfinexcom/bitfinex-api-rb)\n- [Bitfinex v1 API doc](https://bitfinex.readme.io/v1/docs)\n- [Bitfinex v2 API doc](https://bitfinex.readme.io/v2/docs)\n\nLicence\n======\nThe MIT License (MIT)\n\nCopyright (c) 2018 faberquisque\n\nSee [LICENSE.md](LICENSE.md)\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/faberquisque/pyfinex", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "pyfinex", "package_url": "https://pypi.org/project/pyfinex/", "platform": "", "project_url": "https://pypi.org/project/pyfinex/", "project_urls": { "Homepage": "https://github.com/faberquisque/pyfinex" }, "release_url": "https://pypi.org/project/pyfinex/1.0.3/", "requires_dist": null, "requires_python": "", "summary": "Python wrapper for Bitfinex API v1 and v2", "version": "1.0.3" }, "last_serial": 4165726, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "debb0d642fdba57640dbbfd649e631c5", "sha256": "6e6f02a4a6e29a3c7eac7f635f45592745350f769ff30ee59c26c172b330295c" }, "downloads": -1, "filename": "pyfinex-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "debb0d642fdba57640dbbfd649e631c5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11048, "upload_time": "2018-07-17T17:42:28", "url": "https://files.pythonhosted.org/packages/a9/84/4601e84241f9dce5938c29034793940ded15668b6d11f40b686de03983a3/pyfinex-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "702dc61b51652adc906f79c29cf8a56b", "sha256": "9f71501914d12c4d912ad2a5a61972a428a90b0f4eace0a235ed4ad7c12261e5" }, "downloads": -1, "filename": "pyfinex-0.0.1.tar.gz", "has_sig": false, "md5_digest": "702dc61b51652adc906f79c29cf8a56b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6267, "upload_time": "2018-07-17T17:42:29", "url": "https://files.pythonhosted.org/packages/d4/c6/facd44ac5794bc0bd760be2377aa5fb7d6added9073551f59ffbfed31d6a/pyfinex-0.0.1.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "ce8fa29d1beeefae4982436bcf24f617", "sha256": "c7c95a907fb9bb2b1b1c698c5d26bd9bee8e14396a3b7b5a10ec97b566e425ce" }, "downloads": -1, "filename": "pyfinex-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "ce8fa29d1beeefae4982436bcf24f617", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 23288, "upload_time": "2018-07-27T19:02:35", "url": "https://files.pythonhosted.org/packages/5a/c9/7f263d0654964d6fa1e7bf98af443f323042914528a41ba9322650e67980/pyfinex-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "de7818dc978f9b0635be20efb1a408c6", "sha256": "7f40c5457ebced6f2ada78b674cf2afdfc8f4dd23bcdc20cb9a36948e3553e69" }, "downloads": -1, "filename": "pyfinex-1.0.1.tar.gz", "has_sig": false, "md5_digest": "de7818dc978f9b0635be20efb1a408c6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9126, "upload_time": "2018-07-27T19:02:37", "url": "https://files.pythonhosted.org/packages/1c/d1/2185198ee70b9bf0c9ac9fe7c3ef8aec9b3024c89880c0550499f12c03c8/pyfinex-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "1608bdef4ee318de6c2cab4d34578597", "sha256": "aca5b27d5f337966b494682ee2ca166f62b469d787bcbd7deec8abe0ff019121" }, "downloads": -1, "filename": "pyfinex-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "1608bdef4ee318de6c2cab4d34578597", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13937, "upload_time": "2018-08-06T18:58:50", "url": "https://files.pythonhosted.org/packages/83/1e/88a5f00c4ae6fd9a5b337d616c3df374dddf0493162b977c14586251b92d/pyfinex-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7b909c92c123caf770b9295775970980", "sha256": "0916d26fff6ca1b17d239bc104810786d1e3d58f2f79cb082945eb19c779196b" }, "downloads": -1, "filename": "pyfinex-1.0.2.tar.gz", "has_sig": false, "md5_digest": "7b909c92c123caf770b9295775970980", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8095, "upload_time": "2018-08-06T18:58:51", "url": "https://files.pythonhosted.org/packages/7e/8c/2e23d235dffe89faa7be425690ddf53a77f00705e982c1e32e0f51c063d9/pyfinex-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "3d8c0ebbc2ff60048ae074c14f02bbe4", "sha256": "a94de96c998923ed119819607b5795983c23fbca4b193770e2a6270c2839531a" }, "downloads": -1, "filename": "pyfinex-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "3d8c0ebbc2ff60048ae074c14f02bbe4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14114, "upload_time": "2018-08-13T15:06:01", "url": "https://files.pythonhosted.org/packages/38/47/552ca6a09a9623ee6a719089c7b4b234e66de0dd3b9788f5245e33940a25/pyfinex-1.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "765c1d42bf464640c54861f9d29e733e", "sha256": "18c47120993c215120507443f8f11a6508e2717dfd6c74e0cb891961dc3974eb" }, "downloads": -1, "filename": "pyfinex-1.0.3.tar.gz", "has_sig": false, "md5_digest": "765c1d42bf464640c54861f9d29e733e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9723, "upload_time": "2018-08-13T15:06:02", "url": "https://files.pythonhosted.org/packages/58/df/68f55ead0dfddccd71a937ef9a42b8c725a8c8bfd4d30cdaa3f1b48d1c06/pyfinex-1.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3d8c0ebbc2ff60048ae074c14f02bbe4", "sha256": "a94de96c998923ed119819607b5795983c23fbca4b193770e2a6270c2839531a" }, "downloads": -1, "filename": "pyfinex-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "3d8c0ebbc2ff60048ae074c14f02bbe4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14114, "upload_time": "2018-08-13T15:06:01", "url": "https://files.pythonhosted.org/packages/38/47/552ca6a09a9623ee6a719089c7b4b234e66de0dd3b9788f5245e33940a25/pyfinex-1.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "765c1d42bf464640c54861f9d29e733e", "sha256": "18c47120993c215120507443f8f11a6508e2717dfd6c74e0cb891961dc3974eb" }, "downloads": -1, "filename": "pyfinex-1.0.3.tar.gz", "has_sig": false, "md5_digest": "765c1d42bf464640c54861f9d29e733e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9723, "upload_time": "2018-08-13T15:06:02", "url": "https://files.pythonhosted.org/packages/58/df/68f55ead0dfddccd71a937ef9a42b8c725a8c8bfd4d30cdaa3f1b48d1c06/pyfinex-1.0.3.tar.gz" } ] }