Kolada API client
Kolada API client provides access to standardized key performance indicators (KPI) concerning Swedish municipalities and organizational units.
🔗 For a detailed API description, please see github.com/Hypergene/kolada.
Getting started
npm install --save kolada
There are two main parts to the API metadata and actual data (see full API documentation).
Initialize
const Kolada = ;const kolada = ;
All methods uses fetch
under the hood
koladameta
If passed "impossible" arguments an exception will be raised (with detailed error messages)
koladadata// Error: when passing municipality or ou you need to pass kpi or year too.
ℹ️ The arguments: municipality
, ou
, kpi
and year
can either be strings or an array of strings.
Meta data
KPI(s)
koladameta // allkoladameta koladameta // all// title search string (automatically uri-encoded)koladameta
Municipalities
koladametakoladametakoladameta
Organizational Unit (OU)
koladameta
Data
Municipalities
koladadatakoladadatakoladadata
Organizational Unit (OU)
koladadata;koladadata;
See more examples in kitchen-sink.js
.
🔗 For detailed API documentation, see github.com/Hypergene/kolada.
Development
git clone https://github.com/buren/kolada
cd kolada
Install dependencies
npm install
Run kitchen sink (a.k.a the quasi test suite)
npm run kitchen-sink
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/buren/kolada.
License
The gem is available as open source under the terms of the MIT License.