Celestia Radio API v3 docs

1-CR api.md

Celestia Radio API v3

This document is for documenting the next generation of Celestia Radio's online API.

As of the start of development (2014-03-28), the documentation is incomplete and will change over time.

Methods

/api

Base of the API. It should provide a link to the homepage and API status.

/api/nowplaying

Gets Celestia Radio's currently playing song as well as history. Also serves as a way to get stream stats.

/api/nowplaying/current

Gets Celestia Radio's currently playing song and stream stats. play_history returns null.

/api/schedule

Gets Celestia Radio's current schedule. (What should we use? GCal?)

/api/status

Gets the stream server stats and current timestamp.

2-api-nowplaying response example.json

{
    "status": "success",
    "result": {
        "station": {
            "bitrate": 128,
            "name": "Celestia Radio",
            "description": "All pony, all the time!",
            "genre": "Pony",
            "url": "http:\/\/celestiaradio.com",
            "stream_status": true,
            "irc": "irc.canternet.org\/#CelestiaRadio",
            "twitter_url": "https:\/\/twitter.com\/celestiaradio",
            "web_url": "http:\/\/celestiaradio.com",
            "category": "audio"
        },
        "listeners": {
            "current": 21,
            "unique": 20,
            "peak": 52,
            "maximum": 250
        },
        "current_song": {
            "played_at": 1396402340,
            "song": {
                "artist": "Alex S.",
                "eqbeats": {
                    "artist_id": null,
                    "song_id": null
                },
                "text": "Alex S. - Trixie The Pony Troll [VIP]",
                "title": "Trixie The Pony Troll [VIP]"
            }
        },
        "song_history": [
            {
                "played_at": 1396402020,
                "song": {
                    "artist": "Poni1Kenobi",
                    "eqbeats": {
                        "artist_id": null,
                        "song_id": null
                    },
                    "text": "Poni1Kenobi - Colored Lights",
                    "title": "Colored Lights"
                }
            },
            {
                "played_at": 1396401856,
                "song": {
                    "artist": "RainbowCrash88",
                    "eqbeats": {
                        "artist_id": null,
                        "song_id": null
                    },
                    "text": "RainbowCrash88 - Twilight Sparkle Theme (Fade) (Fighting is Magic)",
                    "title": "Twilight Sparkle Theme (Fade) (Fighting is Magic)"
                }
            },
            {
                "played_at": 1396401830,
                "song": {
                    "artist": "Unknown",
                    "eqbeats": {
                        "artist_id": null,
                        "song_id": null
                    },
                    "text": "Unknown - Celestia Radio Donations short Sweeper",
                    "title": "Celestia Radio Donations short Sweeper"
                }
            },
            {
                "played_at": 1396401808,
                "song": {
                    "artist": "0neTr1ckP0ny",
                    "eqbeats": {
                        "artist_id": 344,
                        "song_id": 1330
                    },
                    "text": "0neTr1ckP0ny - Cupcake Song (Rock Remix)",
                    "title": "Cupcake Song (Rock Remix)"
                }
            },
            {
                "played_at": 1396401568,
                "song": {
                    "artist": "Aftermath",
                    "eqbeats": {
                        "artist_id": null,
                        "song_id": null
                    },
                    "text": "Aftermath - Apples to the Core",
                    "title": "Apples to the Core"
                }
            },
            {
                "played_at": 1396401396,
                "song": {
                    "artist": "RainbowCrash88",
                    "eqbeats": {
                        "artist_id": null,
                        "song_id": null
                    },
                    "text": "RainbowCrash88 - Rainbow Dashs Theme (MLP-Fighting Is Magic)",
                    "title": "Rainbow Dashs Theme (MLP-Fighting Is Magic)"
                }
            },
            {
                "played_at": 1396401385,
                "song": {
                    "artist": "Prison",
                    "eqbeats": {
                        "artist_id": null,
                        "song_id": null
                    },
                    "text": "Prison - Celestia Radio - Live From the Grand Galloping Gala (Sweeper)",
                    "title": "Celestia Radio - Live From the Grand Galloping Gala (Sweeper)"
                }
            },
            {
                "played_at": 1396401350,
                "song": {
                    "artist": "Unknown",
                    "eqbeats": {
                        "artist_id": null,
                        "song_id": null
                    },
                    "text": "Unknown - Loud Beats Silent Brit Sweeper",
                    "title": "Loud Beats Silent Brit Sweeper"
                }
            },
            {
                "played_at": 1396400968,
                "song": {
                    "artist": "AcoustiMandoBrony",
                    "eqbeats": {
                        "artist_id": null,
                        "song_id": null
                    },
                    "text": "AcoustiMandoBrony - Loyalty (Knife Pony Remix)",
                    "title": "Loyalty (Knife Pony Remix)"
                }
            }
        ]
    }
}