info
ETF Information Overview.
Example
from openbb import obb
obb.etf.info("SPY", provider="fmp")
#### This function accepts multiple tickers. ####
obb.etf.info("SPY,IWM,QQQ,DJIA", provider="fmp")
Parameters
- standard
- fmp
- tmx
- yfinance
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, tmx, yfinance. | False | |
| provider | Literal['fmp', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, tmx, yfinance. | False | |
| provider | Literal['fmp', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, tmx, yfinance. | False | |
| provider | Literal['fmp', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
| use_cache | bool | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. | True | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | Union[str, List[str]] | Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, tmx, yfinance. | False | |
| provider | Literal['fmp', 'tmx', 'yfinance'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
Returns
OBBject
results : List[EtfInfo]
Serializable results.
provider : Optional[Literal['fmp', 'tmx', 'yfinance']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
Data
- standard
- fmp
- tmx
- yfinance
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. (ETF) |
| name | str | Name of the ETF. |
| description | str | Description of the fund. |
| inception_date | str | Inception date of the ETF. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. (ETF) |
| name | str | Name of the ETF. |
| description | str | Description of the fund. |
| inception_date | str | Inception date of the ETF. |
| issuer | str | Company of the ETF. |
| cusip | str | CUSIP of the ETF. |
| isin | str | ISIN of the ETF. |
| domicile | str | Domicile of the ETF. |
| asset_class | str | Asset class of the ETF. |
| aum | float | Assets under management. |
| nav | float | Net asset value of the ETF. |
| nav_currency | str | Currency of the ETF's net asset value. |
| expense_ratio | float | The expense ratio, as a normalized percent. |
| holdings_count | int | Number of holdings. |
| avg_volume | float | Average daily trading volume. |
| website | str | Website of the issuer. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. (ETF) |
| name | str | Name of the ETF. |
| description | str | Description of the fund. |
| inception_date | str | Inception date of the ETF. |
| issuer | str | The issuer of the ETF. |
| investment_style | str | The investment style of the ETF. |
| esg | bool | Whether the ETF qualifies as an ESG fund. |
| currency | str | The currency of the ETF. |
| unit_price | float | The unit price of the ETF. |
| close | float | The closing price of the ETF. |
| prev_close | float | The previous closing price of the ETF. |
| return_1m | float | The one-month return of the ETF, as a normalized percent |
| return_3m | float | The three-month return of the ETF, as a normalized percent. |
| return_6m | float | The six-month return of the ETF, as a normalized percent. |
| return_ytd | float | The year-to-date return of the ETF, as a normalized percent. |
| return_1y | float | The one-year return of the ETF, as a normalized percent. |
| return_3y | float | The three-year return of the ETF, as a normalized percent. |
| return_5y | float | The five-year return of the ETF, as a normalized percent. |
| return_10y | float | The ten-year return of the ETF, as a normalized percent. |
| return_from_inception | float | The return from inception of the ETF, as a normalized percent. |
| avg_volume | int | The average daily volume of the ETF. |
| avg_volume_30d | int | The 30-day average volume of the ETF. |
| aum | float | The AUM of the ETF. |
| pe_ratio | float | The price-to-earnings ratio of the ETF. |
| pb_ratio | float | The price-to-book ratio of the ETF. |
| management_fee | float | The management fee of the ETF, as a normalized percent. |
| mer | float | The management expense ratio of the ETF, as a normalized percent. |
| distribution_yield | float | The distribution yield of the ETF, as a normalized percent. |
| dividend_frequency | str | The dividend payment frequency of the ETF. |
| website | str | The website of the ETF. |
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. (ETF) |
| name | str | Name of the ETF. |
| description | str | Description of the fund. |
| inception_date | str | Inception date of the ETF. |
| fund_type | str | The legal type of fund. |
| fund_family | str | The fund family. |
| category | str | The fund category. |
| exchange | str | The exchange the fund is listed on. |
| exchange_timezone | str | The timezone of the exchange. |
| currency | str | The currency in which the fund is listed. |
| nav_price | float | The net asset value per unit of the fund. |
| total_assets | int | The total value of assets held by the fund. |
| trailing_pe | float | The trailing twelve month P/E ratio of the fund's assets. |
| dividend_yield | float | The dividend yield of the fund, as a normalized percent. |
| dividend_rate_ttm | float | The trailing twelve month annual dividend rate of the fund, in currency units. |
| dividend_yield_ttm | float | The trailing twelve month annual dividend yield of the fund, as a normalized percent. |
| year_high | float | The fifty-two week high price. |
| year_low | float | The fifty-two week low price. |
| ma_50d | float | 50-day moving average price. |
| ma_200d | float | 200-day moving average price. |
| return_ytd | float | The year-to-date return of the fund, as a normalized percent. |
| return_3y_avg | float | The three year average return of the fund, as a normalized percent. |
| return_5y_avg | float | The five year average return of the fund, as a normalized percent. |
| beta_3y_avg | float | The three year average beta of the fund. |
| volume_avg | float | The average daily trading volume of the fund. |
| volume_avg_10d | float | The average daily trading volume of the fund over the past ten days. |
| bid | float | The current bid price. |
| bid_size | float | The current bid size. |
| ask | float | The current ask price. |
| ask_size | float | The current ask size. |
| open | float | The open price of the most recent trading session. |
| high | float | The highest price of the most recent trading session. |
| low | float | The lowest price of the most recent trading session. |
| volume | int | The trading volume of the most recent trading session. |
| prev_close | float | The previous closing price. |