Iexfinance

This is a minor patch release from 0.4.2 that repairs compatibility issues with
pandas 0.25.0. We recommend that all users upgrade.

Bug Fixes

* Removes uses of ``pandas.compat`` which was removed with pandas' end of Python 2 support in 0.25.0

This is a minor release from 0.4.1. We recommend that all users update
to maintain compatibility with IEX Cloud and optimize message weighting
in calls.

Highlights:

- Removes support for the legacy Version 1.0 IEX Developer API, which
was retired in favor of IEX Cloud in June 2019
- Optimized retrieval of historical prices with `get_historical_data`
to allow for close prices only and single day charts to reduce
message counts
- Add support for End of Day options prices

New Endpoints

**Options**

- End of Day Options (`get_eod_options`)

**Data APIs**

- /time-series (`get_time_series`)
- /data-points (`get_data_points`)

Enhancements

- Adds logging for queries, including message count usage and
debugging information. Logging level defaults to `WARNING`, but can
be set to other levels through the `IEX_LOG_LEVEL` environment
variable. The following levels provide various information:

> - `WARNING` - errors only
> - `INFO` - message count used
> - `DEBUG` - request information

- Add `close_only` keyword argument to `get_historical_data` to allow
for retrieval of adjusted close only at reduced message cost
(through `chartCloseOnly` query parameter)

- Optimize `get_historical_data` to use `chartByDay` if a single date
is passed which reduces message count (thanks shlomikushchi)

Backwards Incompatible Changes

- When `IEX_API_VERSION` is set to `v1`, IEX Cloud will now be used,
and as such this has the same behavior as `iexcloud-v1`

- The following legacy-only endpoints have been deprecated and will
raise an `ImmediateDeprecationError` when called:

> - `iexfinance.stocks.get_crypto_quotes`
> - `iexfinance.refdata.get_iex_corporate_actions`
> - `iexfinance.refdata.get_iex_dividends`
> - `iexfinance.refdata.get_iex_next_day_ex_date`
> - `iexfinance.refdata.get_listed_symbol_dir`
> - `iexfinance.stocks.Stock.get_effective_spread`

- The `get_all` method of `iexfinance.stocks.Stock` has been
immediately deprecated

Bug Fixes

- Certain failed requests which erroneously-returened
`IEXAuthorizationError` now return `IEXQueryError`

This is a minor release from 0.4.0. We recommend that all users update
to maintain compatibility with IEX Cloud.

Highlights:

- Defaults to IEX Cloud for all API calls
- Adds warnings to all legacy-only endpoints which will be deprecated
on June 1, 2019, and warnings when `IEX_API_VERSION` is `v1`
- Testing support for all legacy Version 1.0 endpoints has ended
- Adds support for IEX Cloud sandbox environment
([GH116](https://github.com/addisonlynch/iexfinance/issues/116))

New Endpoints
=============

**Stocks**

- /fund-ownership (`get_fund_ownership`)
- /institutional-ownership (`get_institutional_ownership`)
- /insider-roster (`get_insider_roster`)
- /insider-summary (`get_insider_summary`)
- /insider-transactions (`get_insider_transactions`)

**Alternative Data**

- /ceo-compensation (`iexfinance.altdata.get_ceo_compensation`)

Enhancements
============

- Adds support for the IEX Cloud sandbox environment. Specify
`iexcloud-sandbox` as `IEX_API_VERSION` for use with test secret
token
([GH116](https://github.com/addisonlynch/iexfinance/issues/116))
- Refactored test suite to reduce code bloat and consolidate output
formatting

Backwards Incompatible Changes
==============================

- `iexcloud-v1` is now the default `IEX_API_VERSION`, as `v1` support
will end on 6/1/2019
- `Stock` Field/Additional methods <stocks.additional\_methods>
are no longer supported by the v1 Deveoper API. These methods are
retained in IEX Cloud
- All legacy-only endpoints will now warn of impending deprecation on
June 1, 2019

> - `iexfinance.stocks.get_crypto_quotes`
> - `iexfinance.refdata.get_iex_corporate_actions`
> - `iexfinance.refdata.get_iex_dividends`
> - `iexfinance.refdata.get_iex_next_day_ex_date`
> - `iexfinance.refdata.get_listed_symbol_dir`

- Deprecations (functions moved or renamed):

> - `get_market_gainers` → `iexfinance.stocks.get_market_gainers`
> - `get_market_losers` → `iexfinance.stocks.get_market_losers`
> - `get_market_most_active` →
> `iexfinance.stocks.get_market_most_active`
> - `get_market_iex_volume` →
> `iexfinance.stocks.get_market_iex_volume`
> - `get_market_iex_percent` →
> `iexfinance.stocks.get_market_iex_percent`
> - `get_symbols` → `iexfinance.refdata.get_symbols`
> - `get_iex_corporate_actions` →
> `iexfinance.refdata.get_iex_corporate_actions`
> - `get_iex_dividends` → `iexfinance.refdata.get_iex_dividends`
> - `get_iex_next_day_ex_date` →
> `iexfinance.refdata.get_iex_next_day_ex_date`
> - `get_listed_symbol_dir` →
> `iexfinance.refdata.get_listed_symbol_dir`
> - `get_tops` → `iexfinance.iexdata.get_tops`
> - `get_last` → `iexfinance.iexdata.get_last`
> - `get_deep` → `iexfinance.iexdata.get_deep`
> - `get_deep_book` → `iexfinance.iexdata.get_deep_book`
> - `get_stats_intraday` → `iexfinance.iexdata.get_stats_intraday`
> - `get_stats_recent` → `iexfinance.iexdata.get_stats_recent`
> - `get_stats_records` → `iexfinance.iexdata.get_stats_records`
> - `get_stats_daily` → `iexfinance.iexdata.get_stats_daily`
> - `get_stats_summary` → `iexfinance.iexdata.get_stats_summary`
> - `stocks.get_today_earnings` → `stocks.get_earnings_today`
> - `stocks.Stock.get_previous` →
> `stocks.Stock.get_previous_day_prices`
> - `stocks.Stock.get_relevant` →
> `stocks.Stock.get_relevant_stocks`

Bug Fixes
=========

- Repair `DataFrame` output formatting for a number of `Stock` methods
([GH119](https://github.com/addisonlynch/iexfinance/issues/119))
- Fix project description for PyPi

Testing
=======

- Testing support all legacy Version 1 endpoints has ended. These
endpoints will be deprecated in 0.4.2

This is a major release from 0.3.5, and we recommend that all users
update.

Highlights

- Adds support for [IEX Cloud](https://iexcloud.io)

New Endpoints

**Stock**

- /balance-sheet (`get_balance_sheet`)
- /cash-flow (`get_cash_flow`)
- /estimates (`get_estimates`)
- /historical (`get_historical_prices`) (same as `get_chart`)
- /income (`get_income_statement`)
- /price-target (`get_price_target`)

**Account**

- /account/usage (`iexfinance.account.get_usage`)
- /account/metadata (`iexfinance.account.get_metadata`)
- /account/payasyougo (`iexfinance.account.allow_pay_as_you_go`,
`iexfinance.account.disallow_pay_as_you_go`)

**Reference Data**

- /ref-data/symbols (`iexfinance.get_symbols`)
- /ref-data/iex-symbols (`iexfinance.get_iex_symbols`)

**Alternative Data**

- /crypto/quote (`iexfinance.altdata.get_crypto_quote`)
- /stock/sentiment (`iexfinance.altdata.get_social_sentiment`)

**API System Metadata**

- /status (`iexfinance.apidata.get_api_status`)

Enhancements

- Adds support for setting persistent output format settings using the
environment variable `IEX_OUTPUT_FORMAT`
- Select between IEX API versions using the IEX\_API\_VERSION
environment variable
- The `StockReader` base class has been renamed `Stock` and the
duplicate `Stock` function has been removed
- Loosened testing restrictions on return types to allow for `int` or
`float` to eliminate periodic even number returns and CI failures
- Improved testing for `_IEXBase` base class configuration (request
parameters, output formatting)
- Adds tox for cross-version testing (thank you Jack Moody)
- Adds official Python 3.7 support and CI build (thank you Jack Moody)

Backwards Incompatible Changes

- Deprecated `iexfinance.Stock` and `iexfinance.get_historical_data`
have been removed. These are now available as
`iexfinance.stocks.Stock` and
`iexfinance.stocks.get_historical_data`

- - `iexfinance.marketdata` has been moved to a new module
`iexdata`.

- `get_market_tops`, `get_market_last`, `get_market_deep`,
`get_market_book` have been deprecated and renamed
(respectively) `get_tops`, `get_last`, `get_deep`,
`get_deep_book`

- - `iexfinance.stats` moved to a new module `iexdata`.

- `get_stats_intraday`, `get_stats_recent`,
`get_stats_records`, `get_stats_daily`, `get_stats_monthly`
have been moved to `iexdata`. The top level functions
`iexfinance.get_stats_intraday` etc. have been deprecated
- `get_stats_monthly` renamed to `get_stats_summary`

- The named parameter `range_` for
`iexfinance.stocks.Stock.get_dividends`, `get_splits`, and
`get_chart` is now the keyword argument `range`

- `iexfinance.stocks.Stock.get_previous` deprecated

This is a minor release from 0.3.4.

Highlights:

- Adds support for intraday historical prices
- Adds support for endpoint additions and updates from 8/8/2018
provider updates (including expanded cryptocurrency support)
- Various bug fixes and enhancements

Enhancements

- Adds support for intraday historical data through `get_historical_intraday` of `stocks`.
- Adds support for the [Sector Performance](https://iextrading.com/developer/docs/sector-performance) endpoint of Stocks (thank you kafana).
- Adds support for the [List](https://iextrading.com/developer/docs/list) infocus endpoint of Stocks (thank you kafana).
- Adds support for the [Collections](https://iextrading.com/developer/docs/collections) endpoint of Stocks
- Adds support for the [Crypto](https://iextrading.com/developer/docs/crypto) endpoint of Stocks
- Adds support for the [Earnings Today](https://iextrading.com/developer/docs/earnings-today) endpoint of Stocks
- Adds support for the [IPO Calendar](https://iextrading.com/developer/docs/ipo-calendar) endpoint of Stocks
- Adds pandas DataFrame output formatting for `get_chart`, `get_dividends`, `get_earnings`, `get_financials`, and multiple `get_historical_data` symbol requests.
- Adds support for list-like data types for symbols (tuple, pandas.Series, numpy.ndarray, etc)
- Sets index of `DataFrame` historical and time series data to `pandas.DatetimeIndex` for easier sorting and wrangling (thank you Brian Wylie) [GH83](https://github.com/addisonlynch/iexfinance/issues/83)

Bug Fixes

- Some Stocks endpoints return incorrectly [GH34](https://github.com/addisonlynch/iexfinance/issues/34)
- `get_time_series` returns incorrect range when passed `range_` parameter
[GH84](https://github.com/addisonlynch/iexfinance/issues/84)
- Repaired issue where get\_historical\_data for an invalid symbol does not raise an exception [GH82](https://github.com/addisonlynch/iexfinance/issues/82)

Backward Compatability

- `Stock` and `get_historical_data` have been moved to `iexfinance.stocks`. The top-level functions remain with warnings but will be deprecated in v0.4.0.