Skip to main content

python wrapper for the IEX API

Project description

# PyInvestor

PyInvestor is a python wrapper for the IEX API.


[![](https://travis-ci.com/SamurAi-sarl/PyInvestor.svg?token=1ybw2N4PGqXLfqpxx5kG&branch=master)]()
[![](https://img.shields.io/github/license/SamurAi-sarl/PyInvestor.svg)](https://github.com/SamurAi-sarl/PyInvestor/LICENSE)
![Python 3.6](https://img.shields.io/badge/Python-3.6-blue.svg)
[![Documentation Status](https://readthedocs.org/projects/ansicolortags/badge/?version=latest)](https://samurai-sarl.github.io/PyInvestor/)

## Documentation

The documentation related to the details of the different methods of **PyInvestor** is found here:
[https://samurai-sarl.github.io/PyInvestor/](https://samurai-sarl.github.io/PyInvestor/)


## Features

As of now, **PyInvestor** is a wrapper for the IEX API. However,
we have the ambition to grow it and integrate several financial
APIs into one single Python library, **PyInvestor**. Now, some
of the features are:

- IEX Stocks app using the stocks endpoint;
- Access to the OHLC of more than 7k stocks;
- Get relevant news at the stock level;
- Access to fundamental data such as dividends, earnings, etc.


## Dependencies

- Pandas
- Requests

## Installation

``` bash
pip install pyinvestor
```

## Examples

### Market

__SectorPerformance__

``` python
from PyInvestor import market
market.SectorPerformance()
```
![text](./docs/market.gif)


### Stock

__Earnings__

```python
from PyInvestor.stock import Stock
AMZN = Stock('AMZN')
AMZN.Earnings()
```
![text](./docs/stock.gif)

## Todos

| API | Integration |
|----------|------------------------------------------ |
| IEX | [![IEX](http://progressed.io/bar/75)]() |
| Quandl | [![Quandl](http://progressed.io/bar/0)]() |
| News API | [![Quandl](http://progressed.io/bar/0)]() |



## Legal

As **PyInvestor** is a wrapper for the IEX API, we have to say that

> Data is provided for free by [IEX](https://iextrading.com/developer/).
> View [IEX's Terms of Use](https://iextrading.com/api-exhibit-a/)

## Developers
Made with :heart: by [SamurAI](https://www.samurai.team/). Follow us on [Linkedin](https://www.linkedin.com/company/samurai-team/) to get the latest news first!
We're always happy to receive your feedback!

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

pyinvestor-0.0.4.tar.gz (5.9 kB view details)

Uploaded Source

File details

Details for the file pyinvestor-0.0.4.tar.gz.

File metadata

  • Download URL: pyinvestor-0.0.4.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for pyinvestor-0.0.4.tar.gz
Algorithm Hash digest
SHA256 39a7de508c4f1ae41b1f2ef0b3b40377027c6f308904a501b05703c8254f0abe
MD5 3ea345176599316b59e81b39ff238532
BLAKE2b-256 357297b66538bca6d3a1ea696486465780ec962773d31d8bbd8312de03527842

See more details on using hashes here.

Supported by

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