{
"info": {
"author": "Marc S. Brooks",
"author_email": "devel@mbrooks.info",
"bugtrack_url": null,
"classifiers": [],
"description": "Bittrex AutoTrader\n==================\n\nBittrex currency exchange autotrading script *in a nutshell*.\n\nInstallation\n------------\n\n::\n\n $ pip install bittrex_autotrader\n\nDependencies\n------------\n\nTo manually install the Python script dependencies, generate API\ndocumentation, and create a source distribution:\n\n::\n\n $ make\n\nConfiguration options\n---------------------\n\nThe following options can be passed as script arguments or defined in a\nfile:\n\n+----------+----------------------------------------------+------------------------------------+-----------------+\n| Option | Description | Example | Default value |\n+==========+==============================================+====================================+=================+\n| apikey | Bittrex issued API key. | XxXxxXXxXxxXxxXxXxxXxXxxXXxXxxXx | |\n+----------+----------------------------------------------+------------------------------------+-----------------+\n| secret | Bittrex issued API secret. | XxXxxXXxXxxXxxXxXxxXxXxxXXxXxxXx | |\n+----------+----------------------------------------------+------------------------------------+-----------------+\n| market | String literal for the market. | BTC-XXX | BTC-LTC |\n+----------+----------------------------------------------+------------------------------------+-----------------+\n| units | BUY/SELL total units. | 0 | 1 |\n+----------+----------------------------------------------+------------------------------------+-----------------+\n| spread | BUY/SELL markup/markdown percentage. | 0.0/0.0 | 0.1/0.1 |\n+----------+----------------------------------------------+------------------------------------+-----------------+\n| method | Moving Average calculation method. | method | arithmetic |\n+----------+----------------------------------------------+------------------------------------+-----------------+\n| delay | Seconds to delay order status requests. | 0 | 30 |\n+----------+----------------------------------------------+------------------------------------+-----------------+\n| prompt | Require user interaction to begin trading. | False | True |\n+----------+----------------------------------------------+------------------------------------+-----------------+\n\nBasic usage\n-----------\n\nTo run the script:\n\n::\n\n $ ./bittrex_autotrader.py --conf bittrex_autotrader.conf\n\nAssuming there are no open orders, the default configuration requires\nthe user to decide the first type of trade;\n\n::\n\n 1. BUY in at markdown (need units to trade)\n 2. SELL out at markup (need liquidity)\n\n Enter your choice as a number or unique substring (Control-C aborts):\n\nMake a choice then press Enter.\n\nThe script will then retrieve the latest market rates, calculate an\nasking price based on your configuration and submit an order to Bittrex.\n\nOnce an order has completed, the script will again retrieve the latest\nmarket rates and submit a new order of the opposite type.\n\nIf an order is cancelled (via the Bittrex Web UI), the script will\nrecalculate based on the latest market rates and submit an order of the\nsame type.\n\nIf the script is stopped and re-run while an order is outstanding, it\nwill resume monitoring and continue as normal once the order is\ncompleted or cancelled.\n\nRunning as a service\n~~~~~~~~~~~~~~~~~~~~\n\nIf you wish to automate the running of the script (using\n`Supervisor `__ for example), set the 'prompt'\nconfiguration option to 'False'.\n\nOn startup, the script will automatically check for an open order and\nwait for completion or cancellation before initiating an order of the\nopposite type.\n\nIf you do not have any open orders it will initiate a 'SELL' order by\ndefault. If you do not have enough funds to carry out this operation,\nthe script will end.\n\nBittrex API\n-----------\n\nOutside of the basic trading functionality a full implementation of the\nBittrex API has been provided for those would want to extend this\nscript. Runnning ``make`` will generate the class HTML documentation.\n\nUsage Example\n~~~~~~~~~~~~~\n\n::\n\n #!/usr/bin/env python\n\n from bittrex_autotrader import BittrexApiRequest\n\n apiReq = BittrexApiRequest(apikey, secret)\n ticker = apiReq.public_ticker(market)\n\n print ticker['Ask']\n\nDeveloper Notes\n---------------\n\n- If you are new to cryptocurrencies please, and I stress, **DO NOT USE THIS SCRIPT**.\n- Certain markets are more volatile than others. It's very easy to get\n priced out of a market, so choose wisely.\n- Based on the defined ``spread`` you can gain/lose units of value. I\n take no responsiblity for your losses.\n- New features will be added when I have free time available. You can\n motivate me by *donating* below.\n\nDonations\n---------\n\nIf you find this script to be helpful in any way, buy me a beer using\none of the cryptocurrencies below:\n\n::\n\n Bitcoin: 1Cvr9aHNmV2riULkfgEqofQtuhxCBe7A16\n Litecoin: LcMKbewQftytYnmsGTk63BW7yPCnUKFNni\n Digibyte: DPZNoKrH8wmY7QfR5aWrh84JheE4KwWsge\n\nLicense and Warranty\n--------------------\n\nThis package is distributed in the hope that it will be useful, but\nwithout any warranty; without even the implied warranty of\nmerchantability or fitness for a particular purpose.\n\n*Bittrex AutoTrader* is provided under the terms of the `MIT\nlicense `__\n\n`Bittrex `__ is a registered trademark of Bittrex,\nINC\n\nAuthor\n------\n\n`Marc S. Brooks `__",
"description_content_type": "",
"docs_url": null,
"download_url": "https://github.com/nuxy/bittrex_autotrader/archive/0.0.0.1.0.tar.gz",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/nuxy/bittrex_autotrader",
"keywords": "trading-bot,api-client,cryptocurrency,bittrex",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "bittrex-autotrader",
"package_url": "https://pypi.org/project/bittrex-autotrader/",
"platform": "",
"project_url": "https://pypi.org/project/bittrex-autotrader/",
"project_urls": {
"Download": "https://github.com/nuxy/bittrex_autotrader/archive/0.0.0.1.0.tar.gz",
"Homepage": "https://github.com/nuxy/bittrex_autotrader"
},
"release_url": "https://pypi.org/project/bittrex-autotrader/0.1.0/",
"requires_dist": null,
"requires_python": "",
"summary": "Bittrex currency exchange autotrading script in a nutshell.",
"version": "0.1.0"
},
"last_serial": 4448803,
"releases": {
"0.1.0": [
{
"comment_text": "",
"digests": {
"md5": "0f22d3ff9b0f9e6f2a1540a8c2d9e880",
"sha256": "04c0080061c8b6cba00717073fef959a98e898166f47df3d69b877c93f055a04"
},
"downloads": -1,
"filename": "bittrex_autotrader-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0f22d3ff9b0f9e6f2a1540a8c2d9e880",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9082,
"upload_time": "2018-11-04T03:57:50",
"url": "https://files.pythonhosted.org/packages/0b/2f/b0666f4d18e0689e3f06f33262804192c2a7b8fe2ecc7319ecba9097aa27/bittrex_autotrader-0.1.0.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "0f22d3ff9b0f9e6f2a1540a8c2d9e880",
"sha256": "04c0080061c8b6cba00717073fef959a98e898166f47df3d69b877c93f055a04"
},
"downloads": -1,
"filename": "bittrex_autotrader-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0f22d3ff9b0f9e6f2a1540a8c2d9e880",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9082,
"upload_time": "2018-11-04T03:57:50",
"url": "https://files.pythonhosted.org/packages/0b/2f/b0666f4d18e0689e3f06f33262804192c2a7b8fe2ecc7319ecba9097aa27/bittrex_autotrader-0.1.0.tar.gz"
}
]
}