Skip to content

Commit

Permalink
add spacing to readme attempt 4
Browse files Browse the repository at this point in the history
  • Loading branch information
shilewenuw authored Mar 29, 2020
1 parent dd1cba2 commit 8a8a091
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,29 @@ pip install get-all-tickers
```
get_tickers(NYSE=True, NASDAQ=True, AMEX=True)
```
Returns a list of tickers, set an exchange to false to exclude. <br />
Returns a list of tickers, set an exchange to false to exclude.


```
Region.DESIRED_REGION_HERE
```
Region constants include: AFRICA, EUROPE, ASIA, AUSTRALIA_SOUTH_PACIFIC, CARIBBEAN, SOUTH_AMERICA, MIDDLE_EAST, NORTH_AMERICA. Regions are used as arguments for region specific methods. <br />
Region constants include: AFRICA, EUROPE, ASIA, AUSTRALIA_SOUTH_PACIFIC, CARIBBEAN, SOUTH_AMERICA, MIDDLE_EAST, NORTH_AMERICA. Regions are used as arguments for region specific methods.

```
get_tickers_by_region(region)
```
Use a Region constant (e.g Region.EUROPE) as the argument. Returns a list of tickers in specified region. <br />
Use a Region constant (e.g Region.EUROPE) as the argument. Returns a list of tickers in specified region.
<br />
```
save_tickers(NYSE=True, NASDAQ=True, AMEX=True, filename='tickers.csv')
```
Set any exchange to False if you don't want to include it. Saves tickers to a csv file. <br />
Set any exchange to False if you don't want to include it. Saves tickers to a csv file.

```
save_tickers_by_region(region, filename='tickers_by_region.csv')
```
Use a Region constant (e.g Region.EUROPE) as the argument. Saves tickers in specified region to csv <br />
Use a Region constant (e.g Region.EUROPE) as the argument. Saves tickers in specified region to csv

### examples
```
from get_all_tickers import get_tickers as gt
Expand Down

0 comments on commit 8a8a091

Please sign in to comment.