filings.xbrl.org API

The filings in filings.xbrl.org can be accessed via a public API.

Using the API

The API follows the JSON API standard. The API is accessible at https://filings.xbrl.org/api.

The API provides the following resources:

Pagination

Results are paginated. Links to other pages within the results are included in the links object within the response. Pagination can be controlled with query parameters:

Including referenced resources

It is often useful to include entity information when retrieving filings. This can be done by specifying a query parameter of ?include=entity.

Filtering

Results can be filtered on attributes of the resource. For example, https://filings.xbrl.org/api/filings?filter[country]=GB will retrieve filings with a country of GB.

It is also possible to construct more complex filters. The syntax for this is described in the documentation for the API library used by filings.xbrl.org.

Sorting

Results can be sorted by specifying a sort query parameter.

If you are looking to obtain the most recent filings, specify a parameter of ?sort=-processed.

Usage

Access to the API is provided free of charge, but we reserve the right to alter the API at any time, including applying rate limits or withdrawing it completely.

If you are making regular use of the API, it is strongly recommended to join the mailing list.