mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
Start Readme
This commit is contained in:
31
gamestonk_terminal/etf/README.md
Normal file
31
gamestonk_terminal/etf/README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# ETF
|
||||
Menu for Exchange Traded Funds.
|
||||
|
||||
Data is currently scraped from StockAnalysis.com/etf
|
||||
|
||||
* [web](#web)
|
||||
* open webbroswer to stockanalysis.com
|
||||
* [search](#search)
|
||||
* search for ETFS matching an input
|
||||
* [overview](#overview)
|
||||
* get ETF overview
|
||||
* [holdings](#holdings)
|
||||
* show ETF holdings
|
||||
* [compare](#compare)
|
||||
* compare multiple ETFs overview
|
||||
|
||||
## web <a name="web"></a>
|
||||
```python
|
||||
usage: web
|
||||
```
|
||||
Opens StockAnalysis.com/etf. This site shows all avalaiable ETFs (currently > 2800).
|
||||
|
||||
## search <a name="search"></a>
|
||||
```python
|
||||
usage: search [-n --name]
|
||||
```
|
||||
Search for ETFs matching
|
||||
* -n/--name : Name to search for. Can be a company or other
|
||||
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ def open_web():
|
||||
|
||||
def name_search(other_args: List[str]):
|
||||
"""
|
||||
Search all available etfs for matching
|
||||
Search all available etfs for matching input
|
||||
Parameters
|
||||
----------
|
||||
other_args: List[str]
|
||||
|
||||
Reference in New Issue
Block a user