Metadata-Version: 2.1
Name: edgarquery
Version: 0.0.40
Summary: Downloads various SEC EDGAR files converting many to CSV files
Project-URL: Documentation, https://github.com/dfwcnj/edgarquery#readme
Project-URL: Issues, https://github.com/dfwcnj/edgarquery/issues
Project-URL: Source, https://github.com/dfwcnj/edgarquery
Author-email: Don Caldwell <dfwcnj@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# EDGARquery

**Table of Contents**

- [Installation](#installation)
```console
pip install edgarquery
```

- [License](#license)
`edgarquery` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

-[Usage]


EQODIR  - the location to store the output<br/>
EQEMAIL - required by the SEC to download some of the files with curl.<br/>
<br/>
usage: edgarquery [-h] [--cik CIK] [--cy CY] [--frame FRAME] [--units UNITS]<br/>
                  [--fact FACT] [--directory DIRECTORY] [--file FILE]<br/>
                  [--companyconcept] [--companyfacts] [--xbrlframes]<br/>
                  [--companyfactsarchivezip] [--submissionszip]<br/>
                  [--financialstatementandnotesdataset]<br/>
<br/>
query SEC EDGAR site NOTE thæt EQEMAIL env variable is required and must<br/>
contain a valid User-Agent such as your email address<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --cik CIK             10-digit Central Index Key<br/>
  --cy CY               calendar year e.g. CY2023, CY2023Q1, CY2023Q4I<br/>
  --frame FRAME         reporting frame e.g us-gaap, ifrs-full, dei, srt<br/>
  --units UNITS         USD or shares<br/>
  --fact FACT           fact to collect e.g AccountsPayableCurrent, USD-per-<br/>
                        shares<br/>
  --directory DIRECTORY<br/>
                        directory to store the output<br/>
  --file FILE           file in which to store the output argument allowed for<br/>
                        each query type if --directory is not provided, it<br/>
                        should be the full path<br/>
  --companyconcept      returns all the XBRL disclosures from a single company<br/>
                        --cik required --frame - default us-gaap --fact -<br/>
                        default USD-per-shares<br/>
  --companyfacts        aggregates one fact for each reporting entity that is<br/>
                        last filed that most closely fits the calendrical<br/>
                        period requested --cik required<br/>
  --xbrlframes          returns all the company concepts data for a CIK --cy<br/>
                        required<br/>
  --companyfactsarchivezip<br/>
                        returns daily companyfacts index in a zip file<br/>
  --submissionszip      returns daily index of submissions in a zip file<br/>
  --financialstatementandnotesdataset<br/>
                        returns zip file with financial statement and notes<br/>
                        summaries --cy required<br/>
<br/>
## edgarsubmissions<br/>
<br/>
usage: edgarsubmissions [-h] --cik CIK [--year YEAR] [--file FILE]<br/>
                        [--directory DIRECTORY]<br/>
<br/>
find the most recent submissions for cik<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --cik CIK             10-digit Central Index Key<br/>
  --year YEAR           year to search for submissions if not current year<br/>
  --file FILE           store the output in this file<br/>
  --directory DIRECTORY<br/>
                        store the output in this directory<br/>
<br/>
## edgarxbrlframestocsv<br/>
<br/>
usage: edgarxbrlframestocsv [-h] --file FILE [--directory DIRECTORY]<br/>
<br/>
Parse an SEC EDGAR xbrlframes json file after it has been altered to deal with<br/>
its multipart character and generate a csv file from its contents<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --file FILE           xbrl frames json file to process<br/>
  --directory DIRECTORY<br/>
                        where to deposit the output<br/>
<br/>
<br/>
## edgarcompanyconcepttocsv<br/>
<br/>
usage: edgarcompanyconcepttocsv [-h] --file FILE [--directory DIRECTORY]<br/>
<br/>
Parse an SEC EDGAR companyconcepts json file after it has been altered to deal<br/>
with its multipart character and generate a csv file from its contents<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --file FILE           json file to process<br/>
  --directory DIRECTORY<br/>
                        where to deposit the fileѕ<br/>
<br/>
## edgarcompanyfactstocsv<br/>
<br/>
usage: edgarcompanyfactstocsv [-h] --file FILE [--directory DIRECTORY]<br/>
<br/>
Parse an SEC EDGAR companyfacts json file after it has been altered to deal<br/>
with its multipart character and generate CSV files from its content<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --file FILE           json file to process<br/>
  --directory DIRECTORY<br/>
                        where to deposit the csv fileѕ<br/>
<br/>
## edgarcompanyfactsziptocsv<br/>
<br/>
usage: edgarcompanyfactsziptocsv [-h] --zipfile ZIPFILE<br/>
                                 [--directory DIRECTORY] [--files FILES]<br/>
<br/>
Extract one or more json files from an SEC EDGAR companyfacts.zip file and<br/>
convert to CSV<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --zipfile ZIPFILE     submissions.zip file to process. Іt can be downloadæd<br/>
                        with edgarquery.query<br/>
  --directory DIRECTORY<br/>
                        where to deposit the output<br/>
  --files FILES         comma separated(no spaces) content file(s) to process<br/>
                        a subset of the files in the zip file<br/>
<br/>
## edgarlatest10K<br/>
<br/>
usage: edgarlatest10K [-h] --cik CIK [--link] [--directory DIRECTORY]<br/>
<br/>
find the most recent 10-K for cik<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --cik CIK             10-digit Central Index Key<br/>
  --link                return the url for the latest 10-K<br/>
  --directory DIRECTORY<br/>
                        directory to store the output<br/>
<br/>
## edgarlatestsubmissions<br/>
<br/>
usage: edgarlatestsubmissions [-h] --cik CIK [--directory DIRECTORY]<br/>
                              [--file FILE]<br/>
<br/>
find the most recent submissions for cik<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --cik CIK             10-digit Central Index Key<br/>
  --directory DIRECTORY<br/>
                        directory to store the output<br/>
  --file FILE           json file to process<br/>
<br/>
## edgarquery<br/>
<br/>
## edgarsubmissionsziptocsv<br/>
<br/>
usage: edgarsubmissionsziptocsv [-h] [--zipfile ZIPFILE]<br/>
                                [--directory DIRECTORY] [--files FILES]<br/>
<br/>
Extract one or more json files from an SEC EDGAR submissions.zip file and<br/>
convert to CSV<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --zipfile ZIPFILE     submissions.zip file to process - required<br/>
  --directory DIRECTORY<br/>
                        where to deposit the output<br/>
  --files FILES         comma separated(no spaces) content file(s) to process<br/>
                        a subset of the files in the zip file<br/>
<br/>
## edgartickerstocsv<br/>
<br/>
usage: edgartickerstocsv [-h] [--directory DIRECTORY]<br/>
<br/>
collect EDGAR companyticker json files and convert them to csv<br/>
<br/>
options:<br/>
  -h, --help            show this help message and exit<br/>
  --directory DIRECTORY<br/>
                        where to deposit the fileѕ<br/>
<br/>
<br/>
