Skip to content

Commit

Permalink
Implemented #149
Browse files Browse the repository at this point in the history
  • Loading branch information
manusimidt committed Nov 13, 2024
1 parent 93246b8 commit 658f225
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Online
Parsing submissions stored on a webserver is pretty easy. Just provide `py-xbrl` with the url
and `py-xbrl` will download all necessary files for you and store them into the cache.
Make sure to set the http headers correctly (Services like SEC EDGAR require it!).
Please find more information about headers and usage regulations in the `SEC EDGAR documentation <https://www.sec.gov/search-filings/edgar-search-assistance/accessing-edgar-data>`_.

.. code-block:: python
Expand All @@ -43,7 +44,7 @@ Make sure to set the http headers correctly (Services like SEC EDGAR require it!
logging.basicConfig(level=logging.INFO)
cache: HttpCache = HttpCache('./cache')
cache.set_headers({'From': '[email protected]', 'User-Agent': 'py-xbrl/2.1.0'})
cache.set_headers({'From': '[email protected]', 'User-Agent': 'Company Name AdminContact@<company-domain>.com'})
parser = XbrlParser(cache)
schema_url = "https://www.sec.gov/Archives/edgar/data/0000320193/000032019321000105/aapl-20210925.htm"
Expand Down

0 comments on commit 658f225

Please sign in to comment.