{"id":28376961,"url":"https://github.com/bellingcat/edgar","last_synced_at":"2025-06-26T18:32:04.878Z","repository":{"id":203587849,"uuid":"709959354","full_name":"bellingcat/EDGAR","owner":"bellingcat","description":"Tool for the retrieval of corporate and financial data from the SEC","archived":false,"fork":false,"pushed_at":"2025-05-15T01:48:28.000Z","size":504,"stargazers_count":172,"open_issues_count":3,"forks_count":22,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-06-20T13:44:24.798Z","etag":null,"topics":["command-line","financial-data","open-source-research","python","securities-and-exchange-commission"],"latest_commit_sha":null,"homepage":"https://colab.research.google.com/github/bellingcat/EDGAR/blob/main/notebook/Bellingcat_EDGAR_Tool.ipynb","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bellingcat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-10-25T18:13:30.000Z","updated_at":"2025-06-04T10:04:09.000Z","dependencies_parsed_at":"2023-12-07T16:27:00.254Z","dependency_job_id":"13880b8c-22dc-4613-971c-25cf1b3e091f","html_url":"https://github.com/bellingcat/EDGAR","commit_stats":null,"previous_names":["georgedyer/edgar","bellingcat/edgar"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/bellingcat/EDGAR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bellingcat%2FEDGAR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bellingcat%2FEDGAR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bellingcat%2FEDGAR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bellingcat%2FEDGAR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bellingcat","download_url":"https://codeload.github.com/bellingcat/EDGAR/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bellingcat%2FEDGAR/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262122770,"owners_count":23262471,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","financial-data","open-source-research","python","securities-and-exchange-commission"],"created_at":"2025-05-30T00:38:46.623Z","updated_at":"2025-06-26T18:32:04.827Z","avatar_url":"https://github.com/bellingcat.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bellingcat/EDGAR\n\n\u003ca href=\"https://www.bellingcat.com\"\u003e\u003cimg alt=\"Bellingcat logo: Discover Bellingcat\" src=\"https://img.shields.io/badge/Discover%20Bellingcat-%20?style=for-the-badge\u0026logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAA4AAAAYCAYAAADKx8xXAAABhGlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AcxV9TS0UqDnZQEcxQneyiIo6likWwUNoKrTqYXPoFTRqSFBdHwbXg4Mdi1cHFWVcHV0EQ%2FABxdnBSdJES%2F5cUWsR4cNyPd%2Fced%2B8AoVllqtkTA1TNMtKJuJjLr4rBVwQwhhBEDEvM1JOZxSw8x9c9fHy9i%2FIs73N%2Fjn6lYDLAJxLHmG5YxBvEs5uWznmfOMzKkkJ8Tjxp0AWJH7kuu%2FzGueSwwDPDRjY9TxwmFktdLHcxKxsq8QxxRFE1yhdyLiuctzir1Tpr35O%2FMFTQVjJcpzmKBJaQRIo6klFHBVVYiNKqkWIiTftxD%2F%2BI40%2BRSyZXBYwcC6hBheT4wf%2Fgd7dmcXrKTQrFgcCLbX%2BMA8FdoNWw7e9j226dAP5n4Err%2BGtNYO6T9EZHixwBA9vAxXVHk%2FeAyx1g6EmXDMmR%2FDSFYhF4P6NvygODt0Dfmttbex%2BnD0CWulq%2BAQ4OgYkSZa97vLu3u7d%2Fz7T7%2BwHEU3LHAa%2FQ6gAAAAZiS0dEAAAAAAAA%2BUO7fwAAAAlwSFlzAAAuIwAALiMBeKU%2FdgAAAAd0SU1FB%2BgFHwwiMH4odB4AAAAZdEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIEdJTVBXgQ4XAAAA50lEQVQ4y82SvWpCQRCFz25ERSJiCNqlUiS1b5AuEEiZIq1NOsGXCKms0wXSp9T6dskDiFikyiPc%2FrMZyf3FXSGQ0%2BzuzPl2ZoeVKgQ0gQ2wBVpVHlcDkjM5V%2FJ5nag6sJ%2FZX%2Bh%2FC7gEhqeAFKf7p1M9aB3b5oN1OomB7g1axUBPBr3GQHODHmOgqUF3MZAzKI2d4LWBV4H%2BMXDuJd1a7Cew1k7SwksaHC4LqNaw7aeX9GWHXkC1G1sTAS17Y3Kk2lnp4wNLiz0DrgLq8qt2MfmSSabAO%2FBBXp26dtrADPjOmN%2BAUdG7B3cE61l5hOZiAAAAAElFTkSuQmCC\u0026logoColor=%23fff\u0026color=%23000\"\u003e\u003c/a\u003e\u003c!--\n--\u003e\u003ca href=\"https://discord.gg/bellingcat\"\u003e\u003cimg alt=\"Discord logo: Join our community\" src=\"https://img.shields.io/badge/Join%20our%20community-%20?style=for-the-badge\u0026logo=discord\u0026logoColor=%23fff\u0026color=%235865F2\"\u003e\u003c/a\u003e\u003c!--\n--\u003e\u003ca href=\"https://colab.research.google.com/github/bellingcat/EDGAR/blob/main/notebook/Bellingcat_EDGAR_Tool.ipynb\"\u003e\u003cimg alt=\"Colab icon: Try it on Colab\" src=\"https://img.shields.io/badge/Try%20it%20on%20Colab-%20?style=for-the-badge\u0026logo=googlecolab\u0026logoColor=fff\u0026logoSize=auto\u0026color=e8710a\"\u003e\u003c!--\n--\u003e\u003ca href=\"https://www.bellingcat.com/donate/\"\u003e\u003cimg alt=\"Bellingcat logo: Support Our Work\" src=\"https://img.shields.io/badge/Support%20Our%20Work-%20?style=for-the-badge\u0026logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAA4AAAAYCAYAAADKx8xXAAABhGlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AcxV9TS0UqDnZQEcxQneyiIo6likWwUNoKrTqYXPoFTRqSFBdHwbXg4Mdi1cHFWVcHV0EQ%2FABxdnBSdJES%2F5cUWsR4cNyPd%2Fced%2B8AoVllqtkTA1TNMtKJuJjLr4rBVwQwhhBEDEvM1JOZxSw8x9c9fHy9i%2FIs73N%2Fjn6lYDLAJxLHmG5YxBvEs5uWznmfOMzKkkJ8Tjxp0AWJH7kuu%2FzGueSwwDPDRjY9TxwmFktdLHcxKxsq8QxxRFE1yhdyLiuctzir1Tpr35O%2FMFTQVjJcpzmKBJaQRIo6klFHBVVYiNKqkWIiTftxD%2F%2BI40%2BRSyZXBYwcC6hBheT4wf%2Fgd7dmcXrKTQrFgcCLbX%2BMA8FdoNWw7e9j226dAP5n4Err%2BGtNYO6T9EZHixwBA9vAxXVHk%2FeAyx1g6EmXDMmR%2FDSFYhF4P6NvygODt0Dfmttbex%2BnD0CWulq%2BAQ4OgYkSZa97vLu3u7d%2Fz7T7%2BwHEU3LHAa%2FQ6gAAAAZiS0dEAAAAAAAA%2BUO7fwAAAAlwSFlzAAAuIwAALiMBeKU%2FdgAAAAd0SU1FB%2BgFHwwiMH4odB4AAAAZdEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIEdJTVBXgQ4XAAAA50lEQVQ4y82SvWpCQRCFz25ERSJiCNqlUiS1b5AuEEiZIq1NOsGXCKms0wXSp9T6dskDiFikyiPc%2FrMZyf3FXSGQ0%2BzuzPl2ZoeVKgQ0gQ2wBVpVHlcDkjM5V%2FJ5nag6sJ%2FZX%2Bh%2FC7gEhqeAFKf7p1M9aB3b5oN1OomB7g1axUBPBr3GQHODHmOgqUF3MZAzKI2d4LWBV4H%2BMXDuJd1a7Cew1k7SwksaHC4LqNaw7aeX9GWHXkC1G1sTAS17Y3Kk2lnp4wNLiz0DrgLq8qt2MfmSSabAO%2FBBXp26dtrADPjOmN%2BAUdG7B3cE61l5hOZiAAAAAElFTkSuQmCC\u0026logoColor=%23fff\u0026color=%23000\"\u003e\u003c/a\u003e\n\u003c/a\u003e\n\nThis is a command line interface to search and retrieve corporate and financial data\nfrom the United States Securities and Exchange Commission (SEC).\n\n## What is the SEC's EDGAR database?\n\nEDGAR is a database of corporate filings maintained by the SEC. These filings contain a\nwealth of quantitative and qualitative information on every legal entity that issues\nnon-exempt securities in the United States. Whether you are looking to study the\nfundamentals of your favorite stocks or to track the corporate webs weaved by a person\nor company of interest, EDGAR is the place to do it.\n\n## Installation 🪄\n\n[![PyPI - Version](https://img.shields.io/pypi/v/edgar-tool)](https://pypi.org/project/edgar-tool/)\n![versions](https://img.shields.io/pypi/pyversions/edgar-tool.svg)\n\nYou can install this tool directly from the\n[official PyPi release](https://pypi.org/project/edgar-tool/).\n\n```bash\npip install edgar-tool\n```\n\nThe CLI also supports autocompletion, which is **highly recommended**. You can install\nautocomplete for your shell by typing\n\n```bash\nedgar --install-completion\n```\n\nAutocomplete makes it really easy to use the CLI, since you only have to type the first\nfew characters of CLI commands, keyword arguments, or available values, followed by the\n`tab ↹` key to fill in the rest of the characters.\n\n## Usage - Text Search 🔎\n\n### What is the text search tool?\n\nIf you're interested in finding all the documents mentioning a certain person, company\nor phrase in the EDGAR database, you can do that via the\n[full text search page](https://www.sec.gov/edgar/search/#).\n\nIt isn't always easy to get the information you might need from the SEC, so this Python\ntool lets you download the search results to a file without having to go through all the\npages of results by hand.\n\nThis is a command line tool that takes a search query, queries the SEC's EDGAR database,\nand downloads the search results into a CSV file that can be opened in a spreadsheet\nprogram (such as Excel).\n\n### Examples\n\nDisplay help message describing all supported arguments along with their usage, aliases\nand eventual default values (type `q` to exit)\n\n```shell\nedgar text-search --help\n```\n\nBasic usage (defaults to searching the last 5 years of records)\n\n```shell\nedgar text-search John Doe\n```\n\nYou can wrap a phrase in quotes if you want an exact match. This works in both\nPOSIX-compliant shells (Linux/Bash) and Windows PowerShell environments.\n\nFor example, the following usage will search for the exact phrase `\"John Doe\"` and treat\n`Pharmaceuticals` and `Chemicals` as partial search parameters.\n\n```shell\nedgar text-search \"John Doe\" Pharmaceuticals Chemicals\n```\n\nUsage with date range and export to custom CSV file\n\n```shell\nedgar text-search Tsunami Hazards --start-date 2021-01-01 --end-date 2021-12-31 --output my_custom.csv\n```\n\n### Usage with filing category or single forms\n\n```shell\nedgar text-search Hurricane Damage --filing-category registration_statements\n```\n\n```shell\nedgar text-search Hurricane Damage --single-form 1-K --single-form 1-SA\n# or\nedgar text-search Hurricane Damage -sf 1-K -sf 1-SA\n```\n\nUsage specifying the location of incorporation. Note that `--incorporated-in` and\n`--principal-executive-offices-in` use\n[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) codes for\ncountries (like USA, CAN, GBR),\n[ISO_3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US) state codes (like NY, CA,\nIL), and [ISO_3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA) province/territory\ncodes (like AB, BC, NB).\n\n```shell\nedgar text-search oil --incorporated-in EGY\n# or\nedgar text-search oil -ii EGY\n```\n\nMore advanced usage specifying more arguments, with export to JSON or JSON Lines formats\n\n```shell\n# Simply specify the output file format suffix to .csv, .json, or .jsonl\nedgar text-search \"Marjorie Taylor Greene\" --output results.csv\n\nedgar text-search Volcano Monitoring --start-date 2021-01-01 --end-date 2021-12-31 \\\n    --output results.json --filing-category all_annual_quarterly_and_current_reports \\\n    --entity-id 0001030717\n\nedgar text-search Calabarzon --start-date 2021-01-01 -o results.jsonl \\\n    --filing-category all_annual_quarterly_and_current_reports \\\n    --max-results 100\n```\n\n### Detailed `edgar text-search` CLI usage\n\n\u003cdetails\u003e\n\u003csummary\u003eExpand to view detailed feature information\u003c/summary\u003e\n\n**Usage**:\n\n```console\n$ edgar text-search [OPTIONS] TEXT...\n```\n\n**Arguments**:\n\n- `TEXT...`: Search filings for a word or a list of words. A filing must contain all the\n  words to return. To search for an exact phrase, use double quotes, like \"fiduciary\n  product\". [required]\n\n**Options**:\n\n- `-o, --output TEXT`: Name of the output file to save results to. Accepts .csv, .json,\n  and .jsonl extensions. [default: edgar_search_results_20250315_200420.csv]\n- `--date-range [all|10y|5y|1y|30d]`: Date range of the search. Use 'all' to search all\n  records since 2001. [default: 5y]\n- `--start-date [%Y-%m-%d]`: Start date of the search in YYYY-MM-DD format (i.e.\n  2024-07-28).\n- `--end-date [%Y-%m-%d]`: End date of the search in YYYY-MM-DD format (i.e. 2024-07-28)\n  [default: 2025-03-15]\n- `--entity-id TEXT`: Company name, ticker, CIK number or individual's name.\n- `--filing-category [all|custom|all_except_section_16|all_annual_quarterly_and_current_reports|all_section_16|beneficial_ownership_reports|exempt_offerings|registration_statements|filing_review_correspondence|sec_orders_and_notices|proxy_materials|tender_offers_and_going_private_tx|trust_indentures]`:\n  Form group to search for. Use 'custom' or do not set if using `--single-form`/`-sf`.\n- `-sf, --single-form [1-A POS|1-A-W|1-A|1-E AD|1-K|1-SA|1-U|1-Z-W|1-Z|1|10-12B|10-12G|10-D|10-K|10-KT|10-Q|10-QT|11-K|13F-HR|13F-NT|13FCONP|144|15-12B|15-12G|15-15D|15F-12B|15F-12G|15F-15D|18-12B|18-K|19B-4E|2-A|20-F|20FR12B|20FR12G|24F-2NT|25-NSE|25|253G1|253G2|253G4|3|305B2|4|40-17F1|40-17F2|40-17G|40-202A|40-203A|40-206A|40-24B2|40-33|40-6B|40-8B25|40-APP|40-F|40-OIP|40FR12B|424A|424B1|424B2|424B3|424B4|424B5|424B7|424B8|424H|425|485APOS|485BPOS|485BXT|486APOS|486BPOS|486BXT|487|497|497AD|497H2|497J|497K|497VPI|497VPU|5|6-K|6B NTC|6B ORDR|8-A12B|8-A12G|8-K|8-K12B|8-K12G3|8-M|8F-2 NTC|8F-2 ORDR|ABS-15G|ABS-EE|ADV-E|ADV-H-C|ADV-H-T|ADV-NR|ANNLRPT|APP NTC|APP ORDR|APP WD|APP WDG|ARS|ATS-N-C|ATS-N|ATS-N/UA|AW WD|AW|C-AR-W|C-AR|C-TR-W|C-TR|C-U-W|C-U|C-W|C|CB|CERT|CERTARCA|CERTBATS|CERTCBO|CERTNAS|CERTNYS|CERTPAC|CFPORTAL|CORRESP|CT ORDER|D|DEF 14A|DEF 14C|DEFA14A|DEFA14C|DEFC14A|DEFM14A|DEFM14C|DEFN14A|DEFR14A|DEFR14C|DEL AM|DFAN14A|DFRN14A|DOS|DOSLTR|DRS|DRSLTR|DSTRBRPT|EFFECT|F-1|F-10|F-10EF|F-10POS|F-1MEF|F-3|F-3ASR|F-3D|F-4|F-4MEF|F-6 POS|F-6|F-6EF|F-7 POS|F-7|F-8|F-80|F-80POS|F-9 POS|F-9|F-N|F-X|FOCUSN|FWP|G-FIN|IRANNOTICE|MA-A|MA-I|MA-W|MA|MSD|MSDW|N-1|N-14 8C|N-14|N-14MEF|N-18F1|N-1A|N-2 POSASR|N-2|N-23C-2|N-23C3A|N-23C3B|N-2ASR|N-2MEF|N-30B-2|N-30D|N-4|N-5|N-54A|N-54C|N-6|N-6F|N-8A|N-8B-2|N-8F NTC|N-8F ORDR|N-8F|N-CEN|N-CR|N-CSR|N-CSRS|N-MFP|N-MFP1|N-MFP2|N-PX|N-Q|N-VP|N-VPFS|NO ACT|NPORT-EX|NPORT-NP|NPORT-P|NRSRO-CE|NRSRO-UPD|NSAR-A|NSAR-AT|NSAR-B|NSAR-BT|NSAR-U|NT 10-D|NT 10-K|NT 10-Q|NT 11-K|NT 20-F|NT N-CEN|NT N-MFP|NT N-MFP1|NT N-MFP2|NT NPORT-P|NT-NCEN|NT-NCSR|NT-NSAR|NTN 10D|NTN 10K|NTN 10Q|OIP NTC|OIP ORDR|POS 8C|POS AM|POS AMI|POS EX|POS462B|POS462C|POSASR|PRE 14A|PRE 14C|PREC14A|PREM14A|PREM14C|PREN14A|PRER14A|PRER14C|PRRN14A|PX14A6G|PX14A6N|QRTLYRPT|QUALIF|REG-NR|REVOKED|RW WD|RW|S-1|S-11|S-11MEF|S-1MEF|S-20|S-3|S-3ASR|S-3D|S-3DPOS|S-3MEF|S-4 POS|S-4|S-4EF|S-4MEF|S-6|S-8 POS|S-8|S-B|SBSE-A|SBSE-BD|SBSE-C|SBSE-W|SBSE|SC 13D|SC 13E3|SC 13G|SC 14D9|SC 14F1|SC 14N|SC TO-C|SC TO-I|SC TO-T|SC14D1F|SC14D9C|SC14D9F|SD|SE|SEC ACTION|SEC STAFF ACTION|SEC STAFF LETTER|SF-3|SL|STOP ORDER|SUPPL|T-3|TA-1|TA-2|TA-W|TACO|UNDER|UPLOAD|X-17A-5]`:\n  List of single forms to search for (e.g. `-sf 10-K -sf \"PRE 14A\"`)\n- `-peoi, --principal-executive-offices-in [AL|AK|AZ|AR|CA|CO|CT|DE|DC|FL|GA|HI|ID|IL|IN|IA|KS|KY|LA|ME|MD|MA|MI|MN|MS|MO|MT|NE|NV|NH|NJ|NM|NY|NC|ND|OH|OK|OR|PA|RI|SC|SD|TN|TX|UT|VT|VA|WA|WV|WI|WY|AB|BC|CAN|MB|NB|NL|NS|ON|PE|QC|SK|YT|AFG|ALA|ALB|DZA|ASM|AND|AGO|AIA|ATA|ATG|ARG|ARM|ABW|AUS|AUT|AZE|BHS|BHR|BGD|BRB|BLR|BEL|BLZ|BEN|BMU|BTN|BOL|BIH|BWA|BVT|BRA|IOT|BRN|BGR|BFA|BDI|KHM|CMR|CPV|CYM|CAF|TCD|CHL|CHN|CXR|CCK|COL|COM|COG|COD|COK|CRI|CIV|HRV|CUB|CYP|CZE|DNK|DJI|DMA|DOM|ECU|EGY|SLV|GNQ|ERI|EST|ETH|FLK|FRO|FJI|FIN|FRA|GUF|PYF|ATF|GAB|GMB|GEO|DEU|GHA|GIB|GRC|GRL|GRD|GLP|GUM|GTM|GGY|GIN|GNB|GUY|HTI|HMD|VAT|HND|HKG|HUN|ISL|IND|IDN|IRN|IRQ|IRL|IMN|ISR|ITA|JAM|JPN|JEY|JOR|KAZ|KEN|KIR|PRK|KOR|KWT|KGZ|LAO|LVA|LBN|LSO|LBR|LBY|LIE|LTU|LUX|MAC|MKD|MDG|MWI|MYS|MDV|MLI|MLT|MHL|MTQ|MRT|MUS|MYT|MEX|FSM|MDA|MCO|MNG|MNE|MSR|MAR|MOZ|MMR|NAM|NRU|NPL|NLD|ANT|NCL|NZL|NIC|NER|NGA|NIU|NFK|MNP|NOR|OMN|PAK|PLW|PSE|PAN|PNG|PRY|PER|PHL|PCN|POL|PRT|PRI|QAT|REU|ROU|RUS|RWA|BLM|SHN|KNA|LCA|MAF|SPM|VCT|WSM|SMR|STP|SAU|SEN|SRB|SYC|SLE|SGP|SVK|SVN|SLB|SOM|ZAF|SGS|ESP|LKA|SDN|SUR|SJM|SWZ|SWE|CHE|SYR|TWN|TJK|THA|TLS|TGO|TKL|TON|TTO|TUN|TUR|TKM|TCA|TUV|UGA|UKR|ARE|GBR|UMI|URY|UZB|VUT|VEN|VNM|VGB|VIR|WLF|ESH|YEM|ZMB|ZWE|XX]`:\n  Search for the primary location associated with a filing. The principal executive\n  office is where the company's top management operates and conducts key business\n  decisions. The location could be a US state or territory, a Canadian province, or a\n  country.\n- `-ii, --incorporated-in [AL|AK|AZ|AR|CA|CO|CT|DE|DC|FL|GA|HI|ID|IL|IN|IA|KS|KY|LA|ME|MD|MA|MI|MN|MS|MO|MT|NE|NV|NH|NJ|NM|NY|NC|ND|OH|OK|OR|PA|RI|SC|SD|TN|TX|UT|VT|VA|WA|WV|WI|WY|AB|BC|CAN|MB|NB|NL|NS|ON|PE|QC|SK|YT|AFG|ALA|ALB|DZA|ASM|AND|AGO|AIA|ATA|ATG|ARG|ARM|ABW|AUS|AUT|AZE|BHS|BHR|BGD|BRB|BLR|BEL|BLZ|BEN|BMU|BTN|BOL|BIH|BWA|BVT|BRA|IOT|BRN|BGR|BFA|BDI|KHM|CMR|CPV|CYM|CAF|TCD|CHL|CHN|CXR|CCK|COL|COM|COG|COD|COK|CRI|CIV|HRV|CUB|CYP|CZE|DNK|DJI|DMA|DOM|ECU|EGY|SLV|GNQ|ERI|EST|ETH|FLK|FRO|FJI|FIN|FRA|GUF|PYF|ATF|GAB|GMB|GEO|DEU|GHA|GIB|GRC|GRL|GRD|GLP|GUM|GTM|GGY|GIN|GNB|GUY|HTI|HMD|VAT|HND|HKG|HUN|ISL|IND|IDN|IRN|IRQ|IRL|IMN|ISR|ITA|JAM|JPN|JEY|JOR|KAZ|KEN|KIR|PRK|KOR|KWT|KGZ|LAO|LVA|LBN|LSO|LBR|LBY|LIE|LTU|LUX|MAC|MKD|MDG|MWI|MYS|MDV|MLI|MLT|MHL|MTQ|MRT|MUS|MYT|MEX|FSM|MDA|MCO|MNG|MNE|MSR|MAR|MOZ|MMR|NAM|NRU|NPL|NLD|ANT|NCL|NZL|NIC|NER|NGA|NIU|NFK|MNP|NOR|OMN|PAK|PLW|PSE|PAN|PNG|PRY|PER|PHL|PCN|POL|PRT|PRI|QAT|REU|ROU|RUS|RWA|BLM|SHN|KNA|LCA|MAF|SPM|VCT|WSM|SMR|STP|SAU|SEN|SRB|SYC|SLE|SGP|SVK|SVN|SLB|SOM|ZAF|SGS|ESP|LKA|SDN|SUR|SJM|SWZ|SWE|CHE|SYR|TWN|TJK|THA|TLS|TGO|TKL|TON|TTO|TUN|TUR|TKM|TCA|TUV|UGA|UKR|ARE|GBR|UMI|URY|UZB|VUT|VEN|VNM|VGB|VIR|WLF|ESH|YEM|ZMB|ZWE|XX]`:\n  Search for the primary location associated with a filing. Incorporated in refers to\n  the location where the company was legally formed and registered as a corporation. The\n  location could be a US state or territory, a Canadian province, or a country.\n- `-mr, --max-results INTEGER`: Maximum number of results to retrieve. If not provided,\n  all results will be retrieved.\n- `--help`: Show this message and exit.\n\n\u003c/details\u003e\n\n## Usage - RSS Feed 📰\n\n### What is the RSS feed customized retrieval tool ?\n\nThe SEC publishes a live feed of filings. This part of the tool lets you monitor\nparticular tickers for new filings, so you can get to-the-minute updates.\n\nThe output is a CSV file containing the company and filings' metadata, which can be\nopened in a spreadsheet program (such as Excel).\n\n### Examples\n\n```bash\n# Display help message describing all supported arguments along with their usage\nedgar rss --help\n\n# Basic one-off usage with export to CSV\nedgar rss GOOG --output rss_feed.csv\n\n# Periodic usage specifying 10 minutes interval duration, with export to JSON\nedgar rss AAPL GOOG MSFT --output rss_feed.json --every-n-mins 10\n\n# Same example as above, using aliases and exporting to JSONLines (.jsonl)\nedgar rss AAPL GOOG MSFT -o rss_feed.jsonl -e 10\n```\n\n### Detailed Feature Information\n\n\u003cdetails\u003e\n\u003csummary\u003eExpand to view detailed feature information\u003c/summary\u003e\n\n#### Companies CIK to Ticker mapping\n\nSince the RSS feed uses CIKs instead of tickers, the tool includes a mapping of CIKs to\ntickers, which is used to filter the feed by ticker. This mapping is obtained from the\n[SEC website](https://www.sec.gov/files/company_tickers.json) and is updated on user\nrequest.\n\n#### Periodic retrieval\n\nThe RSS feed data returns the last 200 filings and is updated every 10 minutes (which\ndoesn't mean all tickers are updated every 10 minutes). The tool can fetch the feed\neither once on-demand or at regular intervals.\n\n\u003c/details\u003e\n\n## Development 👨‍💻\n\n\u003cdetails\u003e\n\u003csummary\u003eExpand to view information for developers\u003c/summary\u003e\n\nThis section describes how to install the project to run it from source, for example if\nyou want to build new features.\n\n### Developing locally\n\n```bash\n# Clone the repository\ngit clone https://github.com/bellingcat/EDGAR.git\n\n# Change directory to the project folder\ncd EDGAR\n```\n\nThis project uses [Poetry](https://python-poetry.org/docs) for dependency management and\npackaging.\n\n```bash\n# Install Poetry if you haven't already\npip install poetry\n\n# Install dependencies\npoetry install\n\n# Set up pre-commit hooks to keep your code formatted\npoetry run pre-commit install\n```\n\nCheck out [Important commands](#important-commands) below for next steps.\n\n### Developing using a GitHub Codespace\n\nThis project uses a custom Development Container supported by GitHub Codespaces.\nCreating a new Codespace automatically takes care of installing all supported Python\ninterpreters, the Poetry package manager, Python dependencies, and pre-commit hooks for\nyou.\n\nTo create a new Codespace:\n\n1. Click on the `\u003c\u003e Code` dropdown on the GitHub UI.\n1. Click the `+` icon to create a new Codespace.\n\nThe Codespace will open for you automatically.\n\n![GitHub UI screenshot showing the buttons to click to create a new Codespace](docs/create_codespace.png)\n\nCheck out [Important commands](#important-commands) below for next steps.\n\n### Important commands\n\n```bash\n# Run the tool\npoetry run edgar-tool --help\n\n# Run unit tests using your Poetry environment's Python interpreter\npoetry run pytest\n\n# Run unit tests with tox\npoetry run tox -- run-parallel\n```\n\nYou can skip having to write `poetry run` before each command by activating Poetry's\nvirtual environment with `poetry shell`. Once activated the following code is equivalent\nto the above:\n\n```bash\n# Spawn shell within Poetry's virtual environment\npoetry shell\n\n# Run the tool\nedgar-tool --help\n\n# Run unit tests using your Poetry environment's Python interpreter\npytest\n\n# Run unit tests with tox\ntox run-parallel\n```\n\nThis is an actual example copy/pasted from a terminal:\n\n```console\n@edgar-dev ➜ /workspaces/EDGAR (main) $ pytest\nbash: pytest: command not found\n\n@edgar-dev ➜ /workspaces/EDGAR (main) $ poetry shell\nSpawning shell within /home/vscode/.cache/pypoetry/virtualenvs/edgar-tool-vrvn8V2D-py3.12\n(edgar-tool-py3.12) @edgar-dev ➜ /workspaces/EDGAR (main) $ pytest\n================= test session starts ==================\nplatform linux -- Python 3.12.4, pytest-8.3.1, pluggy-1.5.0\nrootdir: /workspaces/EDGAR\nconfigfile: pyproject.toml\ncollected 1 item\n\ntests/test_cli.py .                              [100%]\n\n================== 1 passed in 0.20s ===================\n(edgar-tool-py3.12) @edgar-dev ➜ /workspaces/EDGAR (main) $\n```\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbellingcat%2Fedgar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbellingcat%2Fedgar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbellingcat%2Fedgar/lists"}