Skip to content
This repository has been archived by the owner on Sep 20, 2024. It is now read-only.

Latest commit

 

History

History
36 lines (22 loc) · 2.1 KB

README.md

File metadata and controls

36 lines (22 loc) · 2.1 KB

EdgarRenderer

Deprecation Notice

Notice: The Arelle/EdgarRenderer repository has been deprecated and will no longer receive updates. Please use the Arelle/EDGAR repository instead for the latest SEC plugins.

EDGAR Renderer enables investors to view the interactive data filings submitted under the US Security and Exchange Commission (SEC) rules that require the use of XBRL via the SEC website.

EDGAR Renderer was created by staff of the U.S. Securities and Exchange Commission.

Data and content created by government employees within the scope of their employment are not subject to domestic copyright protection. 17 U.S.C. 105.

End user support is by e-mail direct to SEC at: [[email protected]] (mailto:[email protected]).

This is EDGAR release 23.4, planned for production December, 2023.

Developer issue management is by the Jira Edgar Renderer project: https://arelle.atlassian.net/projects/ER

To debug under eclipse, check this project out under arelle's plugin directory or soft link from EdgarRenderer to the Arelle project src/arelle/plugin directory, e.g., under MacOS/Linux: ln -s {path to here}/EdgarRenderer {path to arelle project}/src/arelle/plugin

To use this plugin securely without leaving any xbrl files on a server (such as a REST server, when processing SEC filings that represent non-public insider information) pass in a zip file as the input, and return a zip file as the output. The modifications to make EdgarRenderer into a plugin won't use any disk storage for such a session of EdgarRenderer. If installed as a localhost webserver or as a cgi-bin, then it could be run by REST interface:

curl -X POST "-HContent-type: application/zip"
     -T inputfiling.zip
     -o outresults.zip
     --logFile log.xml
     "http://localhost:8080/rest/xbrl/validation?efm-pragmatic&media=zip&plugins=EdgarRenderer"

(--logFile specifies a name for a log file to return inside the zip and whether .txt or .xml)

Further notes on usage are in the init.py module comments.