{
    "info": {
        "author": "Alpaca",
        "author_email": "oss@alpaca.markets",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "[![PyPI version](https://badge.fury.io/py/alpaca-backtrader-api.svg)](https://badge.fury.io/py/alpaca-backtrader-api)\n[![CircleCI](https://circleci.com/gh/alpacahq/alpaca-backtrader-api.svg?style=shield)](https://circleci.com/gh/alpacahq/alpaca-backtrader-api)\n\n# alpaca-backtrader-api\n\n`alpaca-backtrader-api` is a python library for the Alpaca trade API\nwithin `backtrader` framework.\nIt allows rapid trading algo development easily, with support for the\nboth REST and streaming interfaces. For details of each API behavior,\nplease see the online API document.\n\nNote this module supports only python version 3.5 and above, due to\nthe underlying library `alpaca-trade-api`.\n\n## Install\n\n```bash\n$ pip3 install alpaca-backtrader-api\n```\n\n## Example\n\nIn order to call Alpaca's trade API, you need to obtain API key pairs.\nReplace <key_id> and <secret_key> with what you get from the web console.\n\n```python\nimport backtrader as bt\nimport alpaca_backtrader_api\n\nclass SmaCross(bt.SignalStrategy):\n    def __init__(self):\n        sma1, sma2 = bt.ind.SMA(period=10), bt.ind.SMA(period=30)\n        crossover = bt.ind.CrossOver(sma1, sma2)\n        self.signal_add(bt.SIGNAL_LONG, crossover)\n\ncerebro = bt.Cerebro()\ncerebro.addstrategy(SmaCross)\n\nstore = alpaca_backtrader_api.AlpacaStore(\n    key_id='',\n    secret_key='',\n    paper=True\n)\n\nbroker = store.getbroker()  # or just alpaca_backtrader_api.AlpacaBroker()\ncerebro.setbroker(broker)\n\nDataFactory = store.getdata # or use alpaca_backtrader_api.AlpacaData\ndata0 = DataFactory(dataname='AAPL', timeframe=bt.TimeFrame.TFrame(\"Days\"))  # Supported timeframes: \"Days\"/\"Minutes\"\ncerebro.adddata(data0)\n\ncerebro.run(exactbars=1)\ncerebro.plot()\n```\n\n## API Document\n\nThe HTTP API document is located in https://docs.alpaca.markets/\n\n## Authentication\n\nThe Alpaca API requires API key ID and secret key, which you can obtain from the\nweb console after you sign in.  You can set them in the AlpacaStore constructor,\nusing 'key_id' and 'secret_key'.\n\n## Paper/Live mode\n\nThe 'paper' parameter is default to False, which allows live trading.\nIf you set it to True, then you are in the paper trading mode.\n\n## Support and Contribution\n\nFor technical issues particular to this module, please report the\nissue on this GitHub repository. Any API issues can be reported through\nAlpaca's customer support.\n\nNew features, as well as bug fixes, by sending pull request is always\nwelcomed.\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/alpacahq/alpaca-backtrader-api",
        "keywords": "financial,timeseries,api,trade,backtrader",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "alpaca-backtrader-api",
        "package_url": "https://pypi.org/project/alpaca-backtrader-api/",
        "platform": "",
        "project_url": "https://pypi.org/project/alpaca-backtrader-api/",
        "project_urls": {
            "Homepage": "https://github.com/alpacahq/alpaca-backtrader-api"
        },
        "release_url": "https://pypi.org/project/alpaca-backtrader-api/0.3/",
        "requires_dist": [
            "backtrader",
            "alpaca-trade-api"
        ],
        "requires_python": "",
        "summary": "Alpaca API within backtrader",
        "version": "0.3"
    },
    "last_serial": 4500547,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "77c0db2c9aa80a16f4a0f19b445336d4",
                    "sha256": "6f400375a0997b6c8d94bdaf0b0cef3c4dcc7df5c3477c234120929626643e7c"
                },
                "downloads": -1,
                "filename": "alpaca_backtrader_api-0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "77c0db2c9aa80a16f4a0f19b445336d4",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 14979,
                "upload_time": "2018-10-30T18:45:57",
                "url": "https://files.pythonhosted.org/packages/0d/19/4cb4b304cf0931f51cbe9b5d405cc6c4ee3221a69b3d33f89cfa4c51f37b/alpaca_backtrader_api-0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "fca7330fc449129099dea2a5f1127b9f",
                    "sha256": "0df4b241f7c0099074178df36d8475d1587476aafbbead03969dd1d3ac0cf6e8"
                },
                "downloads": -1,
                "filename": "alpaca-backtrader-api-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "fca7330fc449129099dea2a5f1127b9f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14620,
                "upload_time": "2018-10-30T18:45:59",
                "url": "https://files.pythonhosted.org/packages/96/72/8bfb8e5dcba220618d8db6493e0a758b8bfc184b040a597a8bb4b3ab14b7/alpaca-backtrader-api-0.1.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3b939a2ecabf15f61ed8b5f1bacf603d",
                    "sha256": "62371041594acfd3cbf49b1f8e86be763d5bd799858120cff309b002a3d7d747"
                },
                "downloads": -1,
                "filename": "alpaca_backtrader_api-0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3b939a2ecabf15f61ed8b5f1bacf603d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 15037,
                "upload_time": "2018-11-18T19:46:53",
                "url": "https://files.pythonhosted.org/packages/4c/49/bf880e0f66f98fb8519bdecba3d57679960c2d33c523e7dbc4997f795508/alpaca_backtrader_api-0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6d7c3e1adbbd42961394c2d0797312ba",
                    "sha256": "db65ca1a1684fc34e169a5d1a96327fb5fdaf68010e3156a9f7c0e7111ee3cdb"
                },
                "downloads": -1,
                "filename": "alpaca-backtrader-api-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "6d7c3e1adbbd42961394c2d0797312ba",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14751,
                "upload_time": "2018-11-18T19:46:55",
                "url": "https://files.pythonhosted.org/packages/7a/65/779185eb764392dbebd86e7ddaeaefcd1eb7a8a4a240815cacaca214d213/alpaca-backtrader-api-0.2.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f1f7289b43bd7ecadec9c6f061a70e9d",
                    "sha256": "a1da9a84db73a59734fce905518630605941cc2817bba30822555344383598f4"
                },
                "downloads": -1,
                "filename": "alpaca_backtrader_api-0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f1f7289b43bd7ecadec9c6f061a70e9d",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 15060,
                "upload_time": "2018-11-18T19:48:37",
                "url": "https://files.pythonhosted.org/packages/9a/55/74cb58e4a06879c4e23c83144aae16009e7a8a7a09dbcf94ce992df989e3/alpaca_backtrader_api-0.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "410851533768596eebbe50ee558f7d88",
                    "sha256": "73254e412b90f6c571e10f8483dec70e3f0467e679d7b34b4328dba76b34dd81"
                },
                "downloads": -1,
                "filename": "alpaca-backtrader-api-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "410851533768596eebbe50ee558f7d88",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14798,
                "upload_time": "2018-11-18T19:48:39",
                "url": "https://files.pythonhosted.org/packages/c5/2b/d526819d2bcae641659351de44d6f7942c36f354dea3f0b0101fadb3009d/alpaca-backtrader-api-0.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f1f7289b43bd7ecadec9c6f061a70e9d",
                "sha256": "a1da9a84db73a59734fce905518630605941cc2817bba30822555344383598f4"
            },
            "downloads": -1,
            "filename": "alpaca_backtrader_api-0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f1f7289b43bd7ecadec9c6f061a70e9d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 15060,
            "upload_time": "2018-11-18T19:48:37",
            "url": "https://files.pythonhosted.org/packages/9a/55/74cb58e4a06879c4e23c83144aae16009e7a8a7a09dbcf94ce992df989e3/alpaca_backtrader_api-0.3-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "410851533768596eebbe50ee558f7d88",
                "sha256": "73254e412b90f6c571e10f8483dec70e3f0467e679d7b34b4328dba76b34dd81"
            },
            "downloads": -1,
            "filename": "alpaca-backtrader-api-0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "410851533768596eebbe50ee558f7d88",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14798,
            "upload_time": "2018-11-18T19:48:39",
            "url": "https://files.pythonhosted.org/packages/c5/2b/d526819d2bcae641659351de44d6f7942c36f354dea3f0b0101fadb3009d/alpaca-backtrader-api-0.3.tar.gz"
        }
    ]
}