Skip to content

Commit 312dfd2

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents 9fb36cc + f23b183 commit 312dfd2

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

README.md

+10-16
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,21 @@ Any quotes data displayed on finviz.com is delayed by 15 minutes for NASDAQ, and
2424

2525
from finviz.screener import Screener
2626

27-
filters = ['exch_nasd', 'cap_large'] # Shows companies in NASDAQ with a market cap from $10bln. to $200bln.
28-
order = '-price' # Orders the results by price descending
29-
30-
stocks = Screener(filters, order, rows=50) # Get the first 50 results
27+
filters = ['exch_nasd', 'idx_sp500'] # Shows companies in NASDAQ which are in the S&P500
28+
stocks = Screener(filters=filters, order='price') # Get the first 50 results sorted by price ascending
3129

3230
# Export the screener results to .csv
3331
stocks.to_csv()
3432

3533
# Create a SQLite database
3634
stocks.to_sqlite()
3735

38-
### Download results as a chart
36+
# Print the table into the console
37+
print(stocks)
38+
39+
![alt text](https://i.imgur.com/cb7UdxB.png)
40+
41+
### Download results as charts
3942

4043
stocks.get_charts(period='m', chart_type='c', size='l', ta=False) # Monthly, Candles, Large, No Technical Analysis
4144

@@ -52,16 +55,7 @@ Any quotes data displayed on finviz.com is delayed by 15 minutes for NASDAQ, and
5255
# ta=True > display technical analysis
5356
# ta=False > ignore technical analysis
5457

58+
### Documentation
5559

56-
57-
Below, you can see all of the possible arguments that can be passed through Screener():
58-
59-
| Argument | Type | Example | Default |
60-
| :--- | :---: | :---: | :---: |
61-
| tickers | list | ['AAPL', 'ATVI', 'TSLA'] | None |
62-
| filters | list | ['exch_nasd', 'cap_large'] | None |
63-
| order | string | '-price' | None |
64-
| signal | string | 'ta_topgainers' | None |
65-
| table | string | 'Performance' | 'Overview' |
66-
| rows | string | 43 | Maximum |
60+
You can read the rest of the documentation inside the docstrings.
6761

0 commit comments

Comments
 (0)