Metadata-Version: 2.1
Name: iex-api
Version: 0.0.3
Summary: Unofficial Python IEX Cloud Api.
Home-page: https://github.com/ThomasKluiters/iex_api
Author: Volpyx
Author-email: thomas.kluiters@gmail.com
License: MIT license
Keywords: iex_api
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: dataclasses-json
Requires-Dist: aiohttp
Requires-Dist: tenacity
Provides-Extra: all
Requires-Dist: dataclasses-json ; extra == 'all'
Requires-Dist: aiohttp ; extra == 'all'
Requires-Dist: tenacity ; extra == 'all'
Requires-Dist: pytest-runner (>=5.2) ; extra == 'all'
Requires-Dist: black (>=19.10b0) ; extra == 'all'
Requires-Dist: codecov (>=2.1.4) ; extra == 'all'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'all'
Requires-Dist: flake8-debugger (>=3.2.1) ; extra == 'all'
Requires-Dist: pytest (>=5.4.3) ; extra == 'all'
Requires-Dist: pytest-cov (>=2.9.0) ; extra == 'all'
Requires-Dist: pytest-raises (>=0.11) ; extra == 'all'
Requires-Dist: bump2version (>=1.0.1) ; extra == 'all'
Requires-Dist: coverage (>=5.1) ; extra == 'all'
Requires-Dist: ipython (>=7.15.0) ; extra == 'all'
Requires-Dist: m2r (>=0.2.1) ; extra == 'all'
Requires-Dist: Sphinx (<3,>=2.0.0b1) ; extra == 'all'
Requires-Dist: sphinx-rtd-theme (>=0.4.3) ; extra == 'all'
Requires-Dist: tox (>=3.15.2) ; extra == 'all'
Requires-Dist: twine (>=3.1.1) ; extra == 'all'
Requires-Dist: wheel (>=0.34.2) ; extra == 'all'
Provides-Extra: dev
Requires-Dist: pytest-runner (>=5.2) ; extra == 'dev'
Requires-Dist: black (>=19.10b0) ; extra == 'dev'
Requires-Dist: codecov (>=2.1.4) ; extra == 'dev'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'dev'
Requires-Dist: flake8-debugger (>=3.2.1) ; extra == 'dev'
Requires-Dist: pytest (>=5.4.3) ; extra == 'dev'
Requires-Dist: pytest-cov (>=2.9.0) ; extra == 'dev'
Requires-Dist: pytest-raises (>=0.11) ; extra == 'dev'
Requires-Dist: bump2version (>=1.0.1) ; extra == 'dev'
Requires-Dist: coverage (>=5.1) ; extra == 'dev'
Requires-Dist: ipython (>=7.15.0) ; extra == 'dev'
Requires-Dist: m2r (>=0.2.1) ; extra == 'dev'
Requires-Dist: Sphinx (<3,>=2.0.0b1) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (>=0.4.3) ; extra == 'dev'
Requires-Dist: tox (>=3.15.2) ; extra == 'dev'
Requires-Dist: twine (>=3.1.1) ; extra == 'dev'
Requires-Dist: wheel (>=0.34.2) ; extra == 'dev'
Provides-Extra: setup
Requires-Dist: pytest-runner (>=5.2) ; extra == 'setup'
Provides-Extra: test
Requires-Dist: black (>=19.10b0) ; extra == 'test'
Requires-Dist: codecov (>=2.1.4) ; extra == 'test'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'test'
Requires-Dist: flake8-debugger (>=3.2.1) ; extra == 'test'
Requires-Dist: pytest (>=5.4.3) ; extra == 'test'
Requires-Dist: pytest-cov (>=2.9.0) ; extra == 'test'
Requires-Dist: pytest-raises (>=0.11) ; extra == 'test'

# iex-api

[![Build Status](https://github.com/volpyx/iex-api/workflows/Build%20Main/badge.svg)](https://github.com/volpyx/iex-api/actions)
[![Documentation](https://github.com/volpyx/iex-api/workflows/Documentation/badge.svg)](https://volpyx.github.io/iex-api/)
[![Code Coverage](https://codecov.io/gh/volpyx/iex-api/branch/main/graph/badge.svg)](https://codecov.io/gh/volpyx/iex-api)

Unofficial Python IEX Cloud Api.

---

## Features

-   Supports Income, CashFlow, Financials, Quote, EndOfDayPrice
-   Primarily uses time-series to make it easier to query older data
-   Is asynchronous
-   Typed

## Quick Start

```python
import asyncio
import os

from iex_api.model.company import Income, CashFlow, Financials

os.environ.update({
    "IEX_API_URL": "https://sandbox.iexapis.com/stable/",
    "IEX_API_TOKEN": "<>",
})


async def gather_company_info(symbol: str):
    income, cashflow, financials = await asyncio.gather(
        Income.latest(symbol),
        CashFlow.latest(symbol),
        Financials.latest(symbol)
    )
    print(income.gross_profit)
    print(cashflow.cash_flow)
    print(financials.ebit)

loop = asyncio.get_event_loop()
loop.run_until_complete(gather_company_info('AAPL'))

```

## Installation

**Stable Release:** `pip install iex_api`<br>
**Development Head:** `pip install git+https://github.com/volpyx/iex_api.git`

## Documentation

For full package documentation please visit [volpyx.github.io/iex_api](https://volpyx.github.io/iex-api).

## Development

See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.

## The Four Commands You Need To Know

1. `pip install -e .[dev]`

    This will install your package in editable mode with all the required development
    dependencies (i.e. `tox`).

2. `make build`

    This will run `tox` which will run all your tests in both Python 3.7
    and Python 3.8 as well as linting your code.

3. `make clean`

    This will clean up various Python and build generated files so that you can ensure
    that you are working in a clean environment.

4. `make docs`

    This will generate and launch a web browser to view the most up-to-date
    documentation for your Python package.


