Skip to main content

A python API to Alpha Vantage

Project description

An alternative python backend to the Alpha Vantage API

https://img.shields.io/badge/GitHub-gboehl%2Falpyvantage-blue.svg?style=flat https://readthedocs.org/projects/alpyvantage/badge/?version=stable https://badge.fury.io/py/alpyvantage.svg https://github.com/gboehl/alpyvantage/actions/workflows/continuous-integration.yml/badge.svg

alpyvantage provides a python backend to the Alpha Vantage API. Alpha Vantage provides access to a wide range of financial data and time series. Details can be found in the official API documentation. You can get a free API key here.

Installation

Installing the repository version is as simple as typing

pip install alpyvantage

in your terminal or Anaconda Prompt.

Documentation

API calls are straightforward. Either use the build-in functions such as time_series_intraday, time_series_weekly, etc.:

import alpyvantage as av

api = av.API(<your_api_key>)

data, meta_data = api.time_series_intraday('DAX', interval='1min', month='2015-01')

print(data) # its a pandas.DataFrame

Or use the function keyword from the official API documentation and provide the parameters as keyword arguments:

data, meta_data = api('TIME_SERIES_INTRADAY', symbol='DAX', interval='1min', month='2015-01')

A detailed documentation of the individual functions can be found here.

Issues and contributions

Please use the issues for questions or if you think anything doesn’t do what it is supposed to do. Pull requests are welcome, please include some documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alpyvantage-0.2.1.tar.gz (8.8 kB view hashes)

Uploaded Source

Built Distribution

alpyvantage-0.2.1-py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page