edgarquery 0.0.48

Downloads various SEC EDGAR files converting many to CSV files

EDGARquery

Table of Contents

• Installation

pip install edgarquery

• License edgarquery is distributed under the terms of the MIT license.

-[Usage]

EQODIR - the location to store the output
EQEMAIL - required by the SEC to download some of the files with curl.
used as the user-agent in the url request by the scripts.

edgarquery

usage: edgarquery [-h] [--cik CIK] [--cy CY] [--frame FRAME] [--units UNITS]
[--fact FACT] [--directory DIRECTORY] [--file FILE]
[--companyconcept] [--companyfacts] [--xbrlframes]
[--companyfactsarchivezip] [--submissionszip]
[--financialstatementandnotesdataset]

query SEC EDGAR site NOTE thæt EQEMAIL env variable is required and must
contain a valid User-Agent such as your email address

options:
-h, --help show this help message and exit
--cik CIK 10-digit Central Index Key
--cy CY calendar year e.g. CY2023, CY2023Q1, CY2023Q4I
--frame FRAME reporting frame e.g us-gaap, ifrs-full, dei, srt
--units UNITS USD or shares
--fact FACT fact to collect e.g AccountsPayableCurrent, USD-per-
shares
--directory DIRECTORY
directory to store the output
--file FILE file in which to store the output argument allowed for
each query type if --directory is not provided, it
should be the full path
--companyconcept returns all the XBRL disclosures from a single company
--cik required --frame - default us-gaap --fact -
default USD-per-shares
--companyfacts aggregates one fact for each reporting entity that is
last filed that most closely fits the calendrical
period requested --cik required
--xbrlframes returns all the company concepts data for a CIK --cy
required
--companyfactsarchivezip
returns daily companyfacts index in a zip file
--submissionszip returns daily index of submissions in a zip file
--financialstatementandnotesdataset
returns zip file with financial statement and notes
summaries --cy required

edgarsubmissions

usage: edgarsubmissions [-h] --cik CIK [--year YEAR] [--file FILE]
[--directory DIRECTORY]

find the most recent submissions for cik

options:
-h, --help show this help message and exit
--cik CIK 10-digit Central Index Key
--year YEAR year to search for submissions if not current year
--file FILE store the output in this file
--directory DIRECTORY
store the output in this directory

edgarxbrlframestocsv

usage: edgarxbrlframestocsv [-h] --file FILE [--directory DIRECTORY]

Parse an SEC EDGAR xbrlframes json file after it has been altered to deal with
its multipart character and generate a csv file from its contents

options:
-h, --help show this help message and exit
--file FILE xbrl frames json file to process
--directory DIRECTORY
where to deposit the output

edgarcompanyconcepttocsv

usage: edgarcompanyconcepttocsv [-h] --file FILE [--directory DIRECTORY]

Parse an SEC EDGAR companyconcepts json file after it has been altered to deal
with its multipart character and generate a csv file from its contents

options:
-h, --help show this help message and exit
--file FILE json file to process
--directory DIRECTORY
where to deposit the fileѕ

edgarcompanyfactstocsv

usage: edgarcompanyfactstocsv [-h] --file FILE [--directory DIRECTORY]

Parse an SEC EDGAR companyfacts json file after it has been altered to deal
with its multipart character and generate CSV files from its content

options:
-h, --help show this help message and exit
--file FILE json file to process
--directory DIRECTORY
where to deposit the csv fileѕ

edgarcompanyfactsziptocsv

usage: edgarcompanyfactsziptocsv [-h] --zipfile ZIPFILE
[--directory DIRECTORY] [--files FILES]

Extract one or more json files from an SEC EDGAR companyfacts.zip file and
convert to CSV

options:
-h, --help show this help message and exit
--zipfile ZIPFILE submissions.zip file to process. Іt can be downloadæd
with edgarquery.query
--directory DIRECTORY
where to deposit the output
--files FILES comma separated(no spaces) content file(s) to process
a subset of the files in the zip file

edgarlatest10K

usage: edgarlatest10K [-h] --cik CIK [--link] [--directory DIRECTORY]

find the most recent 10-K for cik

options:
-h, --help show this help message and exit
--cik CIK 10-digit Central Index Key
--link return the url for the latest 10-K
--directory DIRECTORY
directory to store the output

edgarlatestsubmissions

usage: edgarlatestsubmissions [-h] --cik CIK [--directory DIRECTORY]
[--file FILE]

find the most recent submissions for cik

options:
-h, --help show this help message and exit
--cik CIK 10-digit Central Index Key
--directory DIRECTORY
directory to store the output
--file FILE json file to process

edgarsubmissionsziptocsv

usage: edgarsubmissionsziptocsv [-h] [--zipfile ZIPFILE]
[--directory DIRECTORY] [--files FILES]

Extract one or more json files from an SEC EDGAR submissions.zip file and
convert to CSV

options:
-h, --help show this help message and exit
--zipfile ZIPFILE submissions.zip file to process - required
--directory DIRECTORY
where to deposit the output
--files FILES comma separated(no spaces) content file(s) to process
a subset of the files in the zip file

edgartickerstocsv

usage: edgartickerstocsv [-h] [--directory DIRECTORY]

collect EDGAR companyticker json files and convert them to csv

options:
-h, --help show this help message and exit
--directory DIRECTORY
where to deposit the fileѕ

cikperson

usage: cikperson [-h] [--cikpersondb CIKPERSONDB] [--file FILE]

extract CIK and person names from form345 zip files

options: -h, --help show this help message and exit --cikpersondb CIKPERSONDB full path to the sqlite3 database - default in memory --file FILE where to store the output - default stdout