summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDanglewood <85772166+deeleeramone@users.noreply.github.com>2024-02-28 10:49:16 -0800
committerGitHub <noreply@github.com>2024-02-28 18:49:16 +0000
commit37209c88ea86384b6437aa67b6e4e30d95bf6e9a (patch)
tree5871267d38d9039e41befbc4998547a7393b0fe7
parent59e2099a1f62dccf2b0996a7f83540a343f58080 (diff)
add more examples into findSymbols (#6139)
Co-authored-by: James Maslek <jmaslek11@gmail.com>
-rw-r--r--examples/findSymbols.ipynb1543
-rw-r--r--website/content/platform/usage/find_symbols.md79
2 files changed, 1267 insertions, 355 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": [
+ "<div>\n",
+ "<style scoped>\n",
+ " .dataframe tbody tr th:only-of-type {\n",
+ " vertical-align: middle;\n",
+ " }\n",
+ "\n",
+ " .dataframe tbody tr th {\n",
+ " vertical-align: top;\n",
+ " }\n",
+ "\n",
+ " .dataframe thead th {\n",
+ " text-align: right;\n",
+ " }\n",
+ "</style>\n",
+ "<table border=\"1\" class=\"dataframe\">\n",
+ " <thead>\n",
+ " <tr style=\"text-align: right;\">\n",
+ " <th></th>\n",
+ " <th>symbol</th>\n",
+ " <th>name</th>\n",
+ " <th>nasdaq_traded</th>\n",
+ " <th>exchange</th>\n",
+ " <th>market_category</th>\n",
+ " <th>etf</th>\n",
+ " <th>round_lot_size</th>\n",
+ " <th>test_issue</th>\n",
+ " <th>financial_status</th>\n",
+ " <th>cqs_symbol</th>\n",
+ " <th>nasdaq_symbol</th>\n",
+ " <th>next_shares</th>\n",
+ " </tr>\n",
+ " </thead>\n",
+ " <tbody>\n",
+ " <tr>\n",
+ " <th>0</th>\n",
+ " <td>AMJ</td>\n",
+ " <td>JPMorgan Chase Capital XVI JP Morgan Alerian M...</td>\n",
+ " <td>Y</td>\n",
+ " <td>P</td>\n",
+ " <td>None</td>\n",
+ " <td>N</td>\n",
+ " <td>100.0</td>\n",
+ " <td>N</td>\n",
+ " <td>None</td>\n",
+ " <td>AMJ</td>\n",
+ " <td>AMJ</td>\n",
+ " <td>N</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>1</th>\n",
+ " <td>AMJB</td>\n",
+ " <td>JPMorgan Chase &amp; Co. Alerian MLP Index ETNs du...</td>\n",
+ " <td>Y</td>\n",
+ " <td>P</td>\n",
+ " <td>None</td>\n",
+ " <td>Y</td>\n",
+ " <td>100.0</td>\n",
+ " <td>N</td>\n",
+ " <td>None</td>\n",
+ " <td>AMJB</td>\n",
+ " <td>AMJB</td>\n",
+ " <td>N</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>2</th>\n",
+ " <td>BBAG</td>\n",
+ " <td>JPMorgan BetaBuilders U.S. Aggregate Bond ETF</td>\n",
+ " <td>Y</td>\n",
+ " <td>P</td>\n",
+ " <td>None</td>\n",
+ " <td>Y</td>\n",
+ " <td>100.0</td>\n",
+ " <td>N</td>\n",
+ " <td>None</td>\n",
+ " <td>BBAG</td>\n",
+ " <td>BBAG</td>\n",
+ " <td>N</td>\n",
+ " </tr>\n",
+ " </tbody>\n",
+ "</table>\n",
+ "</div>"
+ ],
"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"
]
},
{
@@ -95,23 +183,588 @@
" <th></th>\n",
" <th>symbol</th>\n",
" <th>name</th>\n",
- " <th>cik</th>\n",
+ " <th>description</th>\n",
+ " <th>data_delay</th>\n",
+ " <th>currency</th>\n",
+ " <th>time_zone</th>\n",
+ " <th>open_time</th>\n",
+ " <th>close_time</th>\n",
+ " <th>tick_days</th>\n",
+ " <th>tick_frequency</th>\n",
+ " <th>tick_period</th>\n",
+ " </tr>\n",
+ " </thead>\n",
+ " <tbody>\n",
+ " <tr>\n",
+ " <th>32</th>\n",
+ " <td>SPXVIV</td>\n",
+ " <td>PROSHARES S&amp;P 500 EX-HEALTH CARE ETF</td>\n",
+ " <td>PROSHARES S&amp;P 500 EX-HEALTH CARE ETF</td>\n",
+ " <td>15</td>\n",
+ " <td>USD</td>\n",
+ " <td>America/Chicago</td>\n",
+ " <td>08:00:00</td>\n",
+ " <td>16:00:00</td>\n",
+ " <td>MonToFri</td>\n",
+ " <td>C</td>\n",
+ " <td>Regular</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>33</th>\n",
+ " <td>VIX1D</td>\n",
+ " <td>Cboe 1-Day Volatility Index®</td>\n",
+ " <td>Estimates expected volatility by aggregating t...</td>\n",
+ " <td>15</td>\n",
+ " <td>USD</td>\n",
+ " <td>America/Chicago</td>\n",
+ " <td>08:00:00</td>\n",
+ " <td>16:00:00</td>\n",
+ " <td>MonToFri</td>\n",
+ " <td>C</td>\n",
+ " <td>Regular</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>34</th>\n",
+ " <td>VIX3M</td>\n",
+ " <td>Cboe S&amp;P 500 3 Month Volatility Index</td>\n",
+ " <td>The Cboe 3-Month Volatility Index (VIX3M) is d...</td>\n",
+ " <td>15</td>\n",
+ " <td>USD</td>\n",
+ " <td>America/Chicago</td>\n",
+ " <td>08:00:00</td>\n",
+ " <td>16:00:00</td>\n",
+ " <td>MonToFri</td>\n",
+ " <td>C</td>\n",
+ " <td>Regular</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>35</th>\n",
+ " <td>WPUT</td>\n",
+ " <td>Cboe S&amp;P 500 One-Week PutWrite Index</td>\n",
+ " <td>Tracks the value of a portfolio that overlays ...</td>\n",
+ " <td>15</td>\n",
+ " <td>USD</td>\n",
+ " <td>America/Chicago</td>\n",
+ " <td>08:00:00</td>\n",
+ " <td>16:00:00</td>\n",
+ " <td>MonToFri</td>\n",
+ " <td>C</td>\n",
+ " <td>Regular</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>36</th>\n",
+ " <td>XSPAM</td>\n",
+ " <td>Mini SPX Index (AM Settlement)</td>\n",
+ " <td>Mini SPX Index (AM Settlement)</td>\n",
+ " <td>15</td>\n",
+ " <td>USD</td>\n",
+ " <td>America/Chicago</td>\n",
+ " <td>08:00:00</td>\n",
+ " <td>16:00:00</td>\n",
+ " <td>MonToFri</td>\n",
+ " <td>C</td>\n",
+ " <td>Regular</td>\n",
+ " </tr>\n",
+ " </tbody>\n",
+ "</table>\n",
+ "</div>"
+ ],
+ "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": [
+ "<div>\n",
+ "<style scoped>\n",
+ " .dataframe tbody tr th:only-of-type {\n",
+ " vertical-align: middle;\n",
+ " }\n",
+ "\n",
+ " .dataframe tbody tr th {\n",
+ " vertical-align: top;\n",
+ " }\n",
+ "\n",
+ " .dataframe thead th {\n",
+ " text-align: right;\n",
+ " }\n",
+ "</style>\n",
+ "<table border=\"1\" class=\"dataframe\">\n",
+ " <thead>\n",
+ " <tr style=\"text-align: right;\">\n",
+ " <th></th>\n",
+ " <th>symbol</th>\n",
+ " <th>name</th>\n",
+ " <th>short_name</th>\n",
+ " <th>inception_date</th>\n",
+ " <th>issuer</th>\n",
+ " <th>investment_style</th>\n",
+ " <th>esg</th>\n",
+ " <th>currency</th>\n",
+ " <th>unit_price</th>\n",
+ " <th>close</th>\n",
+ " <th>...</th>\n",
+ " <th>avg_volume</th>\n",
+ " <th>avg_volume_30d</th>\n",
+ " <th>aum</th>\n",
+ " <th>pe_ratio</th>\n",
+ " <th>pb_ratio</th>\n",
+ " <th>management_fee</th>\n",
+ " <th>mer</th>\n",
+ " <th>distribution_yield</th>\n",
+ " <th>dividend_frequency</th>\n",
+ " <th>beta_20y</th>\n",
+ " </tr>\n",
+ " </thead>\n",
+ " <tbody>\n",
+ " <tr>\n",
+ " <th>17</th>\n",
+ " <td>VALT.B</td>\n",
+ " <td>CI Gold Bullion Fund</td>\n",
+ " <td>VALT.B:CA</td>\n",
+ " <td>2021-03-17</td>\n",
+ " <td>CI Global Asset Management</td>\n",
+ " <td>Gold</td>\n",
+ " <td>False</td>\n",
+ " <td>CAD</td>\n",
+ " <td>27.23</td>\n",
+ " <td>27.31</td>\n",
+ " <td>...</td>\n",
+ " <td>430</td>\n",
+ " <td>1428</td>\n",
+ " <td>14976500.0</td>\n",
+ " <td>NaN</td>\n",
+ " <td>NaN</td>\n",
+ " <td>0.00155</td>\n",
+ " <td>NaN</td>\n",
+ " <td>0.015347</td>\n",
+ " <td>Annually</td>\n",
+ " <td>NaN</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>18</th>\n",
+ " <td>VALT.U</td>\n",
+ " <td>CI Gold Bullion Fund</td>\n",
+ " <td>CI Gold Bullion</td>\n",
+ " <td>2021-01-06</td>\n",
+ " <td>CI Global Asset Management</td>\n",
+ " <td>Gold</td>\n",
+ " <td>False</td>\n",
+ " <td>USD</td>\n",
+ " <td>20.25</td>\n",
+ " <td>20.22</td>\n",
+ " <td>...</td>\n",
+ " <td>690</td>\n",
+ " <td>4747</td>\n",
+ " <td>28147500.0</td>\n",
+ " <td>NaN</td>\n",
+ " <td>NaN</td>\n",
+ " <td>0.00155</td>\n",
+ " <td>NaN</td>\n",
+ " <td>0.016145</td>\n",
+ " <td>Annually</td>\n",
+ " <td>NaN</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>19</th>\n",
+ " <td>XGD</td>\n",
+ " <td>iShares S&amp;P/TSX Global Gold Index ETF</td>\n",
+ " <td>iShares S&amp;P/TSX</td>\n",
+ " <td>2001-03-23</td>\n",
+ " <td>RBC iShares</td>\n",
+ " <td>Mid Cap Growth</td>\n",
+ " <td>False</td>\n",
+ " <td>CAD</td>\n",
+ " <td>15.15</td>\n",
+ " <td>15.15</td>\n",
+ " <td>...</td>\n",
+ " <td>456399</td>\n",
+ " <td>1194453</td>\n",
+ " <td>986265000.0</td>\n",
+ " <td>26.4436</td>\n",
+ " <td>1.9090</td>\n",
+ " <td>0.00610</td>\n",
+ " <td>0.0061</td>\n",
+ " <td>0.016213</td>\n",
+ " <td>Semi-Annually</td>\n",
+ " <td>0.560996</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>20</th>\n",
+ " <td>ZGD</td>\n",
+ " <td>BMO Equal Weight Global Gold Index ETF</td>\n",
+ " <td>BMO Equal Weight</td>\n",
+ " <td>2012-11-14</td>\n",
+ " <td>BMO ETF</td>\n",
+ " <td>Mid Cap Blend</td>\n",
+ " <td>False</td>\n",
+ " <td>CAD</td>\n",
+ " <td>65.30</td>\n",
+ " <td>63.90</td>\n",
+ " <td>...</td>\n",
+ " <td>436</td>\n",
+ " <td>3417</td>\n",
+ " <td>41396935.0</td>\n",
+ " <td>17.2285</td>\n",
+ " <td>1.3891</td>\n",
+ " <td>0.00550</td>\n",
+ " <td>0.0062</td>\n",
+ " <td>0.008305</td>\n",
+ " <td>Annually</td>\n",
+ " <td>NaN</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>21</th>\n",
+ " <td>ZJG</td>\n",
+ " <td>BMO Junior Gold Index ETF</td>\n",
+ " <td>BMO Junior Gold</td>\n",
+ " <td>2010-01-19</td>\n",
+ " <td>BMO ETF</td>\n",
+ " <td>Small Cap Blend</td>\n",
+ " <td>True</td>\n",
+ " <td>CAD</td>\n",
+ " <td>57.90</td>\n",
+ " <td>58.10</td>\n",
+ " <td>...</td>\n",
+ " <td>511</td>\n",
+ " <td>1491</td>\n",
+ " <td>52271541.0</td>\n",
+ " <td>26.8283</td>\n",
+ " <td>1.5310</td>\n",
+ " <td>0.00550</td>\n",
+ " <td>0.0061</td>\n",
+ " <td>0.009537</td>\n",
+ " <td>Annually</td>\n",
+ " <td>NaN</td>\n",
+ " </tr>\n",
+ " </tbody>\n",
+ "</table>\n",
+ "<p>5 rows × 35 columns</p>\n",
+ "</div>"
+ ],
+ "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": [
+ "<div>\n",
+ "<style scoped>\n",
+ " .dataframe tbody tr th:only-of-type {\n",
+ " vertical-align: middle;\n",
+ " }\n",
+ "\n",
+ " .dataframe tbody tr th {\n",
+ " vertical-align: top;\n",
+ " }\n",
+ "\n",
+ " .dataframe thead th {\n",
+ " text-align: right;\n",
+ " }\n",
+ "</style>\n",
+ "<table border=\"1\" class=\"dataframe\">\n",
+ " <thead>\n",
+ " <tr style=\"text-align: right;\">\n",
+ " <th></th>\n",
+ " <th>symbol</th>\n",
+ " <th>name</th>\n",
+ " <th>market_cap</th>\n",
+ " <th>sector</th>\n",
+ " <th>industry</th>\n",
+ " <th>beta</th>\n",
+ " <th>price</th>\n",
+ " <th>last_annual_dividend</th>\n",
+ " <th>volume</th>\n",
+ " <th>exchange</th>\n",
+ " <th>exchange_name</th>\n",
+ " <th>country</th>\n",
+ " <th>actively_trading</th>\n",
+ " <th>isFund</th>\n",
" </tr>\n",
" </thead>\n",
" <tbody>\n",
" <tr>\n",
" <th>0</th>\n",
- " <td>AAPL</td>\n",
- " <td>Apple Inc.</td>\n",
- " <td>320193</td>\n",
+ " <td>QYLD</td>\n",
+ " <td>Global X NASDAQ 100 Covered Call ETF</td>\n",
+ " <td>7.851962e+09</td>\n",
+ " <td></td>\n",
+ " <td>None</td>\n",
+ " <td>0.65</td>\n",
+ " <td>17.8200</td>\n",
+ " <td>2.06171</td>\n",
+ " <td>1216103.0</td>\n",
+ " <td>NASDAQ</td>\n",
+ " <td>NASDAQ Global Market</td>\n",
+ " <td>US</td>\n",
+ " <td>True</td>\n",
+ " <td>False</td>\n",
" </tr>\n",
" <tr>\n",
" <th>1</th>\n",
+ " <td>XYLD</td>\n",
+ " <td>Global X S&amp;P 500 Covered Call ETF</td>\n",
+ " <td>2.750881e+09</td>\n",
+ " <td></td>\n",
+ " <td>None</td>\n",
+ " <td>0.53</td>\n",
+ " <td>40.0998</td>\n",
+ " <td>3.94248</td>\n",
+ " <td>64645.0</td>\n",
+ " <td>AMEX</td>\n",
+ " <td>New York Stock Exchange Arca</td>\n",
+ " <td>US</td>\n",
+ " <td>True</td>\n",
+ " <td>False</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>2</th>\n",
+ " <td>ZWU.TO</td>\n",
+ " <td>BMO Covered Call Utilities ETF</td>\n",
+ " <td>1.698515e+09</td>\n",
+ " <td></td>\n",
+ " <td>None</td>\n",
+ " <td>0.67</td>\n",
+ " <td>10.0300</td>\n",
+ " <td>0.86000</td>\n",
+ " <td>56572.0</td>\n",
+ " <td>TSX</td>\n",
+ " <td>Toronto Stock Exchange</td>\n",
+ " <td>CA</td>\n",
+ " <td>True</td>\n",
+ " <td>False</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>3</th>\n",
+ " <td>ZWC.TO</td>\n",
+ " <td>BMO CA High Dividend Covered Call ETF</td>\n",
+ " <td>1.602642e+09</td>\n",
+ " <td></td>\n",
+ " <td>None</td>\n",
+ " <td>0.89</td>\n",
+ " <td>17.0200</td>\n",
+ " <td>1.19000</td>\n",
+ " <td>17235.0</td>\n",
+ " <td>TSX</td>\n",
+ " <td>Toronto Stock Exchange</td>\n",
+ " <td>CA</td>\n",
+ " <td>True</td>\n",
+ " <td>False</td>\n",
+ " </tr>\n",
+ " <tr>\n",
+ " <th>4</th>\n",
+ " <td>RYLD</td>\n",
+ " <td>Global X Russell 2000 Covered Call ETF</td>\n",
+ " <td>1.406859e+09</td>\n",
+ " <td>Miscellaneous</td>\n",
+ " <td>Investment Trusts/Mutual Funds</td>\n",
+ " <td>0.56</td>\n",
+ " <td>16.4900</td>\n",
+ " <td>1.87702</td>\n",
+ " <td>133691.0</td>\n",
+ " <td>AMEX</td>\n",
+ " <td>New York Stock Exchange Arca</td>\n",
+ " <td>US</td>\n",
+ " <td>True</td>\n",
+ " <td>False</td>\n",
+ " </tr>\n",
+ " </tbody>\n",
+ "</table>\n",
+ "</div>"
+ ],
+ "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": [
+ "<div>\n",
+ "<style scoped>\n",
+ " .dataframe tbody tr th:only-of-type {\n",
+ " vertical-align: middle;\n",
+ " }\n",
+ "\n",
+ " .dataframe tbody tr th {\n",
+ " vertical-align: top;\n",
+ " }\n",
+ "\n",
+ " .dataframe thead th {\n",
+ " text-align: right;\n",
+ " }\n",
+ "</style>\n",
+ "<table border=\"1\" class=\"dataframe\">\n",
+ " <thead>\n",
+ " <tr style=\"text-align: right;\">\n",
+ " <th></th>\n",
+ " <th>symbol</th>\n",
+ " <th>name</th>\n",
+ " <th>cik</th>\n",
+ " </tr>\n",
+ " </thead>\n",
+ " <tbody>\n",
+ " <tr>\n",
+ " <th>0</th>\n",
" <td>MSFT</td>\n",