Skip to content

Commit 778fe89

Browse files
committed
Update README about #18
1 parent 281829a commit 778fe89

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

Diff for: README.rst

+11-10
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pystock-crawler
1313
``pystock-crawler`` is a utility for crawling historical data of US stocks,
1414
including:
1515

16-
* Ticker symbols listed in NYSE and NASDAQ from `NASDAQ`_
16+
* Ticker symbols listed in NYSE, NASDAQ or AMEX from `NASDAQ.com`_
1717
* Daily prices from `Yahoo Finance`_
1818
* Fundamentals from 10-Q and 10-K filings (XBRL) on `SEC EDGAR`_
1919

@@ -70,26 +70,27 @@ After installing prerequisites, you can then install ``pystock-crawler`` with
7070
Quickstart
7171
----------
7272

73-
**Example 1.** Google's and Yahoo's daily prices ordered by date::
73+
**Example 1.** Fetch Google's and Yahoo's daily prices ordered by date::
7474

7575
pystock-crawler prices GOOG,YHOO -o out.csv --sort
7676

77-
**Example 2.** Daily prices of all companies listed in ``./symbols.txt``::
77+
**Example 2.** Fetch daily prices of all companies listed in
78+
``./symbols.txt``::
7879

7980
pystock-crawler prices ./symbols.txt -o out.csv
8081

81-
**Example 3.** Facebook's fundamentals during 2013::
82+
**Example 3.** Fetch Facebook's fundamentals during 2013::
8283

8384
pystock-crawler reports FB -o out.csv -s 20130101 -e 20131231
8485

85-
**Example 4.** Fundamentals all companies in ``./nyse.txt`` and direct the
86-
logs to ``./crawling.log``::
86+
**Example 4.** Fetch fundamentals of all companies in ``./nyse.txt`` and direct
87+
the log to ``./crawling.log``::
8788

8889
pystock-crawler reports ./nyse.txt -o out.csv -l ./crawling.log
8990

90-
**Example 5.** All ticker symbols in NYSE and NASDAQ::
91+
**Example 5.** Fetch all ticker symbols in NYSE, NASDAQ and AMEX::
9192

92-
pystock-crawler symbols NYSE,NASDAQ -o out.txt
93+
pystock-crawler symbols NYSE,NASDAQ,AMEX -o out.txt
9394

9495

9596
Usage
@@ -125,7 +126,7 @@ There are three commands available:
125126
* ``pystock-crawler reports`` grabs fundamentals
126127

127128
``<exchanges>`` is a comma-separated string that specifies the stock exchanges
128-
you want to include. Only NYSE and NASDAQ are supported.
129+
you want to include. Current, NYSE, NASDAQ and AMEX are supported.
129130

130131
The output file of ``pystock-crawler symbols`` can be used for ``<symbols>``
131132
argument in ``pystock-crawler prices`` and ``pystock-crawler reports``
@@ -195,7 +196,7 @@ the ``sample_data`` directory.
195196

196197
.. _libffi: https://sourceware.org/libffi/
197198
.. _lxml: http://lxml.de/
198-
.. _NASDAQ: http://www.nasdaq.com/
199+
.. _NASDAQ.com: http://www.nasdaq.com/
199200
.. _Scrapy: http://scrapy.org/
200201
.. _Scrapy's installation guide: http://doc.scrapy.org/en/latest/intro/install.html
201202
.. _SEC EDGAR: http://www.sec.gov/edgar/searchedgar/companysearch.html

0 commit comments

Comments
 (0)