From 37209c88ea86384b6437aa67b6e4e30d95bf6e9a Mon Sep 17 00:00:00 2001 From: Danglewood <85772166+deeleeramone@users.noreply.github.com> Date: Wed, 28 Feb 2024 10:49:16 -0800 Subject: [PATCH] add more examples into findSymbols (#6139) Co-authored-by: James Maslek --- examples/findSymbols.ipynb | 1585 +++++++++++++---- .../content/platform/usage/find_symbols.md | 81 +- 2 files changed, 1289 insertions(+), 377 deletions(-) diff --git a/examples/findSymbols.ipynb b/examples/findSymbols.ipynb index 1a4eeb196fd..b79ce6eee4b 100644 --- a/examples/findSymbols.ipynb +++ b/examples/findSymbols.ipynb @@ -27,15 +27,9 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "The simplest way to find tickers for a company is with a simple fuzzy query.\n", + "The simplest way to find tickers is with a basic text query.\n", "\n", - "## Search the SEC\n", - "\n", - "Perform a quick search using the `openbb-sec` provider.\n", - "\n", - "### Find a Company\n", - "\n", - "Use an empty string, `\"\"`, to return the complete list - over 10,000." + "## Search Nasdaq" ] }, { @@ -45,8 +39,104 @@ "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_tradedexchangemarket_categoryetfround_lot_sizetest_issuefinancial_statuscqs_symbolnasdaq_symbolnext_shares
0AMJJPMorgan Chase Capital XVI JP Morgan Alerian M...YPNoneN100.0NNoneAMJAMJN
1AMJBJPMorgan Chase & Co. Alerian MLP Index ETNs du...YPNoneY100.0NNoneAMJBAMJBN
2BBAGJPMorgan BetaBuilders U.S. Aggregate Bond ETFYPNoneY100.0NNoneBBAGBBAGN
\n", + "
" + ], "text/plain": [ - "10840" + " symbol name nasdaq_traded \\\n", + "0 AMJ JPMorgan Chase Capital XVI JP Morgan Alerian M... Y \n", + "1 AMJB JPMorgan Chase & Co. Alerian MLP Index ETNs du... Y \n", + "2 BBAG JPMorgan BetaBuilders U.S. Aggregate Bond ETF Y \n", + "\n", + " exchange market_category etf round_lot_size test_issue financial_status \\\n", + "0 P None N 100.0 N None \n", + "1 P None Y 100.0 N None \n", + "2 P None Y 100.0 N None \n", + "\n", + " cqs_symbol nasdaq_symbol next_shares \n", + "0 AMJ AMJ N \n", + "1 AMJB AMJB N \n", + "2 BBAG BBAG N " ] }, "execution_count": 2, @@ -55,16 +145,14 @@ } ], "source": [ - "all_companies = obb.equity.search(\"\", provider=\"sec\")\n", - "\n", - "len(all_companies.results)\n" + "obb.equity.search(\"JPMorgan\", provider=\"nasdaq\").to_df().head(3)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ - "The SEC sorts this list by market cap. Applying the `to_df()` method to `all_companies` will show Apple on top" + "## Search Cboe" ] }, { @@ -72,6 +160,571 @@ "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", + "
symbolnamedescriptiondata_delaycurrencytime_zoneopen_timeclose_timetick_daystick_frequencytick_period
32SPXVIVPROSHARES S&P 500 EX-HEALTH CARE ETFPROSHARES S&P 500 EX-HEALTH CARE ETF15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegular
33VIX1DCboe 1-Day Volatility Index®Estimates expected volatility by aggregating t...15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegular
34VIX3MCboe S&P 500 3 Month Volatility IndexThe Cboe 3-Month Volatility Index (VIX3M) is d...15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegular
35WPUTCboe S&P 500 One-Week PutWrite IndexTracks the value of a portfolio that overlays ...15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegular
36XSPAMMini SPX Index (AM Settlement)Mini SPX Index (AM Settlement)15USDAmerica/Chicago08:00:0016:00:00MonToFriCRegular
\n", + "
" + ], + "text/plain": [ + " symbol name \\\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", + "36 XSPAM Mini SPX Index (AM Settlement) \n", + "\n", + " description data_delay currency \\\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", + "36 Mini SPX Index (AM Settlement) 15 USD \n", + "\n", + " time_zone open_time close_time tick_days tick_frequency tick_period \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", + "36 America/Chicago 08:00:00 16:00:00 MonToFri C Regular " + ] + }, + "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": 4, + "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...avg_volumeavg_volume_30daumpe_ratiopb_ratiomanagement_feemerdistribution_yielddividend_frequencybeta_20y
17VALT.BCI Gold Bullion FundVALT.B:CA2021-03-17CI Global Asset ManagementGoldFalseCAD27.2327.31...430142814976500.0NaNNaN0.00155NaN0.015347AnnuallyNaN
18VALT.UCI Gold Bullion FundCI Gold Bullion2021-01-06CI Global Asset ManagementGoldFalseUSD20.2520.22...690474728147500.0NaNNaN0.00155NaN0.016145AnnuallyNaN
19XGDiShares S&P/TSX Global Gold Index ETFiShares S&P/TSX2001-03-23RBC iSharesMid Cap GrowthFalseCAD15.1515.15...4563991194453986265000.026.44361.90900.006100.00610.016213Semi-Annually0.560996
20ZGDBMO Equal Weight Global Gold Index ETFBMO Equal Weight2012-11-14BMO ETFMid Cap BlendFalseCAD65.3063.90...436341741396935.017.22851.38910.005500.00620.008305AnnuallyNaN
21ZJGBMO Junior Gold Index ETFBMO Junior Gold2010-01-19BMO ETFSmall Cap BlendTrueCAD57.9058.10...511149152271541.026.82831.53100.005500.00610.009537AnnuallyNaN
\n", + "

5 rows × 35 columns

\n", + "
" + ], + "text/plain": [ + " symbol name short_name \\\n", + "17 VALT.B CI Gold Bullion Fund VALT.B:CA \n", + "18 VALT.U CI Gold Bullion Fund CI Gold Bullion \n", + "19 XGD iShares S&P/TSX Global Gold Index ETF iShares S&P/TSX \n", + "20 ZGD BMO Equal Weight Global Gold Index ETF BMO Equal Weight \n", + "21 ZJG BMO Junior Gold Index ETF BMO Junior Gold \n", + "\n", + " inception_date issuer investment_style esg \\\n", + "17 2021-03-17 CI Global Asset Management Gold False \n", + "18 2021-01-06 CI Global Asset Management Gold False \n", + "19 2001-03-23 RBC iShares Mid Cap Growth False \n", + "20 2012-11-14 BMO ETF Mid Cap Blend False \n", + "21 2010-01-19 BMO ETF Small Cap Blend True \n", + "\n", + " currency unit_price close ... avg_volume avg_volume_30d aum \\\n", + "17 CAD 27.23 27.31 ... 430 1428 14976500.0 \n", + "18 USD 20.25 20.22 ... 690 4747 28147500.0 \n", + "19 CAD 15.15 15.15 ... 456399 1194453 986265000.0 \n", + "20 CAD 65.30 63.90 ... 436 3417 41396935.0 \n", + "21 CAD 57.90 58.10 ... 511 1491 52271541.0 \n", + "\n", + " pe_ratio pb_ratio management_fee mer distribution_yield \\\n", + "17 NaN NaN 0.00155 NaN 0.015347 \n", + "18 NaN NaN 0.00155 NaN 0.016145 \n", + "19 26.4436 1.9090 0.00610 0.0061 0.016213 \n", + "20 17.2285 1.3891 0.00550 0.0062 0.008305 \n", + "21 26.8283 1.5310 0.00550 0.0061 0.009537 \n", + "\n", + " dividend_frequency beta_20y \n", + "17 Annually NaN \n", + "18 Annually NaN \n", + "19 Semi-Annually 0.560996 \n", + "20 Annually NaN \n", + "21 Annually NaN \n", + "\n", + "[5 rows x 35 columns]" + ] + }, + "execution_count": 4, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "obb.etf.search(\"gold\", provider=\"tmx\").to_df().iloc[-5:]" + ] + }, + { + "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", + "
symbolnamemarket_capsectorindustrybetapricelast_annual_dividendvolumeexchangeexchange_namecountryactively_tradingisFund
0QYLDGlobal X NASDAQ 100 Covered Call ETF7.851962e+09None0.6517.82002.061711216103.0NASDAQNASDAQ Global MarketUSTrueFalse
1XYLDGlobal X S&P 500 Covered Call ETF2.750881e+09None0.5340.09983.9424864645.0AMEXNew York Stock Exchange ArcaUSTrueFalse
2ZWU.TOBMO Covered Call Utilities ETF1.698515e+09None0.6710.03000.8600056572.0TSXToronto Stock ExchangeCATrueFalse
3ZWC.TOBMO CA High Dividend Covered Call ETF1.602642e+09None0.8917.02001.1900017235.0TSXToronto Stock ExchangeCATrueFalse
4RYLDGlobal X Russell 2000 Covered Call ETF1.406859e+09MiscellaneousInvestment Trusts/Mutual Funds0.5616.49001.87702133691.0AMEXNew York Stock Exchange ArcaUSTrueFalse
\n", + "
" + ], + "text/plain": [ + " symbol name market_cap \\\n", + "0 QYLD Global X NASDAQ 100 Covered Call ETF 7.851962e+09 \n", + "1 XYLD Global X S&P 500 Covered Call ETF 2.750881e+09 \n", + "2 ZWU.TO BMO Covered Call Utilities ETF 1.698515e+09 \n", + "3 ZWC.TO BMO CA High Dividend Covered Call ETF 1.602642e+09 \n", + "4 RYLD Global X Russell 2000 Covered Call ETF 1.406859e+09 \n", + "\n", + " sector industry beta price \\\n", + "0 None 0.65 17.8200 \n", + "1 None 0.53 40.0998 \n", + "2 None 0.67 10.0300 \n", + "3 None 0.89 17.0200 \n", + "4 Miscellaneous Investment Trusts/Mutual Funds 0.56 16.4900 \n", + "\n", + " last_annual_dividend volume exchange exchange_name \\\n", + "0 2.06171 1216103.0 NASDAQ NASDAQ Global Market \n", + "1 3.94248 64645.0 AMEX New York Stock Exchange Arca \n", + "2 0.86000 56572.0 TSX Toronto Stock Exchange \n", + "3 1.19000 17235.0 TSX Toronto Stock Exchange \n", + "4 1.87702 133691.0 AMEX New York Stock Exchange Arca \n", + "\n", + " country actively_trading isFund \n", + "0 US True False \n", + "1 US True False \n", + "2 CA True False \n", + "3 CA True False \n", + "4 US True False " + ] + }, + "execution_count": 5, + "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": [ @@ -101,17 +754,17 @@ " \n", " \n", " 0\n", - " AAPL\n", - " Apple Inc.\n", - " 320193\n", - " \n", - " \n", - " 1\n", " MSFT\n", " MICROSOFT CORP\n", " 789019\n", " \n", " \n", + " 1\n", + " AAPL\n", + " Apple Inc.\n", + " 320193\n", + " \n", + " \n", " 2\n", " GOOGL\n", " Alphabet Inc.\n", @@ -119,17 +772,17 @@ " \n", " \n", " 3\n", - " AMZN\n", - " AMAZON COM INC\n", - " 1018724\n", - " \n", - " \n", - " 4\n", " NVDA\n", " NVIDIA CORP\n", " 1045810\n", " \n", " \n", + " 4\n", + " AMZN\n", + " AMAZON COM INC\n", + " 1018724\n", + " \n", + " \n", " 5\n", " META\n", " Meta Platforms, Inc.\n", @@ -143,47 +796,51 @@ " \n", " \n", " 7\n", - " TSLA\n", - " Tesla, Inc.\n", - " 1318605\n", - " \n", - " \n", - " 8\n", " LLY\n", " ELI LILLY & Co\n", " 59478\n", " \n", " \n", + " 8\n", + " TSM\n", + " TAIWAN SEMICONDUCTOR MANUFACTURING CO LTD\n", + " 1046179\n", + " \n", + " \n", " 9\n", - " V\n", - " VISA INC.\n", - " 1403161\n", + " AVGO\n", + " Broadcom Inc.\n", + " 1730168\n", " \n", " \n", "\n", "" ], "text/plain": [ - " symbol name cik\n", - "0 AAPL Apple Inc. 320193\n", - "1 MSFT MICROSOFT CORP 789019\n", - "2 GOOGL Alphabet Inc. 1652044\n", - "3 AMZN AMAZON COM INC 1018724\n", - "4 NVDA NVIDIA CORP 1045810\n", - "5 META Meta Platforms, Inc. 1326801\n", - "6 BRK-B BERKSHIRE HATHAWAY INC 1067983\n", - "7 TSLA Tesla, Inc. 1318605\n", - "8 LLY ELI LILLY & Co 59478\n", - "9 V VISA INC. 1403161" + " 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": 3, + "execution_count": 8, "metadata": {}, "output_type": "execute_result" } ], "source": [ - "all_companies.to_df().head(10)\n" + "all_companies = obb.equity.search(\"\", provider=\"sec\")\n", + "\n", + "print(len(all_companies.results))\n", + "\n", + "all_companies.to_df().head(10)" ] }, { @@ -197,7 +854,7 @@ }, { "cell_type": "code", - "execution_count": 4, + "execution_count": 9, "metadata": {}, "outputs": [ { @@ -282,14 +939,14 @@ "7 LMZ & BERKSHIRE HATHAWAY CO 0001652795" ] }, - "execution_count": 4, + "execution_count": 9, "metadata": {}, "output_type": "execute_result" } ], "source": [ "instututions = obb.regulators.sec.institutions_search(\"Berkshire Hathaway\").to_df()\n", - "instututions\n" + "instututions" ] }, { @@ -303,32 +960,33 @@ }, { "cell_type": "code", - "execution_count": 11, + "execution_count": 10, "metadata": {}, "outputs": [ { "data": { "text/plain": [ - "type 13F-NT\n", - "link https://www.sec.gov/Archives/edgar/data/000082...\n", - "report_date 2023-09-30\n", - "accepted_date 2023-11-14 16:15:06+00:00\n", - "act 34\n", + "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 \n", - "primary_doc xslForm13F_X02/primary_doc.xml\n", - "accession_number 0000950123-23-010929\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 231406391\n", + "film_number 03565329\n", "is_inline_xbrl 0\n", "is_xbrl 0\n", - "size 2960\n", + "size 4246\n", "complete_submission_url https://www.sec.gov/Archives/edgar/data/000082...\n", - "filing_detail_url https://www.sec.gov/Archives/edgar/data/000082...\n", - "Name: 2023-11-14 00:00:00, dtype: object" + "Name: 84, dtype: object" ] }, - "execution_count": 11, + "execution_count": 10, "metadata": {}, "output_type": "execute_result" } @@ -348,32 +1006,33 @@ }, { "cell_type": "code", - "execution_count": 13, + "execution_count": 12, "metadata": {}, "outputs": [ { "data": { "text/plain": [ - "type 4\n", - "link https://www.sec.gov/Archives/edgar/data/000032...\n", - "report_date 2023-11-10\n", - "accepted_date 2023-11-14 18:31:09+00:00\n", - "act \n", + "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 FORM 4\n", - "primary_doc xslF345X05/wk-form4_1700004649.xml\n", - "accession_number 0000320193-23-000109\n", - "file_number \n", - "film_number \n", - "is_inline_xbrl 0\n", - "is_xbrl 0\n", - "size 5066\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", - "filing_detail_url https://www.sec.gov/Archives/edgar/data/000032...\n", - "Name: 2023-11-14 00:00:00, dtype: object" + "Name: 0, dtype: object" ] }, - "execution_count": 13, + "execution_count": 12, "metadata": {}, "output_type": "execute_result" } @@ -381,7 +1040,7 @@ "source": [ "aapl_filings = obb.equity.fundamental.filings(\"AAPL\", type=\"4\", provider=\"sec\")\n", "\n", - "aapl_filings.to_df().iloc[-1]\n" + "aapl_filings.to_df().iloc[0]\n" ] }, { @@ -397,13 +1056,13 @@ }, { "cell_type": "code", - "execution_count": 16, + "execution_count": 13, "metadata": {}, "outputs": [ { "data": { "text/plain": [ - "1822" + "5673" ] }, "metadata": {}, @@ -444,6 +1103,7 @@ " country\n", " is_etf\n", " actively_trading\n", + " isFund\n", " \n", " \n", " \n", @@ -451,122 +1111,127 @@ " 0\n", " RELIANCE.NS\n", " Reliance Industries Limited\n", - " 15895961017165\n", + " 20104143261030\n", " Energy\n", " Oil & Gas Refining & Marketing\n", - " 0.721409\n", - " 2349.35\n", + " 0.608\n", + " 2971.3\n", " 9\n", - " 2244671\n", + " 5412782\n", " NSE\n", " National Stock Exchange of India\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 1\n", - " TCS.NS\n", - " Tata Consultancy Services Limited\n", - " 12878392323686\n", - " Technology\n", - " Information Technology Services\n", - " 0.528\n", - " 3519.6\n", - " 36\n", - " 1473232\n", - " NSE\n", - " National Stock Exchange of India\n", + " RELIANCE.BO\n", + " Reliance Industries Limited\n", + " 20098053761843\n", + " Energy\n", + " Oil & Gas Refining & Marketing\n", + " 0.608\n", + " 2970.4\n", + " 9\n", + " 83211\n", + " BSE\n", + " Bombay Stock Exchange\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 2\n", - " HDFCBANK.NS\n", - " HDFC Bank Limited\n", - " 11345550050918\n", - " Financial Services\n", - " Banks—Regional\n", - " 0.714285\n", - " 1505.2\n", - " 19\n", - " 9665132\n", + " TCS.NS\n", + " Tata Consultancy Services Limited\n", + " 14850088530330\n", + " Technology\n", + " Information Technology Services\n", + " 0.531\n", + " 4104.4\n", + " 51\n", + " 2960088\n", " NSE\n", " National Stock Exchange of India\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 3\n", - " ICICIBANK.NS\n", - " ICICI Bank Limited\n", - " 6456176076595\n", - " Financial Services\n", - " Banks—Regional\n", - " 0.808\n", - " 921.45\n", - " 8\n", - " 10561389\n", - " NSE\n", - " National Stock Exchange of India\n", + " TCS.BO\n", + " Tata Consultancy Services Limited\n", + " 14844299652000\n", + " Technology\n", + " Information Technology Services\n", + " 0.531\n", + " 4102.8\n", + " 51\n", + " 334830\n", + " BSE\n", + " Bombay Stock Exchange\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 4\n", - " INFY.NS\n", - " Infosys Limited\n", - " 5945857635942\n", - " Technology\n", - " Information Technology Services\n", - " 0.596\n", - " 1436.6\n", - " 36\n", - " 3584088\n", - " NSE\n", - " National Stock Exchange of India\n", + " HDFCBANK.BO\n", + " HDFC Bank Limited\n", + " 10790199234483\n", + " Financial Services\n", + " Banks - Regional\n", + " 0.79\n", + " 1420.55\n", + " 19\n", + " 216503\n", + " BSE\n", + " Bombay Stock Exchange\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", "\n", "" ], "text/plain": [ - " symbol name market_cap \\\n", - "0 RELIANCE.NS Reliance Industries Limited 15895961017165 \n", - "1 TCS.NS Tata Consultancy Services Limited 12878392323686 \n", - "2 HDFCBANK.NS HDFC Bank Limited 11345550050918 \n", - "3 ICICIBANK.NS ICICI Bank Limited 6456176076595 \n", - "4 INFY.NS Infosys Limited 5945857635942 \n", + " symbol name market_cap \\\n", + "0 RELIANCE.NS Reliance Industries Limited 20104143261030 \n", + "1 RELIANCE.BO Reliance Industries Limited 20098053761843 \n", + "2 TCS.NS Tata Consultancy Services Limited 14850088530330 \n", + "3 TCS.BO Tata Consultancy Services Limited 14844299652000 \n", + "4 HDFCBANK.BO HDFC Bank Limited 10790199234483 \n", "\n", - " sector industry beta price \\\n", - "0 Energy Oil & Gas Refining & Marketing 0.721409 2349.35 \n", - "1 Technology Information Technology Services 0.528 3519.6 \n", - "2 Financial Services Banks—Regional 0.714285 1505.2 \n", - "3 Financial Services Banks—Regional 0.808 921.45 \n", - "4 Technology Information Technology Services 0.596 1436.6 \n", + " sector industry beta price \\\n", + "0 Energy Oil & Gas Refining & Marketing 0.608 2971.3 \n", + "1 Energy Oil & Gas Refining & Marketing 0.608 2970.4 \n", + "2 Technology Information Technology Services 0.531 4104.4 \n", + "3 Technology Information Technology Services 0.531 4102.8 \n", + "4 Financial Services Banks - Regional 0.79 1420.55 \n", "\n", - " last_annual_dividend volume exchange exchange_name \\\n", - "0 9 2244671 NSE National Stock Exchange of India \n", - "1 36 1473232 NSE National Stock Exchange of India \n", - "2 19 9665132 NSE National Stock Exchange of India \n", - "3 8 10561389 NSE National Stock Exchange of India \n", - "4 36 3584088 NSE National Stock Exchange of India \n", + " last_annual_dividend volume exchange exchange_name \\\n", + "0 9 5412782 NSE National Stock Exchange of India \n", + "1 9 83211 BSE Bombay Stock Exchange \n", + "2 51 2960088 NSE National Stock Exchange of India \n", + "3 51 334830 BSE Bombay Stock Exchange \n", + "4 19 216503 BSE Bombay Stock Exchange \n", "\n", - " country is_etf actively_trading \n", - "0 IN False True \n", - "1 IN False True \n", - "2 IN False True \n", - "3 IN False True \n", - "4 IN False True " + " 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": 16, + "execution_count": 13, "metadata": {}, "output_type": "execute_result" } @@ -586,13 +1251,13 @@ }, { "cell_type": "code", - "execution_count": 17, + "execution_count": 14, "metadata": {}, "outputs": [ { "data": { "text/plain": [ - "190" + "376" ] }, "metadata": {}, @@ -633,129 +1298,135 @@ " country\n", " is_etf\n", " actively_trading\n", + " isFund\n", " \n", " \n", " \n", " \n", " 0\n", - " HDFCBANK.NS\n", + " HDFCBANK.BO\n", " HDFC Bank Limited\n", - " 11345550050918\n", + " 10790199234483\n", " Financial Services\n", - " Banks—Regional\n", - " 0.714285\n", - " 1505.2\n", + " Banks - Regional\n", + " 0.79\n", + " 1420.55\n", " 19.0\n", - " 9665132\n", - " NSE\n", - " National Stock Exchange of India\n", + " 216503\n", + " BSE\n", + " Bombay Stock Exchange\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 1\n", - " ICICIBANK.NS\n", - " ICICI Bank Limited\n", - " 6456176076595\n", + " HDFCBANK.NS\n", + " HDFC Bank Limited\n", + " 10704479740109\n", " Financial Services\n", " Banks—Regional\n", - " 0.808\n", - " 921.45\n", - " 8.0\n", - " 10561389\n", + " 0.714285\n", + " 1420.15\n", + " 19.0\n", + " 16040740\n", " NSE\n", " National Stock Exchange of India\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 2\n", - " SBIN.NS\n", - " State Bank of India\n", - " 5031248625920\n", + " ICICIBANK.BO\n", + " ICICI Bank Limited\n", + " 7441727264794\n", " Financial Services\n", " Banks—Regional\n", - " 0.74\n", - " 563.75\n", - " 11.3\n", - " 12710950\n", - " NSE\n", - " National Stock Exchange of India\n", + " 0.825\n", + " 1060.35\n", + " 8.0\n", + " 178844\n", + " BSE\n", + " Bombay Stock Exchange\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 3\n", - " BAJFINANCE.NS\n", - " Bajaj Finance Limited\n", - " 4282998873754\n", + " ICICIBANK.NS\n", + " ICICI Bank Limited\n", + " 7440674537779\n", " Financial Services\n", - " Credit Services\n", - " 0.947\n", - " 7068.6\n", - " 30.0\n", - " 1901753\n", + " Banks—Regional\n", + " 0.825\n", + " 1060.2\n", + " 8.0\n", + " 10580709\n", " NSE\n", " National Stock Exchange of India\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 4\n", - " LICI.NS\n", - " Life Insurance Corporation of India\n", - " 3870900117504\n", + " SBIN.NS\n", + " State Bank of India\n", + " 6692118460570\n", " Financial Services\n", - " Insurance—Life\n", - " <NA>\n", - " 612.0\n", - " 3.0\n", - " 500820\n", + " Banks—Regional\n", + " 0.781\n", + " 749.85\n", + " 11.3\n", + " 13966117\n", " NSE\n", " National Stock Exchange of India\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", "\n", "" ], "text/plain": [ - " symbol name market_cap \\\n", - "0 HDFCBANK.NS HDFC Bank Limited 11345550050918 \n", - "1 ICICIBANK.NS ICICI Bank Limited 6456176076595 \n", - "2 SBIN.NS State Bank of India 5031248625920 \n", - "3 BAJFINANCE.NS Bajaj Finance Limited 4282998873754 \n", - "4 LICI.NS Life Insurance Corporation of India 3870900117504 \n", + " symbol name market_cap sector \\\n", + "0 HDFCBANK.BO HDFC Bank Limited 10790199234483 Financial Services \n", + "1 HDFCBANK.NS HDFC Bank Limited 10704479740109 Financial Services \n", + "2 ICICIBANK.BO ICICI Bank Limited 7441727264794 Financial Services \n", + "3 ICICIBANK.NS ICICI Bank Limited 7440674537779 Financial Services \n", + "4 SBIN.NS State Bank of India 6692118460570 Financial Services \n", "\n", - " sector industry beta price \\\n", - "0 Financial Services Banks—Regional 0.714285 1505.2 \n", - "1 Financial Services Banks—Regional 0.808 921.45 \n", - "2 Financial Services Banks—Regional 0.74 563.75 \n", - "3 Financial Services Credit Services 0.947 7068.6 \n", - "4 Financial Services Insurance—Life 612.0 \n", + " industry beta price last_annual_dividend volume \\\n", + "0 Banks - Regional 0.79 1420.55 19.0 216503 \n", + "1 Banks—Regional 0.714285 1420.15 19.0 16040740 \n", + "2 Banks—Regional 0.825 1060.35 8.0 178844 \n", + "3 Banks—Regional 0.825 1060.2 8.0 10580709 \n", + "4 Banks—Regional 0.781 749.85 11.3 13966117 \n", "\n", - " last_annual_dividend volume exchange exchange_name \\\n", - "0 19.0 9665132 NSE National Stock Exchange of India \n", - "1 8.0 10561389 NSE National Stock Exchange of India \n", - "2 11.3 12710950 NSE National Stock Exchange of India \n", - "3 30.0 1901753 NSE National Stock Exchange of India \n", - "4 3.0 500820 NSE National Stock Exchange of India \n", + " exchange exchange_name country is_etf \\\n", + "0 BSE Bombay Stock Exchange IN False \n", + "1 NSE National Stock Exchange of India IN False \n", + "2 BSE Bombay Stock Exchange IN False \n", + "3 NSE National Stock Exchange of India IN False \n", + "4 NSE National Stock Exchange of India IN False \n", "\n", - " country is_etf actively_trading \n", - "0 IN False True \n", - "1 IN False True \n", - "2 IN False True \n", - "3 IN False True \n", - "4 IN False True " + " 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": 17, + "execution_count": 14, "metadata": {}, "output_type": "execute_result" } @@ -775,13 +1446,13 @@ }, { "cell_type": "code", - "execution_count": 20, + "execution_count": 15, "metadata": {}, "outputs": [ { "data": { "text/plain": [ - "119" + "344" ] }, "metadata": {}, @@ -822,6 +1493,7 @@ " country\n", " is_etf\n", " actively_trading\n", + " isFund\n", " \n", " \n", " \n", @@ -829,122 +1501,127 @@ " 0\n", " PAGEIND.NS\n", " Page Industries Limited\n", - " 418555116755\n", + " 3.979243e+11\n", " Consumer Cyclical\n", " Apparel Manufacturing\n", - " 0.462\n", - " 37525.45\n", - " 300.0\n", - " 11199\n", + " 0.517\n", + " 35675.80\n", + " 400.0\n", + " 19671\n", " NSE\n", " National Stock Exchange of India\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 1\n", - " KPRMILL.NS\n", - " K.P.R. Mill Limited\n", - " 284132900800\n", + " PAGEIND.BO\n", + " Page Industries Limited\n", + " 3.969506e+11\n", " Consumer Cyclical\n", " Apparel Manufacturing\n", - " 0.689\n", - " 831.25\n", - " 4.15\n", - " 342210\n", - " NSE\n", - " National Stock Exchange of India\n", + " 0.517\n", + " 35588.50\n", + " 400.0\n", + " 1161\n", + " BSE\n", + " Bombay Stock Exchange\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 2\n", - " ABFRL.NS\n", - " Aditya Birla Fashion and Retail Limited\n", - " 203500974285\n", + " KPRMILL.NS\n", + " K.P.R. Mill Limited\n", + " 2.616415e+11\n", " Consumer Cyclical\n", " Apparel Manufacturing\n", - " 0.152\n", - " 214.4\n", - " <NA>\n", - " 1363689\n", + " 0.751\n", + " 765.45\n", + " 4.5\n", + " 829576\n", " NSE\n", " National Stock Exchange of India\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 3\n", - " TRIDENT.NS\n", - " Trident Limited\n", - " 189060118374\n", + " KPRMILL.BO\n", + " K.P.R. Mill Limited\n", + " 2.615561e+11\n", " Consumer Cyclical\n", " Textile Manufacturing\n", - " 0.532\n", - " 37.1\n", - " 0.36\n", - " 7863777\n", - " NSE\n", - " National Stock Exchange of India\n", + " 0.751\n", + " 765.20\n", + " 4.5\n", + " 9053\n", + " BSE\n", + " Bombay Stock Exchange\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 4\n", - " WELSPUNIND.NS\n", - " Welspun India Limited\n", - " 157481652339\n", + " MANYAVAR.BO\n", + " Vedant Fashions Limited\n", + " 2.406450e+11\n", " Consumer Cyclical\n", - " Textile Manufacturing\n", - " 0.423\n", - " 162.05\n", - " 0.1\n", - " 3348644\n", - " NSE\n", - " National Stock Exchange of India\n", + " Apparel Manufacturing\n", + " -0.348\n", + " 990.90\n", + " 9.0\n", + " 4248\n", + " BSE\n", + " Bombay Stock Exchange\n", " IN\n", " False\n", " True\n", + " False\n", " \n", " \n", "\n", "" ], "text/plain": [ - " symbol name market_cap \\\n", - "0 PAGEIND.NS Page Industries Limited 418555116755 \n", - "1 KPRMILL.NS K.P.R. Mill Limited 284132900800 \n", - "2 ABFRL.NS Aditya Birla Fashion and Retail Limited 203500974285 \n", - "3 TRIDENT.NS Trident Limited 189060118374 \n", - "4 WELSPUNIND.NS Welspun India Limited 157481652339 \n", + " symbol name market_cap sector \\\n", + "0 PAGEIND.NS Page Industries Limited 3.979243e+11 Consumer Cyclical \n", + "1 PAGEIND.BO Page Industries Limited 3.969506e+11 Consumer Cyclical \n", + "2 KPRMILL.NS K.P.R. Mill Limited 2.616415e+11 Consumer Cyclical \n", + "3 KPRMILL.BO K.P.R. Mill Limited 2.615561e+11 Consumer Cyclical \n", + "4 MANYAVAR.BO Vedant Fashions Limited 2.406450e+11 Consumer Cyclical \n", "\n", - " sector industry beta price \\\n", - "0 Consumer Cyclical Apparel Manufacturing 0.462 37525.45 \n", - "1 Consumer Cyclical Apparel Manufacturing 0.689 831.25 \n", - "2 Consumer Cyclical Apparel Manufacturing 0.152 214.4 \n", - "3 Consumer Cyclical Textile Manufacturing 0.532 37.1 \n", - "4 Consumer Cyclical Textile Manufacturing 0.423 162.05 \n", + " industry beta price last_annual_dividend volume \\\n", + "0 Apparel Manufacturing 0.517 35675.80 400.0 19671 \n", + "1 Apparel Manufacturing 0.517 35588.50 400.0 1161 \n", + "2 Apparel Manufacturing 0.751 765.45 4.5 829576 \n", + "3 Textile Manufacturing 0.751 765.20 4.5 9053 \n", + "4 Apparel Manufacturing -0.348 990.90 9.0 4248 \n", "\n", - " last_annual_dividend volume exchange exchange_name \\\n", - "0 300.0 11199 NSE National Stock Exchange of India \n", - "1 4.15 342210 NSE National Stock Exchange of India \n", - "2 1363689 NSE National Stock Exchange of India \n", - "3 0.36 7863777 NSE National Stock Exchange of India \n", - "4 0.1 3348644 NSE National Stock Exchange of India \n", + " exchange exchange_name country is_etf \\\n", + "0 NSE National Stock Exchange of India IN False \n", + "1 BSE Bombay Stock Exchange IN False \n", + "2 NSE National Stock Exchange of India IN False \n", + "3 BSE Bombay Stock Exchange IN False \n", + "4 BSE Bombay Stock Exchange IN False \n", "\n", - " country is_etf actively_trading \n", - "0 IN False True \n", - "1 IN False True \n", - "2 IN False True \n", - "3 IN False True \n", - "4 IN False True " + " 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": 20, + "execution_count": 15, "metadata": {}, "output_type": "execute_result" } @@ -952,7 +1629,7 @@ "source": [ "industry_results = obb.equity.screener(country=\"IN\", industry=\"manufacturing\").to_df()\n", "display(len(industry_results))\n", - "industry_results.head(5).convert_dtypes()\n" + "industry_results.head(5)" ] }, { @@ -966,7 +1643,7 @@ }, { "cell_type": "code", - "execution_count": 22, + "execution_count": 16, "metadata": {}, "outputs": [ { @@ -1012,6 +1689,7 @@ " country\n", " is_etf\n", " actively_trading\n", + " isFund\n", " \n", " \n", " \n", @@ -1019,65 +1697,69 @@ " 0\n", " AMBO\n", " Ambow Education Holding Ltd.\n", - " 4314134\n", + " 63818550\n", " Consumer Defensive\n", " Education & Training Services\n", - " 0.448\n", - " 0.1521\n", - " 54634\n", + " 0.559\n", + " 2.2500\n", + " 27302\n", " AMEX\n", " American Stock Exchange\n", " CN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 1\n", - " ITP\n", - " IT Tech Packaging, Inc.\n", - " 2922131\n", - " Basic Materials\n", - " Paper & Paper Products\n", - " -0.1\n", - " 0.2903\n", - " 17827\n", + " CPHI\n", + " China Pharma Holdings, Inc.\n", + " 4107363\n", + " Healthcare\n", + " Drug Manufacturers—Specialty & Generic\n", + " 0.970\n", + " 0.0774\n", + " 848792\n", " AMEX\n", " American Stock Exchange\n", " CN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 2\n", - " DXF\n", - " Dunxin Financial Holdings Limited\n", - " 1232011\n", - " Financial Services\n", - " Credit Services\n", - " 1.632\n", - " 0.31\n", - " 259614\n", + " ITP\n", + " IT Tech Packaging, Inc.\n", + " 3104324\n", + " Basic Materials\n", + " Paper & Paper Products\n", + " -0.224\n", + " 0.3084\n", + " 6467\n", " AMEX\n", " American Stock Exchange\n", " CN\n", " False\n", " True\n", + " False\n", " \n", " \n", " 3\n", - " CPHI\n", - " China Pharma Holdings, Inc.\n", - " 1084973\n", - " Healthcare\n", - " Drug Manufacturers—Specialty & Generic\n", - " 0.875\n", - " 0.0949\n", - " 483393\n", + " DXF\n", + " Dunxin Financial Holdings Limited\n", + " 1375084\n", + " Financial Services\n", + " Credit Services\n", + " 1.154\n", + " 0.3460\n", + " 39167\n", " AMEX\n", " American Stock Exchange\n", " CN\n", " False\n", " True\n", + " False\n", " \n", " \n", "\n", @@ -1085,25 +1767,25 @@ ], "text/plain": [ " symbol name market_cap sector \\\n", - "0 AMBO Ambow Education Holding Ltd. 4314134 Consumer Defensive \n", - "1 ITP IT Tech Packaging, Inc. 2922131 Basic Materials \n", - "2 DXF Dunxin Financial Holdings Limited 1232011 Financial Services \n", - "3 CPHI China Pharma Holdings, Inc. 1084973 Healthcare \n", + "0 AMBO Ambow Education Holding Ltd. 63818550 Consumer Defensive \n", + "1 CPHI China Pharma Holdings, Inc. 4107363 Healthcare \n", + "2 ITP IT Tech Packaging, Inc. 3104324 Basic Materials \n", + "3 DXF Dunxin Financial Holdings Limited 1375084 Financial Services \n", "\n", " industry beta price volume exchange \\\n", - "0 Education & Training Services 0.448 0.1521 54634 AMEX \n", - "1 Paper & Paper Products -0.1 0.2903 17827 AMEX \n", - "2 Credit Services 1.632 0.31 259614 AMEX \n", - "3 Drug Manufacturers—Specialty & Generic 0.875 0.0949 483393 AMEX \n", + "0 Education & Training Services 0.559 2.2500 27302 AMEX \n", + "1 Drug Manufacturers—Specialty & Generic 0.970 0.0774 848792 AMEX \n", + "2 Paper & Paper Products -0.224 0.3084 6467 AMEX \n", + "3 Credit Services 1.154 0.3460 39167 AMEX \n", "\n", - " exchange_name country is_etf actively_trading \n", - "0 American Stock Exchange CN False True \n", - "1 American Stock Exchange CN False True \n", - "2 American Stock Exchange CN False True \n", - "3 American Stock Exchange CN False True " + " exchange_name country is_etf actively_trading isFund \n", + "0 American Stock Exchange CN False True False \n", + "1 American Stock Exchange CN False True False \n", + "2 American Stock Exchange CN False True False \n", + "3 American Stock Exchange CN False True False " ] }, - "execution_count": 22, + "execution_count": 16, "metadata": {}, "output_type": "execute_result" } @@ -1111,50 +1793,201 @@ "source": [ "exchange_results = obb.equity.screener(exchange=\"amex\", country=\"CN\").to_df()\n", "display(len(exchange_results))\n", - "exchange_results.convert_dtypes()\n" + "exchange_results\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ - "## Find an Index\n", + "### 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": 17, + "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", + "
symbolnamemarket_capsectorindustrybetapricelast_annual_dividendvolumeexchangeexchange_namecountryis_etfactively_tradingisFund
0VZVerizon Communications Inc.166288131058Communication ServicesTelecom Services0.40339.55222.663715659NYSENew York Stock ExchangeUSFalseTrueFalse
1PGRThe Progressive Corporation111312278918Financial ServicesInsurance—Property & Casualty0.345190.05001.15695689NYSENew York Stock ExchangeUSFalseTrueFalse
2LMTLockheed Martin Corporation103775136301IndustrialsAerospace & Defense0.488429.456412.60204961NYSENew York Stock ExchangeUSFalseTrueFalse
3BMYBristol-Myers Squibb Company101615045088HealthcareDrug Manufacturers—General0.37150.25002.402113879NYSENew York Stock ExchangeUSFalseTrueFalse
\n", + "
" + ], + "text/plain": [ + " symbol name market_cap sector \\\n", + "0 VZ Verizon Communications Inc. 166288131058 Communication Services \n", + "1 PGR The Progressive Corporation 111312278918 Financial Services \n", + "2 LMT Lockheed Martin Corporation 103775136301 Industrials \n", + "3 BMY Bristol-Myers Squibb Company 101615045088 Healthcare \n", + "\n", + " industry beta price last_annual_dividend \\\n", + "0 Telecom Services 0.403 39.5522 2.66 \n", + "1 Insurance—Property & Casualty 0.345 190.0500 1.15 \n", + "2 Aerospace & Defense 0.488 429.4564 12.60 \n", + "3 Drug Manufacturers—General 0.371 50.2500 2.40 \n", + "\n", + " volume exchange exchange_name country is_etf \\\n", + "0 3715659 NYSE New York Stock Exchange US False \n", + "1 695689 NYSE New York Stock Exchange US False \n", + "2 204961 NYSE New York Stock Exchange US False \n", + "3 2113879 NYSE New York Stock Exchange US False \n", + "\n", + " actively_trading isFund \n", + "0 True False \n", + "1 True False \n", + "2 True False \n", + "3 True False " + ] + }, + "execution_count": 17, + "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": [ + "## Get Available Indices\n", "\n", "List all indices from a source with:" ] }, { "cell_type": "code", - "execution_count": 23, + "execution_count": 18, "metadata": {}, "outputs": [ { - "data": { - "text/plain": [ - "274" - ] - }, - "metadata": {}, - "output_type": "display_data" - } - ], - "source": [ - "indices = obb.index.available(provider=\"yfinance\").to_df()\n", - "display(len(indices))\n" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Filter the list down by querying the DataFrame." - ] - }, - { - "cell_type": "code", - "execution_count": 24, - "metadata": {}, - "outputs": [ + "name": "stdout", + "output_type": "stream", + "text": [ + "274\n" + ] + }, { "data": { "text/html": [ @@ -1296,13 +2129,23 @@ "102 ^AXUJ " ] }, - "execution_count": 24, + "execution_count": 18, "metadata": {}, "output_type": "execute_result" } ], "source": [ - "indices[indices[\"name\"].str.contains(\"ASX 200\")]\n" + "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." ] }, { @@ -1314,7 +2157,7 @@ }, { "cell_type": "code", - "execution_count": 25, + "execution_count": 21, "metadata": {}, "outputs": [ { @@ -1355,7 +2198,7 @@ " \n", " \n", " \n", - " 2023-11-17\n", + " 2024-02-27\n", " True\n", " True\n", " True\n", @@ -1369,18 +2212,18 @@ "text/plain": [ " open high low close volume\n", "date \n", - "2023-11-17 True True True True True" + "2024-02-27 True True True True True" ] }, - "execution_count": 25, + "execution_count": 21, "metadata": {}, "output_type": "execute_result" } ], "source": [ "(\n", - " obb.index.market(\"au_utilities\", provider=\"yfinance\").to_df().tail(1)\n", - " == obb.index.market(\"^AXUJ\", provider=\"yfinance\").to_df().tail(1)\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", ")\n" ] } @@ -1401,7 +2244,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.11.4" + "version": "3.11.7" } }, "nbformat": 4, diff --git a/website/content/platform/usage/find_symbols.md b/website/content/platform/usage/find_symbols.md index 71d0d0040f2..75dcf1fc599 100644 --- a/website/content/platform/usage/find_symbols.md +++ b/website/content/platform/usage/find_symbols.md @@ -37,14 +37,82 @@ from openbb import obb 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. ::: -The simplest way to find a ticker for a company is with a simple fuzzy query. +The simplest way to find tickers is with a basic text query. + +## Search Nasdaq + +```python +obb.equity.search("JPMorgan", provider="nasdaq").to_df().head(3) +``` + +| | symbol | name | nasdaq_traded | exchange | market_category | etf | round_lot_size | test_issue | financial_status | cqs_symbol | nasdaq_symbol | next_shares | +|---:|:---------|:-----------------------------------------------------------------|:----------------|:-----------|:------------------|:------|-----------------:|:-------------|:-------------------|:-------------|:----------------|:--------------| +| 0 | AMJB | JPMorgan Chase & Co. Alerian MLP Index ETNs due January 28, 2044 | Y | P | | Y | 100 | N | | AMJB | AMJB | N | +| 1 | BBAG | JPMorgan BetaBuilders U.S. Aggregate Bond ETF | Y | P | | Y | 100 | N | | BBAG | BBAG | N | +| 2 | BBAX | JPMorgan BetaBuilders Developed Asia Pacific-ex Japan ETF | Y | Z | | Y | 100 | N | | BBAX | BBAX | N | + + +## Search Cboe + +```python +obb.index.search("SPX", provider="cboe").to_df().tail(5) +``` + +| | symbol | name | description | data_delay | currency | time_zone | open_time | close_time | tick_days | tick_frequency | tick_period | +|---:|:---------|:--------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|-------------:|:-----------|:----------------|:------------|:-------------|:------------|:-----------------|:--------------| +| 32 | SPXVIV | PROSHARES S&P 500 EX-HEALTH CARE ETF | PROSHARES S&P 500 EX-HEALTH CARE ETF | 15 | USD | America/Chicago | 08:00:00 | 16:00:00 | MonToFri | C | Regular | +| 33 | VIX1D | Cboe 1-Day Volatility Index® | Estimates expected volatility by aggregating the weighted prices of P.M.-settled S&P 500 Index (SPX℠) puts and calls over a wide range of strike prices. | 15 | USD | America/Chicago | 08:00:00 | 16:00:00 | MonToFri | C | Regular | +| 34 | VIX3M | Cboe S&P 500 3 Month Volatility Index | The Cboe 3-Month Volatility Index (VIX3M) is designed to be a constant measure of 3-month implied volatility of the S&P 500? (SPX) Index options. | 15 | USD | America/Chicago | 08:00:00 | 16:00:00 | MonToFri | C | Regular | +| 35 | WPUT | Cboe S&P 500 One-Week PutWrite Index | Tracks the value of a portfolio that overlays a short weekly SPX put on one-month Treasury bills | 15 | USD | America/Chicago | 08:00:00 | 16:00:00 | MonToFri | C | Regular | +| 36 | XSPAM | Mini SPX Index (AM Settlement) | Mini SPX Index (AM Settlement) | 15 | USD | America/Chicago | 08:00:00 | 16:00:00 | MonToFri | C | Regular | + +## Search ETFs + +```python +obb.etf.search("gold", provider="tmx").to_df().iloc[-5:] +``` + +| | VALT.B | VALT.U | XGD | ZGD | ZJG | +|:----------------------|:---------------------------|:---------------------------|:--------------------------------------|:---------------------------------------|:--------------------------| +| name | CI Gold Bullion Fund | CI Gold Bullion Fund | iShares S&P/TSX Global Gold Index ETF | BMO Equal Weight Global Gold Index ETF | BMO Junior Gold Index ETF | +| short_name | VALT.B:CA | CI Gold Bullion | iShares S&P/TSX | BMO Equal Weight | BMO Junior Gold | +| inception_date | 2021-03-17 | 2021-01-06 | 2001-03-23 | 2012-11-14 | 2010-01-19 | +| issuer | CI Global Asset Management | CI Global Asset Management | RBC iShares | BMO ETF | BMO ETF | +| investment_style | Gold | Gold | Mid Cap Growth | Mid Cap Blend | Small Cap Blend | +| esg | False | False | False | False | True | +| currency | CAD | USD | CAD | CAD | CAD | +| unit_price | 27.23 | 20.25 | 15.15 | 65.3 | 57.9 | +| close | 27.31 | 20.22 | 15.15 | 63.9 | 58.1 | +| prev_close | 27.35 | 20.26 | 15.44 | 65.3 | 59.16 | +| return_1m | 0.0008210000000000001 | -0.012248000000000002 | -0.080416 | -0.077245 | -0.052842 | +| return_3m | -0.010862 | 0.027784 | -0.023677 | -0.009352000000000001 | 0.000172 | +| return_6m | 0.056706000000000006 | 0.041046 | -0.082551 | -0.07498 | -0.048376 | +| return_ytd | -0.003618 | -0.007048 | -0.074745 | -0.067335 | -0.04167099999999999 | +| return_1y | 0.06689300000000001 | 0.06554299999999999 | -0.129462 | -0.0836 | -0.08241899999999999 | +| beta_1y | 0.57958 | 0.725625 | 0.372225 | 0.469185 | 0.433886 | +| return_3y | nan | 0.030979999999999997 | -0.033076 | -0.021792 | -0.028114 | +| beta_3y | 0.681245 | 0.699766 | 0.515024 | 0.671806 | 0.654367 | +| return_5y | nan | nan | 0.076559 | 0.08920299999999999 | 0.068623 | +| beta_5y | -0.008613 | 0.233721 | 0.738329 | 0.997267 | 1.103204 | +| return_10y | nan | nan | 0.044696999999999994 | 0.05585 | 0.041349 | +| beta_10y | 0.633314 | 0.633314 | 0.38428 | 0.445404 | 0.452332 | +| beta_15y | nan | nan | 0.395464 | nan | nan | +| return_from_inception | 0.08311199999999999 | nan | 0.069155 | -0.006563 | -0.022995 | +| avg_volume | 430 | 690 | 456399 | 436 | 511 | +| avg_volume_30d | 1428 | 4747 | 1194453 | 3417 | 1491 | +| aum | 14976500.0 | 28147500.0 | 986265000.0 | 41396935.0 | 52271541.0 | +| pe_ratio | nan | nan | 26.4436 | 17.2285 | 26.8283 | +| pb_ratio | nan | nan | 1.909 | 1.3891 | 1.531 | +| management_fee | 0.00155 | 0.00155 | 0.0060999999999999995 | 0.0055000000000000005 | 0.0055000000000000005 | +| mer | nan | nan | 0.0060999999999999995 | 0.0062 | 0.0060999999999999995 | +| distribution_yield | 0.015347 | 0.016145 | 0.016212999999999998 | 0.008305 | 0.009537 | +| dividend_frequency | Annually | Annually | Semi-Annually | Annually | Annually | +| beta_20y | nan | nan | 0.560996 | nan | nan | + + ## Search the SEC -Perform a quick search using the `openbb-sec` provider. - -### Find a Company - Use an empty string, `""`, to return the complete list - over 10,000. ```python @@ -260,7 +328,7 @@ obb.equity.screener( | MRK | Merck & Co., Inc. | 258192673024 | Healthcare | Drug Manufacturers—General | 0.375 | 101.75 | 2.92 | 6760568 | NYSE | New York Stock Exchange | US | False | True | | VZ | Verizon Communications Inc. | 152314546478 | Communication Services | Telecom Services | 0.391 | 36.23 | 2.66 | 14960968 | NYSE | New York Stock Exchange | US | False | True | -## Find an Index +## Get Available Indices List all indices from a source with: @@ -313,3 +381,4 @@ With the `openbb-yfinance` extension, index time series can be loaded using the ::: The examples above show demonstrate the most basic ways to find ticker symbols with the OpenBB Platform. Create your own custom scripts for discovery by combining these with other methods. +