Skip to content

Commit

Permalink
Update README.md with additional information about the API and planne…
Browse files Browse the repository at this point in the history
…d features
  • Loading branch information
rubenselander committed Jan 15, 2024
1 parent e9de52b commit 652af75
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# PyKolada
A Python Wrapper for Kolada API
A Python wrapper for the statistical API Kolada.

## Overview

Expand Down Expand Up @@ -39,7 +39,6 @@ kpi_data = pykolada.get_kpi(id='some_id', title='some_title')


## Endpoints

- `kpi`
- `kpi_groups`
- `municipality`
Expand All @@ -51,4 +50,19 @@ kpi_data = pykolada.get_kpi(id='some_id', title='some_title')
Each endpoint supports different parameters for querying. Please refer to the documentation for detailed information.


## Documentation and Examples
<!-- ToDo: Add documentation and examples. -->

## Planned Features
- Optional caching of data.
- Support for outputting data in CSV format (currently only original JSON is supported).
- Usage of additional custom filters that can be applied after the data has been retrieved.
- Support for the from_date parameter (limiting results data published after a certain date).



## License
MIT License


---

0 comments on commit 652af75

Please sign in to comment.