diff --git a/README.md b/README.md index b346f45aaee319dcd038a9581b1d1ac1179bdd5f..420b230773a2274b6dd096201142bc88c86d3f98 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,8 @@ specifically build for the requirements of community radios. - Multichannel Line-out - Blank Detenction / Silence Detecter - Auto Pilot a.k.a. Fallback Handling +- API to query Track-Service +- API to query programme Read more on the [Engine Features](docs/engine-features.md) page. diff --git a/docs/engine-features.md b/docs/engine-features.md index 5959889705121183704c15da8500e7040b8a483f..2c68da0a59e104959031d97105e3a3c5f68dc9e4 100644 --- a/docs/engine-features.md +++ b/docs/engine-features.md @@ -49,3 +49,14 @@ fallback handling scenarios. The available fallbacks are evaluated in following 3.2 Station Fallback via local music folder Note: All filenames in the music folder should be ASCII encoded, otherwise this may cause engine failures. + +# Track-Service API + +The Track Service API provides following endpoints: + +* `/api/v1/` ............. Returns all Track Service entries for the last three hours +* `/api/v1/$ID` .......... Returns a Track Service entry by ID +* `/api/v1/current` ...... Returns the currently playing track +* `/api/v1/day/$DAY` ..... Returns the tracks for a given day formated as `YYYY-MM-DD` + +# Programme API \ No newline at end of file