On each endpoint, the format parameter lets you fine-tune the way you would like to get the output. This parameter can have five values on most endpoints:
- json (default): Outputs the result as a sequence of JSON objects. This sequence is wrapped in an array, the name of which depends on the endpoint (example: Archives for archives.jq).
[Public datalake] List filing as JSON
- xml: Outputs the result as an XML file.
[Public datalake] List filing as XML
- csv: Outputs the result as a table you can open in Excel or another spreadsheet software of your choice for further processing (pivot table, ...).
[Public datalake] List filing as CSV
- html: Outputs the result as an HTML page. This format is only intended for human users that want to quickly see what the result looks like and navigate through endpoints.
[Public datalake] List filing as HTML
- xbrl (only on the archives endpoint): Outputs the result as an xbrlx archive. It is a zip file containing an XBRL instance, taxonomy schemas and linkbases.
[Public datalake] List filing as XBRL
In most endpoints, the fields used for each result object are identical, that is, JSON and XML, when possible, flat.