A read-only API for XBRL.
XBRLAPI provides a free, open source Java implementation of an API that supports analysis of XBRL data sources, both taxonomies and the business reports that are based upon them. XBRLAPI is released under the lesser GPL license.
Installation suggestions are available to assist you with getting started with XBRLAPI.
Download the latest stable version of the XBRLAPI directly from Sourceforge.
Bleeding-edge versions of the binary JAR files are available from the SVN repository. If this list of JAR files is empty, that generally implies that the current stable distribution is up to date with the latest developments.
Forthcoming features are generally listed on Sourceforge You are welcome contribute new features to the existing list.
The XBRLAPI is supported by Galexy Pty. Limited. If you wish to support the work XBRLAPI project then please consider contributing expertise and/or time. Contribution suggestions include:
- Sponsorship of website hosting for an existing Java Web Application that showcases the capabilities of the XBRLAPI.
- Review of the API specification (requires a knowledge of the XBRL specification and an ability to read Javadoc web pages).
- Development of alternative data store implementations. XBRLAPI current allows for data stores implemented using:
- an in-memory XML DOM representation
- Oracle Berkeley DB XML running in embedded mode
- eXist running in embedded mode
- eXist running within a Java container
Xindice also used to be supported but with the data store querying being upgraded to use XQuery 1.0 rather than XPath 1.0, Xindice's lack of support for XQuery 1.0 has become a binding constraint.
The Java implementation guidelines are also explained in some detail.
The itself can be reviewed as a set of Java documentation webpages.
Latest news on XBRLAPI developments are available from Sourceforge.
The XBRLAPI has a number of important limitations. Before deciding to work with it, consider whether the following limitations will impact you work:
- The API does not support modification of XBRL data. More specifically, any creation or modification of XBRL taxonomies needs to be done to XBRL data that is not being exposed via the API. If you need to create XBRL content, consider the approach shown in the rendering example. It is fairly broadly applicable to a wide range if XBRL creation scenarios.
- The API does not currently support XBRL validation. This may change in the future, depending upon development priorities, but currently, XBRL validation is expected prior to loading into the store of data exposed via the XBRLAPI. Such validation would need to be done by third-party validation software.
The following list of commercial products are a sample of the products that may be address these limitations should you find that necessary.