diff --git "a/examples/findSymbols.ipynb" "b/examples/findSymbols.ipynb" new file mode 100644--- /dev/null +++ "b/examples/findSymbols.ipynb" @@ -0,0 +1,3130 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Finding Symbols\n", + "\n", + "\n", + "Finding the ticker symbol, security identifier, the sector, and other metadata is easy if you know where to look. This guide is intended to introduce some methods for searching, screening, and discovery.\n", + "\n", + "For maximum coverage and functionality, install OpenBB with `[all]` packages.\n", + "\n", + "The examples here will assume that the OpenBB Platform has been installed, the environment is active, and it has been imported into a Python session. If the installation is fresh, or an extension was just installed, the Python interface will need to be rebuilt. It will only take a few moments to complete." + ] + }, + { + "cell_type": "code", + "execution_count": 1, + "metadata": {}, + "outputs": [], + "source": [ + "from openbb import obb" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "The simplest way to find tickers is with a basic text query.\n", + "\n", + "## Search Nasdaq" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamenasdaq_tradedexchangeetfround_lot_sizetest_issuecqs_symbolnasdaq_symbolnext_sharesmarket_categoryfinancial_status
0AMJBJPMorgan Chase & Co. Alerian MLP Index ETNs du...YPY100.0NAMJBAMJBNNaNNaN
1BBAGJPMorgan BetaBuilders U.S. Aggregate Bond ETFYPY100.0NBBAGBBAGNNaNNaN
2BBAXJPMorgan BetaBuilders Developed Asia Pacific-e...YZY100.0NBBAXBBAXNNaNNaN
\n", + "
" + ], + "text/plain": [ + " symbol name nasdaq_traded \\\n", + "0 AMJB JPMorgan Chase & Co. Alerian MLP Index ETNs du... Y \n", + "1 BBAG JPMorgan BetaBuilders U.S. Aggregate Bond ETF Y \n", + "2 BBAX JPMorgan BetaBuilders Developed Asia Pacific-e... Y \n", + "\n", + " exchange etf round_lot_size test_issue cqs_symbol nasdaq_symbol \\\n", + "0 P Y 100.0 N AMJB AMJB \n", + "1 P Y 100.0 N BBAG BBAG \n", + "2 Z Y 100.0 N BBAX BBAX \n", + "\n", + " next_shares market_category financial_status \n", + "0 N NaN NaN \n", + "1 N NaN NaN \n", + "2 N NaN NaN " + ] + }, + "execution_count": 2, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "obb.equity.search(\"JPMorgan\", provider=\"nasdaq\").to_df().head(3)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Search Cboe" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamedescriptiondata_delaycurrencytime_zoneopen_timeclose_timetick_daystick_frequencytick_perioddisplay_override_auto_hideshow_intraday_chart
31SPXUIVPROSHARES ULTRAPRO SHORT SP500 ETFPROSHARES ULTRAPRO SHORT SP500 ETF\\n15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegularFalseTrue
32SPXVIVPROSHARES S&P 500 EX-HEALTH CARE ETFPROSHARES S&P 500 EX-HEALTH CARE ETF15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegularFalseTrue
33VIX1DCboe 1-Day Volatility Index®Estimates expected volatility by aggregating t...15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegularFalseTrue
34VIX3MCboe S&P 500 3 Month Volatility IndexThe Cboe 3-Month Volatility Index (VIX3M) is d...15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegularFalseTrue
35WPUTCboe S&P 500 One-Week PutWrite IndexTracks the value of a portfolio that overlays ...15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegularFalseTrue
\n", + "
" + ], + "text/plain": [ + " symbol name \\\n", + "31 SPXUIV PROSHARES ULTRAPRO SHORT SP500 ETF \n", + "32 SPXVIV PROSHARES S&P 500 EX-HEALTH CARE ETF \n", + "33 VIX1D Cboe 1-Day Volatility Index® \n", + "34 VIX3M Cboe S&P 500 3 Month Volatility Index \n", + "35 WPUT Cboe S&P 500 One-Week PutWrite Index \n", + "\n", + " description data_delay currency \\\n", + "31 PROSHARES ULTRAPRO SHORT SP500 ETF\\n 15 USD \n", + "32 PROSHARES S&P 500 EX-HEALTH CARE ETF 15 USD \n", + "33 Estimates expected volatility by aggregating t... 15 USD \n", + "34 The Cboe 3-Month Volatility Index (VIX3M) is d... 15 USD \n", + "35 Tracks the value of a portfolio that overlays ... 15 USD \n", + "\n", + " time_zone open_time close_time tick_days tick_frequency tick_period \\\n", + "31 America/Chicago 08:00:00 16:00:00 MonToFri C Regular \n", + "32 America/Chicago 08:00:00 16:00:00 MonToFri C Regular \n", + "33 America/Chicago 08:00:00 16:00:00 MonToFri C Regular \n", + "34 America/Chicago 08:00:00 16:00:00 MonToFri C Regular \n", + "35 America/Chicago 08:00:00 16:00:00 MonToFri C Regular \n", + "\n", + " display_override_auto_hide show_intraday_chart \n", + "31 False True \n", + "32 False True \n", + "33 False True \n", + "34 False True \n", + "35 False True " + ] + }, + "execution_count": 3, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "obb.index.search(\"SPX\", provider=\"cboe\").to_df().tail(5)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Search ETFs" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnameshort_nameinception_dateissuerinvestment_styleesgcurrencyunit_priceclose...beta_3yreturn_5yreturn_10ybeta_10ybeta_15ymerdividend_frequencype_ratiopb_ratiobeta_20y
21ZGDBMO Equal Weight Global Gold Index ETFZGD:CA2012-11-14BMO ETFMid Cap BlendFalseCAD104.80106.56...0.6585570.130072-0.0795310.444583NaN0.0062Annually9.09390.8812NaN
22ZGLDBMO Gold Bullion ETFZGLD:CA2024-03-08BMO ETFGoldFalseCAD36.8336.83...NaNNaNNaNNaNNaNNaNNaNNaNNaNNaN
23ZGLD.UBMO Gold Bullion ETFZGLD.U:CA2024-03-08BMO ETFGoldFalseUSD36.0536.70...NaNNaNNaNNaNNaNNaNNaNNaNNaNNaN
24ZGLHBMO Gold Bullion Hedged to CAD ETFZGLH:CA2024-03-08BMO ETFGoldFalseCAD34.0435.77...NaNNaNNaNNaNNaNNaNNaNNaNNaNNaN
25ZJGBMO Junior Gold Index ETFZJG:CA2010-01-19BMO ETFSmall Cap BlendTrueCAD92.7592.84...0.6414480.087857-0.1119920.449994NaN0.0061Annually13.59590.9830NaN
\n", + "

5 rows × 35 columns

\n", + "
" + ], + "text/plain": [ + " symbol name short_name inception_date \\\n", + "21 ZGD BMO Equal Weight Global Gold Index ETF ZGD:CA 2012-11-14 \n", + "22 ZGLD BMO Gold Bullion ETF ZGLD:CA 2024-03-08 \n", + "23 ZGLD.U BMO Gold Bullion ETF ZGLD.U:CA 2024-03-08 \n", + "24 ZGLH BMO Gold Bullion Hedged to CAD ETF ZGLH:CA 2024-03-08 \n", + "25 ZJG BMO Junior Gold Index ETF ZJG:CA 2010-01-19 \n", + "\n", + " issuer investment_style esg currency unit_price close ... \\\n", + "21 BMO ETF Mid Cap Blend False CAD 104.80 106.56 ... \n", + "22 BMO ETF Gold False CAD 36.83 36.83 ... \n", + "23 BMO ETF Gold False USD 36.05 36.70 ... \n", + "24 BMO ETF Gold False CAD 34.04 35.77 ... \n", + "25 BMO ETF Small Cap Blend True CAD 92.75 92.84 ... \n", + "\n", + " beta_3y return_5y return_10y beta_10y beta_15y mer \\\n", + "21 0.658557 0.130072 -0.079531 0.444583 NaN 0.0062 \n", + "22 NaN NaN NaN NaN NaN NaN \n", + "23 NaN NaN NaN NaN NaN NaN \n", + "24 NaN NaN NaN NaN NaN NaN \n", + "25 0.641448 0.087857 -0.111992 0.449994 NaN 0.0061 \n", + "\n", + " dividend_frequency pe_ratio pb_ratio beta_20y \n", + "21 Annually 9.0939 0.8812 NaN \n", + "22 NaN NaN NaN NaN \n", + "23 NaN NaN NaN NaN \n", + "24 NaN NaN NaN NaN \n", + "25 Annually 13.5959 0.9830 NaN \n", + "\n", + "[5 rows x 35 columns]" + ] + }, + "execution_count": 5, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "obb.etf.search(\"gold\", provider=\"tmx\").to_df().iloc[-5:]" + ] + }, + { + "cell_type": "code", + "execution_count": 6, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamemarket_capsectorindustrybetapricelast_annual_dividendvolumeexchangeexchange_namecountryactively_tradingisFund
0QYLDGlobal X NASDAQ 100 Covered Call ETF8.197931e+09Financial ServicesAsset Management - Global0.6517.79502.059945225008.0NASDAQNASDAQ Global MarketUSTrueFalse
1ZWB.TOBMO Covered Call Canadian Banks ETF2.988597e+09Financial ServicesAsset Management0.9618.26001.3200088508.0TSXToronto Stock ExchangeCATrueFalse
2XYLDGlobal X S&P 500 Covered Call ETF2.885254e+09Financial ServicesAsset Management - Global0.5140.98253.82220157906.0AMEXNew York Stock Exchange ArcaUSTrueFalse
3ZWU.TOBMO Covered Call Utilities ETF1.863225e+09Financial ServicesAsset Management0.6210.79000.8400058903.0TSXToronto Stock ExchangeCATrueFalse
4ZWC.TOBMO CA High Dividend Covered Call ETF1.637541e+09Financial ServicesAsset Management0.8917.62001.5400022081.0TSXToronto Stock ExchangeCATrueFalse
\n", + "
" + ], + "text/plain": [ + " symbol name market_cap \\\n", + "0 QYLD Global X NASDAQ 100 Covered Call ETF 8.197931e+09 \n", + "1 ZWB.TO BMO Covered Call Canadian Banks ETF 2.988597e+09 \n", + "2 XYLD Global X S&P 500 Covered Call ETF 2.885254e+09 \n", + "3 ZWU.TO BMO Covered Call Utilities ETF 1.863225e+09 \n", + "4 ZWC.TO BMO CA High Dividend Covered Call ETF 1.637541e+09 \n", + "\n", + " sector industry beta price \\\n", + "0 Financial Services Asset Management - Global 0.65 17.7950 \n", + "1 Financial Services Asset Management 0.96 18.2600 \n", + "2 Financial Services Asset Management - Global 0.51 40.9825 \n", + "3 Financial Services Asset Management 0.62 10.7900 \n", + "4 Financial Services Asset Management 0.89 17.6200 \n", + "\n", + " last_annual_dividend volume exchange exchange_name \\\n", + "0 2.05994 5225008.0 NASDAQ NASDAQ Global Market \n", + "1 1.32000 88508.0 TSX Toronto Stock Exchange \n", + "2 3.82220 157906.0 AMEX New York Stock Exchange Arca \n", + "3 0.84000 58903.0 TSX Toronto Stock Exchange \n", + "4 1.54000 22081.0 TSX Toronto Stock Exchange \n", + "\n", + " country actively_trading isFund \n", + "0 US True False \n", + "1 CA True False \n", + "2 US True False \n", + "3 CA True False \n", + "4 CA True False " + ] + }, + "execution_count": 6, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "obb.etf.search(\"covered call\", provider=\"fmp\").to_df().iloc[:5]" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Search the SEC\n", + "\n", + "Use an empty string, `\"\"`, to return the complete list - over 10,000.\n", + "\n", + "The SEC sorts this list by market cap. Applying the `to_df()` method to `all_companies` will show them from biggest-to-smallest." + ] + }, + { + "cell_type": "code", + "execution_count": 8, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "10551\n" + ] + }, + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamecik
0MSFTMICROSOFT CORP789019
1AAPLApple Inc.320193
2GOOGLAlphabet Inc.1652044
3NVDANVIDIA CORP1045810
4AMZNAMAZON COM INC1018724
5METAMeta Platforms, Inc.1326801
6BRK-BBERKSHIRE HATHAWAY INC1067983
7LLYELI LILLY & Co59478
8TSMTAIWAN SEMICONDUCTOR MANUFACTURING CO LTD1046179
9AVGOBroadcom Inc.1730168
\n", + "
" + ], + "text/plain": [ + " symbol name cik\n", + "0 MSFT MICROSOFT CORP 789019\n", + "1 AAPL Apple Inc. 320193\n", + "2 GOOGL Alphabet Inc. 1652044\n", + "3 NVDA NVIDIA CORP 1045810\n", + "4 AMZN AMAZON COM INC 1018724\n", + "5 META Meta Platforms, Inc. 1326801\n", + "6 BRK-B BERKSHIRE HATHAWAY INC 1067983\n", + "7 LLY ELI LILLY & Co 59478\n", + "8 TSM TAIWAN SEMICONDUCTOR MANUFACTURING CO LTD 1046179\n", + "9 AVGO Broadcom Inc. 1730168" + ] + }, + "execution_count": 8, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "all_companies = obb.equity.search(\"\", provider=\"sec\")\n", + "\n", + "print(len(all_companies.results))\n", + "\n", + "all_companies.to_df().head(10)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Find an Institution\n", + "\n", + "Some reporting companies, like invesment trusts and insurance companies, do not have a ticker symbol directly associated with them. Filers in the US will have a CIK number, used to retrieve documents from the SEC." + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
namecik
0BERKSHIRE HATHAWAY ENERGY CO0001081316
1BERKSHIRE HATHAWAY FINANCE CORP0001274791
2BERKSHIRE HATHAWAY HOMESTATE INSURANCE CO.0000829771
3BERKSHIRE HATHAWAY INC /DE/0000109694
4BERKSHIRE HATHAWAY INC/DE0000109694
5BERKSHIRE HATHAWAY INC0001067983
6BERKSHIRE HATHAWAY LIFE INSURANCE CO OF NEBRASKA0001015867
7LMZ & BERKSHIRE HATHAWAY CO0001652795
\n", + "
" + ], + "text/plain": [ + " name cik\n", + "0 BERKSHIRE HATHAWAY ENERGY CO 0001081316\n", + "1 BERKSHIRE HATHAWAY FINANCE CORP 0001274791\n", + "2 BERKSHIRE HATHAWAY HOMESTATE INSURANCE CO. 0000829771\n", + "3 BERKSHIRE HATHAWAY INC /DE/ 0000109694\n", + "4 BERKSHIRE HATHAWAY INC/DE 0000109694\n", + "5 BERKSHIRE HATHAWAY INC 0001067983\n", + "6 BERKSHIRE HATHAWAY LIFE INSURANCE CO OF NEBRASKA 0001015867\n", + "7 LMZ & BERKSHIRE HATHAWAY CO 0001652795" + ] + }, + "execution_count": 9, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "instututions = obb.regulators.sec.institutions_search(\"Berkshire Hathaway\").to_df()\n", + "instututions" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Find a Filing\n", + "\n", + "Search for filings by CIK or ticker symbol." + ] + }, + { + "cell_type": "code", + "execution_count": 10, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "filing_date 2003-02-14\n", + "accepted_date 2003-02-14 00:00:00\n", + "report_type 13F-NT\n", + "filing_url https://www.sec.gov/Archives/edgar/data/000082...\n", + "report_url https://www.sec.gov/Archives/edgar/data/000082...\n", + "report_date 2002-12-31\n", + "act \n", + "items \n", + "primary_doc_description FORM 13F-NT, PERIOD ENDED 12/31/2002\n", + "primary_doc a87269a7e13fvnt.txt\n", + "accession_number 0000950150-03-000213\n", + "file_number 028-02226\n", + "film_number 03565329\n", + "is_inline_xbrl 0\n", + "is_xbrl 0\n", + "size 4246\n", + "complete_submission_url https://www.sec.gov/Archives/edgar/data/000082...\n", + "Name: 84, dtype: object" + ] + }, + "execution_count": 10, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "homestate_filings = obb.equity.fundamental.filings(cik=\"0000829771\", provider=\"sec\")\n", + "\n", + "homestate_filings.to_df().iloc[-1]" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Or, search by form type." + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "filing_date 2024-01-11\n", + "accepted_date 2024-01-11 00:00:00\n", + "report_type DEF 14A\n", + "filing_url https://www.sec.gov/Archives/edgar/data/000032...\n", + "report_url https://www.sec.gov/Archives/edgar/data/000032...\n", + "report_date 2024-02-28\n", + "act 34\n", + "items \n", + "primary_doc_description APPLE INC. - DEF 14A\n", + "primary_doc laapl2024_def14a.htm\n", + "accession_number 0001308179-24-000010\n", + "file_number 001-36743\n", + "film_number 24529569\n", + "is_inline_xbrl 1\n", + "is_xbrl 1\n", + "size 9051163\n", + "complete_submission_url https://www.sec.gov/Archives/edgar/data/000032...\n", + "Name: 0, dtype: object" + ] + }, + "execution_count": 12, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "aapl_filings = obb.equity.fundamental.filings(\"AAPL\", type=\"4\", provider=\"sec\")\n", + "\n", + "aapl_filings.to_df().iloc[0]" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Screen Markets\n", + "\n", + "Screeners provide a targeted search, a tool for comparison and discovery. Find stocks from around the world with the screener endpoint, and the `openbb-fmp` provider.\n", + "\n", + "### Find Stocks From India" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "5662" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamemarket_capsectorindustrybetapricelast_annual_dividendvolumeexchangeexchange_namecountryis_etfactively_tradingisFund
0RELIANCE.NSReliance Industries Limited20273316637500EnergyOil & Gas Refining & Marketing0.6312996.2510.05222236NSENational Stock Exchange of IndiaINFalseTrueFalse
1RELIANCE.BOReliance Industries Limited20265535473000EnergyOil & Gas Refining & Marketing0.6312995.110.0193482BSEBombay Stock ExchangeINFalseTrueFalse
2TCS.NSTata Consultancy Services Limited16288641180000TechnologyInformation Technology Services0.5314502.056.01829132NSENational Stock Exchange of IndiaINFalseTrueFalse
3TCS.BOTata Consultancy Services Limited16281224095500TechnologyInformation Technology Services0.5314499.9556.081625BSEBombay Stock ExchangeINFalseTrueFalse
4HDFCBANK.NSHDFC Bank Limited12426411437000Financial ServicesBanks - Regional0.8331631.319.510645258NSENational Stock Exchange of IndiaINFalseTrueFalse
\n", + "
" + ], + "text/plain": [ + " symbol name market_cap \\\n", + "0 RELIANCE.NS Reliance Industries Limited 20273316637500 \n", + "1 RELIANCE.BO Reliance Industries Limited 20265535473000 \n", + "2 TCS.NS Tata Consultancy Services Limited 16288641180000 \n", + "3 TCS.BO Tata Consultancy Services Limited 16281224095500 \n", + "4 HDFCBANK.NS HDFC Bank Limited 12426411437000 \n", + "\n", + " sector industry beta price \\\n", + "0 Energy Oil & Gas Refining & Marketing 0.631 2996.25 \n", + "1 Energy Oil & Gas Refining & Marketing 0.631 2995.1 \n", + "2 Technology Information Technology Services 0.531 4502.0 \n", + "3 Technology Information Technology Services 0.531 4499.95 \n", + "4 Financial Services Banks - Regional 0.833 1631.3 \n", + "\n", + " last_annual_dividend volume exchange exchange_name \\\n", + "0 10.0 5222236 NSE National Stock Exchange of India \n", + "1 10.0 193482 BSE Bombay Stock Exchange \n", + "2 56.0 1829132 NSE National Stock Exchange of India \n", + "3 56.0 81625 BSE Bombay Stock Exchange \n", + "4 19.5 10645258 NSE National Stock Exchange of India \n", + "\n", + " country is_etf actively_trading isFund \n", + "0 IN False True False \n", + "1 IN False True False \n", + "2 IN False True False \n", + "3 IN False True False \n", + "4 IN False True False " + ] + }, + "execution_count": 7, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "results = obb.equity.screener(country=\"IN\", provider=\"fmp\").to_df()\n", + "display(len(results))\n", + "results.head(5).convert_dtypes()" + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "9" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamelast_pricechangechange_percentmarket_cap
0IBNICICI Bank Limited Common Stock28.380.280.0099699843513339
1SIFYSify Technologies Limited American Depositary ...0.3256-0.0256-0.0728959693049
2RDYDr. Reddy's Laboratories Ltd Common Stock82.698-1.512-0.0179613795536962
3WITWipro Limited Common Stock6.16-0.1-0.0159732186851595
4HDBHDFC Bank Limited Common Stock59.805-0.645-0.01067151444414047
\n", + "
" + ], + "text/plain": [ + " symbol name last_price \\\n", + "0 IBN ICICI Bank Limited Common Stock 28.38 \n", + "1 SIFY Sify Technologies Limited American Depositary ... 0.3256 \n", + "2 RDY Dr. Reddy's Laboratories Ltd Common Stock 82.698 \n", + "3 WIT Wipro Limited Common Stock 6.16 \n", + "4 HDB HDFC Bank Limited Common Stock 59.805 \n", + "\n", + " change change_percent market_cap \n", + "0 0.28 0.00996 99843513339 \n", + "1 -0.0256 -0.07289 59693049 \n", + "2 -1.512 -0.01796 13795536962 \n", + "3 -0.1 -0.01597 32186851595 \n", + "4 -0.645 -0.01067 151444414047 " + ] + }, + "execution_count": 9, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# The Nasdaq screener is limited to the American market listings.\n", + "results = obb.equity.screener(country=\"india\", provider=\"nasdaq\").to_df()\n", + "display(len(results))\n", + "results.head(5).convert_dtypes()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Search by Sector" + ] + }, + { + "cell_type": "code", + "execution_count": 11, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "778" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamemarket_capsectorindustrybetapricelast_annual_dividendvolumeexchangeexchange_namecountryis_etfactively_tradingisFund
0HDFCBANK.NSHDFC Bank Limited12426411437000Financial ServicesBanks - Regional0.8331631.319.510645258NSENational Stock Exchange of IndiaINFalseTrueFalse
1ICICIBANK.NSICICI Bank Limited8386856697000Financial ServicesBanks - Regional0.8621191.110.08563551NSENational Stock Exchange of IndiaINFalseTrueFalse
2SBIN.NSState Bank of India7320857583000Financial ServicesBanks - Regional0.888820.313.77829674NSENational Stock Exchange of IndiaINFalseTrueFalse
3SBIN.BOState Bank of India7319518891500Financial ServicesBanks - Regional0.888820.1513.7494896BSEBombay Stock ExchangeINFalseTrueFalse
4LICI.BOLife Insurance Corporation of India6803167418560Financial ServicesInsurance - Life0.5761075.613.029486BSEBombay Stock ExchangeINFalseTrueFalse
\n", + "
" + ], + "text/plain": [ + " symbol name market_cap \\\n", + "0 HDFCBANK.NS HDFC Bank Limited 12426411437000 \n", + "1 ICICIBANK.NS ICICI Bank Limited 8386856697000 \n", + "2 SBIN.NS State Bank of India 7320857583000 \n", + "3 SBIN.BO State Bank of India 7319518891500 \n", + "4 LICI.BO Life Insurance Corporation of India 6803167418560 \n", + "\n", + " sector industry beta price last_annual_dividend \\\n", + "0 Financial Services Banks - Regional 0.833 1631.3 19.5 \n", + "1 Financial Services Banks - Regional 0.862 1191.1 10.0 \n", + "2 Financial Services Banks - Regional 0.888 820.3 13.7 \n", + "3 Financial Services Banks - Regional 0.888 820.15 13.7 \n", + "4 Financial Services Insurance - Life 0.576 1075.6 13.0 \n", + "\n", + " volume exchange exchange_name country is_etf \\\n", + "0 10645258 NSE National Stock Exchange of India IN False \n", + "1 8563551 NSE National Stock Exchange of India IN False \n", + "2 7829674 NSE National Stock Exchange of India IN False \n", + "3 494896 BSE Bombay Stock Exchange IN False \n", + "4 29486 BSE Bombay Stock Exchange IN False \n", + "\n", + " actively_trading isFund \n", + "0 True False \n", + "1 True False \n", + "2 True False \n", + "3 True False \n", + "4 True False " + ] + }, + "execution_count": 11, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "sector_results = obb.equity.screener(\n", + " country=\"IN\", sector=\"financial_services\", provider=\"fmp\"\n", + ").to_df()\n", + "display(len(sector_results))\n", + "sector_results.head(5).convert_dtypes()" + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "1617" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamelast_pricechangechange_percentmarket_cap
0CELZCreative Medical Technology Holdings, Inc. Com...3.50.31690.099564683441
1STECSantech Holdings Limited American Depositary S...0.480.0430.098413440000
2RILYGB. Riley Financial, Inc. 5.00% Senior Notes du...12.01.030.09389363543636
3PFTAPerception Capital Corp. III Class A Ordinary ...11.750.980.09099<NA>
4ALFUWCenturion Acquisition Corp. Warrant0.11990.00990.09<NA>
\n", + "
" + ], + "text/plain": [ + " symbol name last_price \\\n", + "0 CELZ Creative Medical Technology Holdings, Inc. Com... 3.5 \n", + "1 STEC Santech Holdings Limited American Depositary S... 0.48 \n", + "2 RILYG B. Riley Financial, Inc. 5.00% Senior Notes du... 12.0 \n", + "3 PFTA Perception Capital Corp. III Class A Ordinary ... 11.75 \n", + "4 ALFUW Centurion Acquisition Corp. Warrant 0.1199 \n", + "\n", + " change change_percent market_cap \n", + "0 0.3169 0.09956 4683441 \n", + "1 0.043 0.0984 13440000 \n", + "2 1.03 0.09389 363543636 \n", + "3 0.98 0.09099 \n", + "4 0.0099 0.09 " + ] + }, + "execution_count": 12, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# The same can be done with the Nasdaq provider, covering the American market.\n", + "sector_results = obb.equity.screener(\n", + " sector=\"financial_services\", provider=\"nasdaq\"\n", + ").to_df()\n", + "display(len(sector_results))\n", + "sector_results.head(5).convert_dtypes()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Search by Industry" + ] + }, + { + "cell_type": "code", + "execution_count": 19, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "25" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamecountrysectorindustrymarket_cappricechange_percentvolumeprice_to_earnings
0XELBXcel Brands IncUSAConsumer CyclicalApparel Manufacturing1.696000e+070.720.04602070NaN
1SGCSuperior Group of Companies Inc..USAConsumer CyclicalApparel Manufacturing2.280000e+0813.600.00493950219.84
2JRSHJerash holdings (US) IncUSAConsumer CyclicalApparel Manufacturing3.626000e+072.950.00341348NaN
3PVHPVH CorpUSAConsumer CyclicalApparel Manufacturing5.740000e+09102.71-0.00132531069.09
4RLRalph Lauren CorpUSAConsumer CyclicalApparel Manufacturing1.051000e+10169.68-0.002715736516.36
\n", + "
" + ], + "text/plain": [ + " symbol name country sector \\\n", + "0 XELB Xcel Brands Inc USA Consumer Cyclical \n", + "1 SGC Superior Group of Companies Inc.. USA Consumer Cyclical \n", + "2 JRSH Jerash holdings (US) Inc USA Consumer Cyclical \n", + "3 PVH PVH Corp USA Consumer Cyclical \n", + "4 RL Ralph Lauren Corp USA Consumer Cyclical \n", + "\n", + " industry market_cap price change_percent volume \\\n", + "0 Apparel Manufacturing 1.696000e+07 0.72 0.0460 2070 \n", + "1 Apparel Manufacturing 2.280000e+08 13.60 0.0049 39502 \n", + "2 Apparel Manufacturing 3.626000e+07 2.95 0.0034 1348 \n", + "3 Apparel Manufacturing 5.740000e+09 102.71 -0.0013 253106 \n", + "4 Apparel Manufacturing 1.051000e+10 169.68 -0.0027 157365 \n", + "\n", + " price_to_earnings \n", + "0 NaN \n", + "1 19.84 \n", + "2 NaN \n", + "3 9.09 \n", + "4 16.36 " + ] + }, + "execution_count": 19, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "industry_results = obb.equity.screener(\n", + " industry=\"apparel_manufacturing\", provider=\"finviz\"\n", + ").to_df()\n", + "display(len(industry_results))\n", + "industry_results.head(5)" + ] + }, + { + "cell_type": "code", + "execution_count": 18, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "297" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamemarket_capsectorindustrybetapricelast_annual_dividendvolumeexchangeexchange_namecountryis_etfactively_tradingisFund
0TIMKEN.BOTimken India Limited2.787793e+11IndustrialsManufacturing - Tools & Accessories0.5753706.252.55827BSEBombay Stock ExchangeINFalseTrueFalse
1TIMKEN.NSTimken India Limited2.787003e+11IndustrialsManufacturing - Tools & Accessories0.5753705.202.5115595NSENational Stock Exchange of IndiaINFalseTrueFalse
2SKFINDIA.BOSKF India Limited2.615542e+11IndustrialsManufacturing - Tools & Accessories0.4625290.55130.01950BSEBombay Stock ExchangeINFalseTrueFalse
3SKFINDIA.NSSKF India Limited2.614405e+11IndustrialsManufacturing - Tools & Accessories0.4625288.25130.062289NSENational Stock Exchange of IndiaINFalseTrueFalse
4PTCIL.NSPTC Industries Limited1.890617e+11IndustrialsManufacturing - Metal Fabrication0.51013092.10NaN2965NSENational Stock Exchange of IndiaINFalseTrueFalse
\n", + "
" + ], + "text/plain": [ + " symbol name market_cap sector \\\n", + "0 TIMKEN.BO Timken India Limited 2.787793e+11 Industrials \n", + "1 TIMKEN.NS Timken India Limited 2.787003e+11 Industrials \n", + "2 SKFINDIA.BO SKF India Limited 2.615542e+11 Industrials \n", + "3 SKFINDIA.NS SKF India Limited 2.614405e+11 Industrials \n", + "4 PTCIL.NS PTC Industries Limited 1.890617e+11 Industrials \n", + "\n", + " industry beta price last_annual_dividend \\\n", + "0 Manufacturing - Tools & Accessories 0.575 3706.25 2.5 \n", + "1 Manufacturing - Tools & Accessories 0.575 3705.20 2.5 \n", + "2 Manufacturing - Tools & Accessories 0.462 5290.55 130.0 \n", + "3 Manufacturing - Tools & Accessories 0.462 5288.25 130.0 \n", + "4 Manufacturing - Metal Fabrication 0.510 13092.10 NaN \n", + "\n", + " volume exchange exchange_name country is_etf \\\n", + "0 5827 BSE Bombay Stock Exchange IN False \n", + "1 115595 NSE National Stock Exchange of India IN False \n", + "2 1950 BSE Bombay Stock Exchange IN False \n", + "3 62289 NSE National Stock Exchange of India IN False \n", + "4 2965 NSE National Stock Exchange of India IN False \n", + "\n", + " actively_trading isFund \n", + "0 True False \n", + "1 True False \n", + "2 True False \n", + "3 True False \n", + "4 True False " + ] + }, + "execution_count": 18, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "industry_results = obb.equity.screener(\n", + " industry=\"manufacturing\", provider=\"fmp\", country=\"IN\"\n", + ").to_df()\n", + "display(len(industry_results))\n", + "industry_results.head(5)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Search by Exchange\n", + "\n", + "Some countries, like America, have multiple exchanges. Narrow the search by combining two or more parameters. The example below finds the companies listed on the American Stock Exchange (AMEX) that are domiciled in China." + ] + }, + { + "cell_type": "code", + "execution_count": 21, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "5" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamemarket_capsectorindustrybetapricelast_annual_dividendvolumeexchangeexchange_namecountryis_etfactively_tradingisFund
0MYNDMynd.ai, Inc.93150152Consumer DefensiveEducation & Training Services0.9391.92005.62810348AMEXAmerican Stock ExchangeCNFalseTrueFalse
1AMBOAmbow Education Holding Ltd.3731855Consumer DefensiveEducation & Training Services0.7331.3065NaN21603AMEXAmerican Stock ExchangeCNFalseTrueFalse
2CPHIChina Pharma Holdings, Inc.3664258HealthcareDrug Manufacturers - Specialty & Generic0.7260.2135NaN77994AMEXAmerican Stock ExchangeCNFalseTrueFalse
3DXFDunxin Financial Holdings Limited3243104Financial ServicesFinancial - Credit Services1.3040.1394NaN187314AMEXAmerican Stock ExchangeCNFalseTrueFalse
4ITPIT Tech Packaging, Inc.2413803Basic MaterialsPaper, Lumber & Forest Products-0.1200.2398NaN3062AMEXAmerican Stock ExchangeCNFalseTrueFalse
\n", + "
" + ], + "text/plain": [ + " symbol name market_cap sector \\\n", + "0 MYND Mynd.ai, Inc. 93150152 Consumer Defensive \n", + "1 AMBO Ambow Education Holding Ltd. 3731855 Consumer Defensive \n", + "2 CPHI China Pharma Holdings, Inc. 3664258 Healthcare \n", + "3 DXF Dunxin Financial Holdings Limited 3243104 Financial Services \n", + "4 ITP IT Tech Packaging, Inc. 2413803 Basic Materials \n", + "\n", + " industry beta price \\\n", + "0 Education & Training Services 0.939 1.9200 \n", + "1 Education & Training Services 0.733 1.3065 \n", + "2 Drug Manufacturers - Specialty & Generic 0.726 0.2135 \n", + "3 Financial - Credit Services 1.304 0.1394 \n", + "4 Paper, Lumber & Forest Products -0.120 0.2398 \n", + "\n", + " last_annual_dividend volume exchange exchange_name country \\\n", + "0 5.628 10348 AMEX American Stock Exchange CN \n", + "1 NaN 21603 AMEX American Stock Exchange CN \n", + "2 NaN 77994 AMEX American Stock Exchange CN \n", + "3 NaN 187314 AMEX American Stock Exchange CN \n", + "4 NaN 3062 AMEX American Stock Exchange CN \n", + "\n", + " is_etf actively_trading isFund \n", + "0 False True False \n", + "1 False True False \n", + "2 False True False \n", + "3 False True False \n", + "4 False True False " + ] + }, + "execution_count": 21, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "exchange_results = obb.equity.screener(\n", + " exchange=\"amex\", country=\"CN\", provider=\"fmp\"\n", + ").to_df()\n", + "display(len(exchange_results))\n", + "exchange_results" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Filter ADRs\n", + "\n", + "Use the Nasdaq screener to get only American Depositary Receipts" + ] + }, + { + "cell_type": "code", + "execution_count": 22, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamelast_pricechangechange_percentmarket_cap
0GDSGDS Holdings Limited ADS16.13501.37500.0931695038491
1YQ17 Education & Technology Group Inc. American ...2.17000.17000.085007207460
2STECSantech Holdings Limited American Depositary S...0.47290.03590.082154125000
3TURBTurbo Energy, S.A. American Depositary Shares1.53420.10430.072941000000
4FRESFresh2 Group Limited American Depositary Shares1.72970.09970.06117644183
.....................
190JFU9F Inc. American Depositary Shares1.8000NaNNaN3584421
191XHGXChange TEC.INC American Depositary Shares0.9500NaNNaN2780673
192JZJianzhi Education Technology Group Company Lim...0.8000NaNNaN1666667
193NWGLNature Wood Group Limited American Depositary ...1.6000NaNNaN1493743
194FORTYFormula Systems (1985) Ltd. American Depositar...76.0550NaNNaN131939
\n", + "

195 rows × 6 columns

\n", + "
" + ], + "text/plain": [ + " symbol name last_price \\\n", + "0 GDS GDS Holdings Limited ADS 16.1350 \n", + "1 YQ 17 Education & Technology Group Inc. American ... 2.1700 \n", + "2 STEC Santech Holdings Limited American Depositary S... 0.4729 \n", + "3 TURB Turbo Energy, S.A. American Depositary Shares 1.5342 \n", + "4 FRES Fresh2 Group Limited American Depositary Shares 1.7297 \n", + ".. ... ... ... \n", + "190 JFU 9F Inc. American Depositary Shares 1.8000 \n", + "191 XHG XChange TEC.INC American Depositary Shares 0.9500 \n", + "192 JZ Jianzhi Education Technology Group Company Lim... 0.8000 \n", + "193 NWGL Nature Wood Group Limited American Depositary ... 1.6000 \n", + "194 FORTY Formula Systems (1985) Ltd. American Depositar... 76.0550 \n", + "\n", + " change change_percent market_cap \n", + "0 1.3750 0.09316 95038491 \n", + "1 0.1700 0.08500 7207460 \n", + "2 0.0359 0.08215 4125000 \n", + "3 0.1043 0.07294 1000000 \n", + "4 0.0997 0.06117 644183 \n", + ".. ... ... ... \n", + "190 NaN NaN 3584421 \n", + "191 NaN NaN 2780673 \n", + "192 NaN NaN 1666667 \n", + "193 NaN NaN 1493743 \n", + "194 NaN NaN 131939 \n", + "\n", + "[195 rows x 6 columns]" + ] + }, + "execution_count": 22, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "obb.equity.screener(exsubcategory=\"adr\", provider=\"nasdaq\").to_df()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Filter by Metric\n", + "\n", + "Applying some filters refines and targets the search. The example below finds listing on the NYSE domiciled in the USA, with a market cap between $100-300 billion, and exhibiting a beta value of less than 0.5" + ] + }, + { + "cell_type": "code", + "execution_count": 13, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamemarket_capsectorindustrybetapricelast_annual_dividendvolumeexchangeexchange_namecountryis_etfactively_tradingisFund
0MRKMerck & Co., Inc.294367485300HealthcareDrug Manufacturers - General0.389000116.1303.080003111763NYSENew York Stock ExchangeUSFalseTrueFalse
1VZVerizon Communications Inc.171053845200Communication ServicesTelecommunications Services0.39300040.6352.660006202285NYSENew York Stock ExchangeUSFalseTrueFalse
2TBCAT&T Inc. 5.625% Global Notes d140078065351Communication ServicesTelecommunications Services0.27570324.5651.4062818782NYSENew York Stock ExchangeUSFalseTrueFalse
3PGRThe Progressive Corporation139775286220Financial ServicesInsurance - Property & Casualty0.356000238.6600.40000616656NYSENew York Stock ExchangeUSFalseTrueFalse
4TBBAT&T Inc. 5.35% GLB NTS 66139658512827Communication ServicesTelecommunications Services0.25385923.3951.3375221852NYSENew York Stock ExchangeUSFalseTrueFalse
5LMTLockheed Martin Corporation132376882460IndustrialsAerospace & Defense0.454000555.37012.60000304130NYSENew York Stock ExchangeUSFalseTrueFalse
\n", + "
" + ], + "text/plain": [ + " symbol name market_cap \\\n", + "0 MRK Merck & Co., Inc. 294367485300 \n", + "1 VZ Verizon Communications Inc. 171053845200 \n", + "2 TBC AT&T Inc. 5.625% Global Notes d 140078065351 \n", + "3 PGR The Progressive Corporation 139775286220 \n", + "4 TBB AT&T Inc. 5.35% GLB NTS 66 139658512827 \n", + "5 LMT Lockheed Martin Corporation 132376882460 \n", + "\n", + " sector industry beta price \\\n", + "0 Healthcare Drug Manufacturers - General 0.389000 116.130 \n", + "1 Communication Services Telecommunications Services 0.393000 40.635 \n", + "2 Communication Services Telecommunications Services 0.275703 24.565 \n", + "3 Financial Services Insurance - Property & Casualty 0.356000 238.660 \n", + "4 Communication Services Telecommunications Services 0.253859 23.395 \n", + "5 Industrials Aerospace & Defense 0.454000 555.370 \n", + "\n", + " last_annual_dividend volume exchange exchange_name country \\\n", + "0 3.08000 3111763 NYSE New York Stock Exchange US \n", + "1 2.66000 6202285 NYSE New York Stock Exchange US \n", + "2 1.40628 18782 NYSE New York Stock Exchange US \n", + "3 0.40000 616656 NYSE New York Stock Exchange US \n", + "4 1.33752 21852 NYSE New York Stock Exchange US \n", + "5 12.60000 304130 NYSE New York Stock Exchange US \n", + "\n", + " is_etf actively_trading isFund \n", + "0 False True False \n", + "1 False True False \n", + "2 False True False \n", + "3 False True False \n", + "4 False True False \n", + "5 False True False " + ] + }, + "execution_count": 13, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "obb.equity.screener(\n", + " exchange=\"nyse\",\n", + " mktcap_min=100000000000,\n", + " mktcap_max=300000000000,\n", + " country=\"us\",\n", + " beta_max=0.5,\n", + " provider=\"fmp\",\n", + ").to_df()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Finviz Screener\n", + "\n", + "The `openbb-finviz` provider extension supports screener presets from V3 SDK and Terminal. See the details here: [https://pypi.org/project/openbb-finviz/](https://pypi.org/project/openbb-finviz/)" + ] + }, + { + "cell_type": "code", + "execution_count": 27, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
symbolnamecountrysectorindustrymarket_cappricechange_percentvolumeprice_to_earnings
0GRFSGrifols SA ADRSpainHealthcareDrug Manufacturers - General2.270000e+098.810.1488505585435.13
1ZMZoom Video Communications IncUSATechnologySoftware - Application2.097000e+1067.810.12581528522824.27
2EVHEvolent Health IncUSAHealthcareHealth Information Services3.680000e+0931.610.12474519171NaN
3GDSGDS Holdings Limited ADRChinaTechnologyInformation Technology Services3.060000e+0916.190.09682308546NaN
4LCIDLucid Group IncUSAConsumer CyclicalAuto Manufacturers9.070000e+093.910.092241571321NaN
5OSISOSI Systems Inc.USATechnologyElectronic Components2.690000e+09157.680.090329975621.68
6ZKZEEKR Intelligent Technology Holding Ltd. ADRChinaConsumer CyclicalAuto Manufacturers4.450000e+0917.990.0677792117NaN
7QXOQXO Inc.USATechnologySoftware - Application5.870000e+0914.340.06144871978NaN
\n", + "
" + ], + "text/plain": [ + " symbol name country \\\n", + "0 GRFS Grifols SA ADR Spain \n", + "1 ZM Zoom Video Communications Inc USA \n", + "2 EVH Evolent Health Inc USA \n", + "3 GDS GDS Holdings Limited ADR China \n", + "4 LCID Lucid Group Inc USA \n", + "5 OSIS OSI Systems Inc. USA \n", + "6 ZK ZEEKR Intelligent Technology Holding Ltd. ADR China \n", + "7 QXO QXO Inc. USA \n", + "\n", + " sector industry market_cap price \\\n", + "0 Healthcare Drug Manufacturers - General 2.270000e+09 8.81 \n", + "1 Technology Software - Application 2.097000e+10 67.81 \n", + "2 Healthcare Health Information Services 3.680000e+09 31.61 \n", + "3 Technology Information Technology Services 3.060000e+09 16.19 \n", + "4 Consumer Cyclical Auto Manufacturers 9.070000e+09 3.91 \n", + "5 Technology Electronic Components 2.690000e+09 157.68 \n", + "6 Consumer Cyclical Auto Manufacturers 4.450000e+09 17.99 \n", + "7 Technology Software - Application 5.870000e+09 14.34 \n", + "\n", + " change_percent volume price_to_earnings \n", + "0 0.1488 5055854 35.13 \n", + "1 0.1258 15285228 24.27 \n", + "2 0.1247 4519171 NaN \n", + "3 0.0968 2308546 NaN \n", + "4 0.0922 41571321 NaN \n", + "5 0.0903 299756 21.68 \n", + "6 0.0677 792117 NaN \n", + "7 0.0614 4871978 NaN " + ] + }, + "execution_count": 27, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "obb.equity.screener(\n", + " metric=\"overview\", signal=\"top_gainers\", provider=\"finviz\", mktcap=\"mid_over\"\n", + ").to_df()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Get Available Indices\n", + "\n", + "List all indices from a source with:" + ] + }, + { + "cell_type": "code", + "execution_count": 28, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "274\n" + ] + }, + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
namecodesymbol
88S&P/ASX 200 Index (AUD)au_asx200^AXJO
90S&P/ASX 200 Energy Sector Index (AUD)au_energy^AXEJ
91S&P/ASX 200 Resources Sector Index (AUD)au_resources^AXJR
92S&P/ASX 200 Materials Sector Index (AUD)au_materials^AXMJ
94S&P/ASX 200 Industrials Sector Index (AUD)au_industrials^AXNJ
95S&P/ASX 200 Consumer Discretionary Sector Inde...au_discretionary^AXDJ
96S&P/ASX 200 Consumer Staples Sector Index (AUD)au_staples^AXSJ
97S&P/ASX 200 Health Care Sector Index (AUD)au_health^AXHJ
98S&P/ASX 200 Financials Sector Index (AUD)au_financials^AXFJ
99S&P/ASX 200 A-REIT Industry Index (AUD)au_reit^AXPJ
100S&P/ASX 200 Info Tech Sector Index (AUD)au_tech^AXIJ
101S&P/ASX 200 Communications Sector Index (AUD)au_communications^AXTJ
102S&P/ASX 200 Utilities Sector Index (AUD)au_utilities^AXUJ
\n", + "
" + ], + "text/plain": [ + " name code \\\n", + "88 S&P/ASX 200 Index (AUD) au_asx200 \n", + "90 S&P/ASX 200 Energy Sector Index (AUD) au_energy \n", + "91 S&P/ASX 200 Resources Sector Index (AUD) au_resources \n", + "92 S&P/ASX 200 Materials Sector Index (AUD) au_materials \n", + "94 S&P/ASX 200 Industrials Sector Index (AUD) au_industrials \n", + "95 S&P/ASX 200 Consumer Discretionary Sector Inde... au_discretionary \n", + "96 S&P/ASX 200 Consumer Staples Sector Index (AUD) au_staples \n", + "97 S&P/ASX 200 Health Care Sector Index (AUD) au_health \n", + "98 S&P/ASX 200 Financials Sector Index (AUD) au_financials \n", + "99 S&P/ASX 200 A-REIT Industry Index (AUD) au_reit \n", + "100 S&P/ASX 200 Info Tech Sector Index (AUD) au_tech \n", + "101 S&P/ASX 200 Communications Sector Index (AUD) au_communications \n", + "102 S&P/ASX 200 Utilities Sector Index (AUD) au_utilities \n", + "\n", + " symbol \n", + "88 ^AXJO \n", + "90 ^AXEJ \n", + "91 ^AXJR \n", + "92 ^AXMJ \n", + "94 ^AXNJ \n", + "95 ^AXDJ \n", + "96 ^AXSJ \n", + "97 ^AXHJ \n", + "98 ^AXFJ \n", + "99 ^AXPJ \n", + "100 ^AXIJ \n", + "101 ^AXTJ \n", + "102 ^AXUJ " + ] + }, + "execution_count": 28, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "indices = obb.index.available(provider=\"yfinance\").to_df()\n", + "print(len(indices))\n", + "\n", + "indices[indices[\"name\"].str.contains(\"ASX 200\")]" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Filter the list down by querying the DataFrame." + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "With the `openbb-yfinance` extension, index time series can be loaded using the ticker symbol or short code. Non-American indices have a code beginning with the two-letter country code." + ] + }, + { + "cell_type": "code", + "execution_count": 29, + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
\n", + "\n", + "\n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + " \n", + "
openhighlowclosevolume
date
2024-08-22TrueTrueTrueTrueTrue
\n", + "
" + ], + "text/plain": [ + " open high low close volume\n", + "date \n", + "2024-08-22 True True True True True" + ] + }, + "execution_count": 29, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "(\n", + " obb.index.price.historical(\"au_utilities\", provider=\"yfinance\").to_df().tail(1)\n", + " == obb.index.price.historical(\"^AXUJ\", provider=\"yfinance\").to_df().tail(1)\n", + ")" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "obb-sdk4", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.12.4" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +}