BRG API Documentation

Streaminfo

Get information about the specified stream
/api/streaminfo/{mountpoint}

Mountpoints:

  • stream
  • daydj
  • nightdj

JSON Output:

  • status
  • result
    • id
    • title
    • artist
    • listener
    • status
    • current_event
    • upvotes
    • downvotes

Tracks

Get Track by id
/api/track/{id}

JSON Output:

  • status
  • result
    • id
    • title
    • artist
    • upvotes
    • downvotes

AutoDj Tracks

Get list of tracks available on the autodj
/api/autodj/track/list

JSON Output:

  • status
  • result (array)
    • id
    • title
    • artist
Parameter Value Description
title string Limit data to tracks with the specified title (use percentages as placeholders)
artist string Limit data to tracks with the specified artist (use percentages as placeholders)

History

Get history of played songs
/api/history/{page}

JSON Output:

  • status
  • result (array)
    • id
    • title
    • artist
Parameter Value Description
date_played_start yyyy-mm-dd Limit history data to tracks played after the supplied date
date_played_end yyyy-mm-dd Limit history data to tracks played before the supplied date
time_played_start HH:ii:ss Limit history data to tracks played after the supplied time
time_played_end HH:ii:ss Limit history data to tracks played before the supplied time
title string Limit history data to tracks with the specified title (use percentages as placeholders)
artist string Limit history data to tracks with the specified artist (use percentages as placeholders)