Skip to content
Sinatra app for parsing XBRL discoverable taxonomy sets and returning json
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dts_assets
lib
test
.gitignore
.travis.yml
Dockerfile
Gemfile
Gemfile.lock
LICENSE
README.md
app.rb
config.ru
docker-compose.yml
dts_explorer
rakefile
routes.rb

README.md

Build Status Maintainability Test Coverage

Taxonomy Parser

This is a sinatra app that parses static DTS assets and exposes their contents as a restful API.

DTS assets (Discoverable Taxonomy Set) are collections of xml files that together document financial systems in the XBRL language, e.g. UK, Irish, US GAAP or IFRS.

A client app would consume this api in order to facilitate tagging or validation of a set of financial statements.

You can find an example of a client app here.

Included taxonomies

  • UK 2012 GAAP
  • Irish extension UK 2012 GAAP
  • FRS 101 (planned)
  • FRS 102 (planned)

To add another taxonomy simply place it in a new folder in the dts_assets directory.

To add an extension include the parent DTS within the extension's folder.

In theory the parsing rules should hold true for all DTS but in practice there are significant differences in how DTS are implemented apropos different reporting regimes - this is now being standardized in newer taxonomies.

Jsonapi

The request / response data specification is jsonapi.

Go here for documentation on how to structure requests for resources.

The actual endpoints are defined in app.rb.

Running the server

docker-compose up

Running the tests

docker-compose run api bundle exec rake test
You can’t perform that action at this time.