Output formats

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).

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?aid=0001193125-15-267714&token=c3049752-4d35-43da-82a2-f89f1b06f7a4&format-indent=yes"

• xml: Outputs the result as an XML file.

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?aid=0001193125-15-267714&format=xml&token=c3049752-4d35-43da-82a2-f89f1b06f7a4&format-indent=yes"

• csv: Outputs the result as a table you can open in Excel or another spreadsheet software of your choice for further processing (pivot table, ...).

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?aid=0001193125-15-267714&format=csv&token=c3049752-4d35-43da-82a2-f89f1b06f7a4&format-indent=yes"

• 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.

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?aid=0001193125-15-267714&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4&format-indent=yes"

• 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.

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?aid=0001193125-15-267714&format=xbrl&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"

In most endpoints, the fields used for each result object are identical, that is, JSON and XML, when possible, flat.