{ "info": { "author": "Philip Martin", "author_email": "philip.martin@censible.co", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Financial and Insurance Industry", "Natural Language :: English", "Programming Language :: Python :: 3.6", "Topic :: Office/Business :: Financial :: Investment" ], "description": "[![Build Status](https://travis-ci.org/portfoliome/alphavantage.svg?branch=master)](https://travis-ci.com/portfoliome/alpavantage)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/portfoliome/alphavantage/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/portfoliome/alphavantage/?branch=master)\n\n# alphavantage\n\nalphavantage is a Python wrapper for the Alpha Vantage API.\n\nThe API wrapper can be used to retrieve historical prices such as intraday or daily prices for global equities and ETFs.\n\n## Status\n\nThe API aims to support equity time-series data as a first step.\n\nThe package is currently in alpha status. It has not been used extensively yet and therefore mainly of the potential quirks of Alpha Vantage's actual API may not be accounted for. We plan on using this wrapper for price history charting in our [company lookup and ratings tool](https://esg.censible.co/companies/Apple).\n\n\n## Design Consideration\n\nThis library is intended to provide a simple wrapper with minimal dependencies, and does not intend to introduce pydata stack dependencies (numpy, pandas, etc.) in the future. Differences with existing wrappers for the Alpha Vantage API include:\n\n### Library Differences\n\n* No Pandas dependencies or optional dependency\n* Focuses on simplifying data for ingesting\n* Avoids logical branching making the code simpler (only two if statements at moment)\n* Provides symbology mapping references\n\nThe library carries out some conveniences versus using the API without a wrapper.\n\n### Conveniences\n\n* Converts timestamps to UTC time when applicable.\n* Simplifies record field names i.e. \"4. close\" -> \"close\".\n* Appends the timestamp field to record vs. having the timestamp act as dictionary key.\n* Uses time ascending list versus a dictionary for price record data structure.\n* Returns multiple tickers over a given parameter set using threads.\n* Maps ticker symbology from other vendors.\n* Excludes intraday data in daily price history requests.\n\n## Examples\n```python\nfrom alphavantage.price_history import (\n AdjustedPriceHistory, get_results, PriceHistory, IntradayPriceHistory,\n filter_dividends\n)\n\n# weekly prices\nhistory = PriceHistory(period='W', output_size='compact')\nresults = history.get('AAPL')\n\n# intraday prices, 5 minute interval\nhistory = IntradayPriceHistory(utc=True, interval=5)\nresults = history.get('AAPL')\n\n# adjusted daily prices\nhistory = AdjustedPriceHistory(period='D')\nresults = history.get('AAPL')\ndividends = list(filter_dividends(results.records))\n\n# Return multiple tickers\nparameters = {'output_size': 'compact', 'period': 'D'}\ntickers = ['AAPL', 'MSFT']\nresults = dict(get_results(PriceHistory, tickers, parameters))\n```\n\n## Contributing\nContributions are welcome. Someone can immediately contribute by building out wrappers for the rest of the API such as FX rates or crypto prices.\n\n## Getting Started\n\n### Installing\n\n```sh\npip install alphavantage\n```\n\n### Developer Installation\n\nThese instructions assume Python 3.6. It is recommended that you use conda or a virtualenv.\n\n#### For conda install follow:\nDownload the [conda installer](http://conda.pydata.org/miniconda.html).\nAnd follow setup [instructions](http://conda.pydata.org/docs/install/quick.html#id1).\n\n#### Conda Environment\n\n```sh\nconda create --name python=3.6\nactivate \nconda install --file requirements.txt\n\npython setup.py install bdist_wheel\n```\n\n#### debian installation\n[Instruction](https://linuxconfig.org/how-to-change-from-default-to-alternative-python-version-on-debian-linux)\n\nFollow the instructions in the link provided. **DO NOT SUDO PIP INSTALL**. Alias the preferred Python installation by adding, for example:\n\n```sh\nalias python='/usr/bin/python3.6'\n```\n\n#### When using Pip\n```sh\npip install --upgrade pip\npip install wheel\npip install -r requirements.txt\n\npython setup.py install bdist_wheel\n```\n\n#### Running the Tests\n```sh\npy.test\n```\n#### Running Coverage Report\n```sh\npy.test --cov\n```\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/portfoliome/alphavantage", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "alphavantage", "package_url": "https://pypi.org/project/alphavantage/", "platform": "", "project_url": "https://pypi.org/project/alphavantage/", "project_urls": { "Homepage": "https://github.com/portfoliome/alphavantage" }, "release_url": "https://pypi.org/project/alphavantage/0.0.11/", "requires_dist": [ "foil", "requests", "pytest-cov; extra == 'test'", "pytest; extra == 'test'", "requests-mock; extra == 'test'" ], "requires_python": "", "summary": "Alphavantage API wrapper.", "version": "0.0.11" }, "last_serial": 3918301, "releases": { "0.0.10": [ { "comment_text": "", "digests": { "md5": "0dbc3191e33083f728197937f6705bac", "sha256": "19d55fef0589e879a3379a9531fdd4aa23575293cec624c4d17eb08f8f2e7b9e" }, "downloads": -1, "filename": "alphavantage-0.0.10-py36-none-any.whl", "has_sig": false, "md5_digest": "0dbc3191e33083f728197937f6705bac", "packagetype": "bdist_wheel", "python_version": "py36", "requires_python": null, "size": 8962, "upload_time": "2018-05-31T19:35:43", "url": "https://files.pythonhosted.org/packages/93/e3/a6735285c89d62e874a778747bfcac7dbca0e26b13cf18b4bae4cdb05cac/alphavantage-0.0.10-py36-none-any.whl" }, { "comment_text": "", "digests": { "md5": "85176ee69bffd640ae0cb0b8756bf7e9", "sha256": "fc64414f25a7d55cb6a9d6eb2875dad30398dbfb715e69d25a60458071cc6c1f" }, "downloads": -1, "filename": "alphavantage-0.0.10.tar.gz", "has_sig": false, "md5_digest": "85176ee69bffd640ae0cb0b8756bf7e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7474, "upload_time": "2018-05-31T19:35:44", "url": "https://files.pythonhosted.org/packages/a9/ed/800ccf17c7a2bd20efb25c83e719bda8c4339608f93138c151577594d182/alphavantage-0.0.10.tar.gz" } ], "0.0.11": [ { "comment_text": "", "digests": { "md5": "fdea7d99844341c01c44b7fb3792c244", "sha256": "6d296128a22fa53ec2eb24b84f74c7d95c2519d6eb258006d344edd29f897786" }, "downloads": -1, "filename": "alphavantage-0.0.11-py36-none-any.whl", "has_sig": false, "md5_digest": "fdea7d99844341c01c44b7fb3792c244", "packagetype": "bdist_wheel", "python_version": "py36", "requires_python": null, "size": 9078, "upload_time": "2018-05-31T20:02:47", "url": "https://files.pythonhosted.org/packages/08/42/fcd23ce652ddaa26f8296f2efd41c503685c084af49d5f5063d90af8ee29/alphavantage-0.0.11-py36-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f8a0d775c1fb6f5dd57b5e460f06943c", "sha256": "8fa5e18c3c11ff91d478ed561434b82b3cf6c22e01f4768d6f4c799da94f1bad" }, "downloads": -1, "filename": "alphavantage-0.0.11.tar.gz", "has_sig": false, "md5_digest": "f8a0d775c1fb6f5dd57b5e460f06943c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7689, "upload_time": "2018-05-31T20:02:49", "url": "https://files.pythonhosted.org/packages/79/f9/8ee688bd9fd9be532cd8deed32b16431ec8ee3ec5bc1cf56d80a25f03ecc/alphavantage-0.0.11.tar.gz" } ], "0.0.5": [], "0.0.7": [ { "comment_text": "", "digests": { "md5": "fcd9ad919b7c861138bd3453c3bb614f", "sha256": "c1e35356296396e8f9bb78337f5c3c04fecf1cc5cbac49e0afeca9a2adbd4be1" }, "downloads": -1, "filename": "alphavantage-0.0.7-py36-none-any.whl", "has_sig": false, "md5_digest": "fcd9ad919b7c861138bd3453c3bb614f", "packagetype": "bdist_wheel", "python_version": "py36", "requires_python": null, "size": 6957, "upload_time": "2018-05-31T17:40:23", "url": "https://files.pythonhosted.org/packages/e9/0e/9ecc8552d12245f03d4c255583c41ee31419610a447b07c4ca96b90a173a/alphavantage-0.0.7-py36-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0a054776518d7fee6364779e53f6efd8", "sha256": "bd319dcecde2664705a994210c6825af80ab025bc12c9f80c71f9fdbaef09f30" }, "downloads": -1, "filename": "alphavantage-0.0.7.tar.gz", "has_sig": false, "md5_digest": "0a054776518d7fee6364779e53f6efd8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6295, "upload_time": "2018-05-31T17:40:24", "url": "https://files.pythonhosted.org/packages/04/bb/2bb0f08a40ba1003ec4089a91a7e1932688ecc6fb34ffbf21b6a95b924c5/alphavantage-0.0.7.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "4e10693452409450a30a19cceb7bdc73", "sha256": "2282fa17779f719bea007a510e74df8880776422071ae9e6358d590431f990e1" }, "downloads": -1, "filename": "alphavantage-0.0.9-py36-none-any.whl", "has_sig": false, "md5_digest": "4e10693452409450a30a19cceb7bdc73", "packagetype": "bdist_wheel", "python_version": "py36", "requires_python": null, "size": 8208, "upload_time": "2018-05-31T18:26:18", "url": "https://files.pythonhosted.org/packages/d6/24/316d570271890f57fb37cec616861782e4de0c4e9d31f57e0ca2b0d7d7f0/alphavantage-0.0.9-py36-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e71f53d3af0f25b349b55532e38d8bb9", "sha256": "ab6bda1df0539ace3745b9656ea5b5cb42189ddaec3f36f979bcf05fd4a66df9" }, "downloads": -1, "filename": "alphavantage-0.0.9.tar.gz", "has_sig": false, "md5_digest": "e71f53d3af0f25b349b55532e38d8bb9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6724, "upload_time": "2018-05-31T18:26:19", "url": "https://files.pythonhosted.org/packages/70/62/2b062b92630c4b77679e979a53044b0dda655091323265999eb499d38f06/alphavantage-0.0.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fdea7d99844341c01c44b7fb3792c244", "sha256": "6d296128a22fa53ec2eb24b84f74c7d95c2519d6eb258006d344edd29f897786" }, "downloads": -1, "filename": "alphavantage-0.0.11-py36-none-any.whl", "has_sig": false, "md5_digest": "fdea7d99844341c01c44b7fb3792c244", "packagetype": "bdist_wheel", "python_version": "py36", "requires_python": null, "size": 9078, "upload_time": "2018-05-31T20:02:47", "url": "https://files.pythonhosted.org/packages/08/42/fcd23ce652ddaa26f8296f2efd41c503685c084af49d5f5063d90af8ee29/alphavantage-0.0.11-py36-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f8a0d775c1fb6f5dd57b5e460f06943c", "sha256": "8fa5e18c3c11ff91d478ed561434b82b3cf6c22e01f4768d6f4c799da94f1bad" }, "downloads": -1, "filename": "alphavantage-0.0.11.tar.gz", "has_sig": false, "md5_digest": "f8a0d775c1fb6f5dd57b5e460f06943c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7689, "upload_time": "2018-05-31T20:02:49", "url": "https://files.pythonhosted.org/packages/79/f9/8ee688bd9fd9be532cd8deed32b16431ec8ee3ec5bc1cf56d80a25f03ecc/alphavantage-0.0.11.tar.gz" } ] }