def etfs_as_df(country=None):
"""
This function retrieves all the available countries to retrieve etfs from, as the listed
countries are the ones indexed on Investing.com. The purpose of this function is to list
the countries which have available etfs according to Investing.com data, so to ease the
etf retrieval process of a particular country.
Args:
country (:obj:`str`, optional): name of the country to retrieve all its available etfs from.
Returns:
:obj:`pandas.DataFrame` - etfs:
The resulting :obj:`pandas.DataFrame` contains all the etfs basic information stored on `etfs.csv`, since it
was previously retrieved in `investpy.etfs.retrieve_etfs()`. Unless the country is specified, all the
available etfs indexed on Investing.com is returned, but if it is specified, just the etfs from that country
are returned.
In the case that the file reading of `etfs.csv` or the retrieval process from Investing.com was
successfully completed, the resulting :obj:`pandas.DataFrame` will look like::
country | name | symbol | tag | id | currency
--------|------|--------|-----|----|----------
xxxxxxx | xxxx | xxxxxx | xxx | xx | xxxxxxxx
Raises:
ValueError: raised when any of the input arguments is not valid.
IOError: raised when `etfs.csv` file is missing.
"""
if country is not None and not isinstance(country, str):
raise ValueError("ERR#0025: specified country value not valid.")
resource_package = 'investpy'
resource_path = '/'.join(('resources', 'etfs', 'etfs.csv'))
if pkg_resources.resource_exists(resource_package, resource_path):
etfs = pd.read_csv(pkg_resources.resource_filename(resource_package, resource_path))
else:
etfs = retrieve_etfs(test_mode=False)
if etfs is None:
raise IOError("ERR#0009: etf list not found or unable to retrieve.")
if country is None:
etfs.reset_index(drop=True, inplace=True)
return etfs
elif unidecode.unidecode(country.lower()) in etf_countries_as_list():
etfs = etfs[etfs['country'] == unidecode.unidecode(country.lower())]
etfs.reset_index(drop=True, inplace=True)
return etfs
def etfs_as_list(country=None):
"""
This function retrieves all the available etfs indexed on Investing.com, already
stored on `etfs.csv`, which if does not exists, will be created by `investpy.etfs.retrieve_etfs()`.
This function also allows the users to specify which country do they want to retrieve data from or if they
want to retrieve it from every listed country; so on, a listing of etfs will be returned. This function
helps the user to get to know which etfs are available on Investing.com.
Args:
country (:obj:`str`, optional): name of the country to retrieve all its available etfs from.
Returns:
:obj:`list` - etfs_list:
The resulting :obj:`list` contains the retrieved data from the `etfs.csv` file, which is
a listing of the names of the etfs listed on Investing.com, which is the input for data
retrieval functions as the name of the etf to retrieve data from needs to be specified.
In case the listing was successfully retrieved, the :obj:`list` will look like::
etfs_list = ['Betashares U.S. Equities Strong Bear Currency Hedg',
'Betashares Active Australian Hybrids',
'Australian High Interest Cash', ...]
Raises:
ValueError: raised when any of the input arguments is not valid.
IOError: raised when `etfs.csv` file is missing or empty.
"""
if country is not None and not isinstance(country, str):
raise ValueError("ERR#0025: specified country value not valid.")
resource_package = 'investpy'
resource_path = '/'.join(('resources', 'etfs', 'etfs.csv'))
if pkg_resources.resource_exists(resource_package, resource_path):
etfs = pd.read_csv(pkg_resources.resource_filename(resource_package, resource_path))
else:
etfs = retrieve_etfs(test_mode=False)
if etfs is None:
raise IOError("ERR#0009: etf list not found or unable to retrieve.")
if country is None:
return etfs['name'].tolist()
elif country in etf_countries_as_list():
return etfs[etfs['country'] == unidecode.unidecode(country.lower())]['name'].tolist()
def test_etfs_errors():
"""
This function raises errors on etf retrieval functions
"""
try:
retrieve_etfs(test_mode=None)
except:
pass
params = [
{
'country': ['error']
},
{
'country': 'error'
},
]
for param in params:
try:
investpy.get_etfs(country=param['country'])
except:
pass
try:
investpy.get_etfs_list(country=param['country'])
except:
pass
params = [
{
'country': ['error'],
'columns': None,
'as_json': False
},
{
'country': 'spain',
'columns': None,
'as_json': 'error'
},
{
'country': 'spain',
'columns': 0,
'as_json': True
},
{
'country': 'spain',
'columns': ['error'],
'as_json': False
},
]
for param in params:
try:
investpy.get_etfs_dict(country=param['country'],
columns=param['columns'],
as_json=param['as_json'])
except:
pass
params = [
{
'etf': None,
'country': 'spain',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': ['error'],
'country': 'spain',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': None,
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'error',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'netherlands',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': ['error'],
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'as_json': 'error',
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'as_json': True,
'order': 'error',
'debug': True
},
{
'etf': 'error',
'country': 'spain',
'as_json': True,
'order': 'ascending',
'debug': True
},
{
'etf': ['error'],
'country': 'spain',
'as_json': True,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'as_json': True,
'order': 'ascending',
'debug': 'error'
},
]
for param in params:
try:
investpy.get_etf_recent_data(etf=param['etf'],
country=param['country'],
as_json=param['as_json'],
order=param['order'],
debug=param['debug'])
except:
pass
params = [
{
'etf': None,
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'error',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'netherlands',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': None,
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': ['error'],
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': 'error',
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'error',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'from_date': 'error',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'from_date': '01/01/2019',
'to_date': 'error',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'error',
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': ['error'],
'country': 'spain',
'from_date': '01/01/2018',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'from_date': '01/01/1998',
'to_date': '01/01/2019',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'from_date': '01/01/2019',
'to_date': '01/01/1998',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'from_date': '01/01/1900',
'to_date': '01/01/1950',
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'etf': 'bbva accion dj eurostoxx 50',
'country': 'spain',
'from_date': '01/01/2019',
'to_date': '01/03/2019',
'as_json': True,
'order': 'ascending',
'debug': 'error'
},
]
for param in params:
try:
investpy.get_etf_historical_data(etf=param['etf'],
country=param['country'],
from_date=param['from_date'],
to_date=param['to_date'],
as_json=param['as_json'],
order=param['order'],
debug=param['debug'])
except:
pass
params = [
{
'country': 'error',
'as_json': False,
},
{
'country': None,
'as_json': False,
},
{
'country': ['error'],
'as_json': False,
},
{
'country': 'spain',
'as_json': None,
},
{
'country': 'spain',
'as_json': ['error'],
},
]
for param in params:
try:
investpy.get_etfs_overview(country=param['country'])
except:
pass
params = [
{
'by': None,
'value': 'bbva',
},
{
'by': ['error'],
'value': 'bbva',
},
{
'by': 'error',
'value': 'bbva',
},
{
'by': 'name',
'value': None,
},
{
'by': 'name',
'value': ['error'],
},
{
'by': 'isin',
'value': 'error',
},
]
for param in params:
try:
investpy.search_etfs(by=param['by'], value=param['value'])
except:
pass
def test_investpy_etfs():
"""
This function checks that etf data retrieval functions listed in investpy work properly.
"""
params = [
{
'country': 'spain',
},
{
'country': None,
},
]
for param in params:
investpy.get_etfs(country=param['country'])
investpy.get_etfs_list(country=param['country'])
params = [
{
'country': None,
'columns': ['id', 'name'],
'as_json': True
},
{
'country': None,
'columns': ['id', 'name'],
'as_json': False
},
{
'country': 'spain',
'columns': ['id', 'name'],
'as_json': True
},
{
'country': 'spain',
'columns': ['id', 'name'],
'as_json': False
},
{
'country': 'spain',
'columns': None,
'as_json': False
},
]
for param in params:
investpy.get_etfs_dict(country=param['country'],
columns=param['columns'],
as_json=param['as_json'])
investpy.get_etf_countries()
params = [
{
'as_json': True,
'order': 'ascending',
'debug': False
},
{
'as_json': False,
'order': 'ascending',
'debug': True
},
{
'as_json': True,
'order': 'descending',
'debug': False
},
{
'as_json': False,
'order': 'descending',
'debug': False
},
]
for param in params:
investpy.get_etf_recent_data(etf='bbva accion dj eurostoxx 50',
country='spain',
as_json=param['as_json'],
order=param['order'],
debug=param['debug'])
investpy.get_etf_historical_data(etf='bbva accion dj eurostoxx 50',
country='spain',
from_date='01/01/2010',
to_date='01/01/2019',
as_json=param['as_json'],
order=param['order'],
debug=param['debug'])
params = [
{
'country': 'france',
'as_json': True,
},
{
'country': 'france',
'as_json': False,
},
]
for param in params:
investpy.get_etfs_overview(country=param['country'],
as_json=param['as_json'])
investpy.search_etfs(by='name', value='bbva')
retrieve_etfs(test_mode=True)
def etfs_as_dict(country=None, columns=None, as_json=False):
"""
This function retrieves all the available etfs indexed on Investing.com, already
stored on `etfs.csv`, which if does not exists, will be created by `investpy.etfs.retrieve_etfs()`.
This function also allows the user to specify which country do they want to retrieve data from,
or from every listed country; the columns which the user wants to be included on the resulting
:obj:`dict`; and the output of the function will either be a :obj:`dict` or a :obj:`json`.
Args:
country (:obj:`str`, optional): name of the country to retrieve all its available etfs from.
columns (:obj:`list`, optional):
names of the columns of the etf data to retrieve <country, country_code, id, name, symbol, tag>
as_json (:obj:`bool`, optional):
value to determine the format of the output data which can either be a :obj:`dict` or a :obj:`json`.
Returns:
:obj:`dict` or :obj:`json` - etfs_dict:
The resulting :obj:`dict` contains the retrieved data if found, if not, the corresponding
fields are filled with `None` values.
In case the information was successfully retrieved, the :obj:`dict` will look like::
{
'country': country,
'id': id,
'tag': tag,
'name': name,
'symbol': symbol,
'currency': currency
}
Raises:
ValueError: raised when any of the input arguments is not valid.
IOError: raised when `etfs.csv` file is missing or empty.
"""
if country is not None and not isinstance(country, str):
raise ValueError("ERR#0025: specified country value not valid.")
if not isinstance(as_json, bool):
raise ValueError("ERR#0002: as_json argument can just be True or False, bool type.")
resource_package = 'investpy'
resource_path = '/'.join(('resources', 'etfs', 'etfs.csv'))
if pkg_resources.resource_exists(resource_package, resource_path):
etfs = pd.read_csv(pkg_resources.resource_filename(resource_package, resource_path))
else:
etfs = retrieve_etfs(test_mode=False)
if etfs is None:
raise IOError("ERR#0009: etf list not found or unable to retrieve.")
if columns is None:
columns = etfs.columns.tolist()
else:
if not isinstance(columns, list):
raise ValueError("ERR#0020: specified columns argument is not a list, it can just be list type.")
if not all(column in etfs.columns.tolist() for column in columns):
raise ValueError("ERR#0021: specified columns does not exist, available columns are "
"<country, id, name, symbol, tag, currency>")
if country is None:
if as_json:
return json.dumps(etfs[columns].to_dict(orient='records'))
else:
return etfs[columns].to_dict(orient='records')
elif country in etf_countries_as_list():
if as_json:
return json.dumps(
etfs[etfs['country'] == unidecode.unidecode(country.lower())][columns].to_dict(orient='records'))
else:
return etfs[etfs['country'] == unidecode.unidecode(country.lower())][columns].to_dict(orient='records')