https://github.com/itz-hyperz/oocradio-wrapper
An API wrapper for oocradio.com because I was bored...
https://github.com/itz-hyperz/oocradio-wrapper
node-module wrapper
Last synced: about 1 year ago
JSON representation
An API wrapper for oocradio.com because I was bored...
- Host: GitHub
- URL: https://github.com/itz-hyperz/oocradio-wrapper
- Owner: Itz-Hyperz
- Archived: true
- Created: 2023-03-18T06:17:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-18T22:03:50.000Z (about 3 years ago)
- Last Synced: 2025-02-23T03:46:10.942Z (over 1 year ago)
- Topics: node-module, wrapper
- Language: JavaScript
- Homepage: https://oocradio.com/
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# oocradio-wrapper
An API wrapper for oocradio.com because I was bored...
# Examples
## Getting Setup
```js
const OOCRadio = require('./index.js')
const oocradio = new OOCRadio({ version: '1.1' }) // Takes in the version of the api you want to use
```
## Get Current Song
```js
oocradio.getCurrentSong().then(data => console.log(data))
```
Returns
```json
{
"status": string,
"response": {
"Artist": string,
"Title": string,
"Cover": string/url,
}
}
```
## Get Next Live
```js
oocradio.nextLive().then(data => console.log(data))
```
Returns
```json
{
"status": string,
"response": {
"Name": string,
"Show_Name": string,
"Date": number,
"Artwork": string/url,
"Exists": boolean,
}
}
```
## Get Live Data
```js
oocradio.getLiveData().then(data => console.log(data))
```
Returns
```json
{
"status": string,
"response": {
"Artist": string,
"Title": string,
"Cover": string/url,
"OnAir_Name": string,
"OnAir_Artwork": string/url,
"Spotify_URL": string/url,
}
}
```
# Credits
- [@Hyperz](https://bosssoftware.net) *Writing this extremely simple wrapper.*
- [@Shawn E.](https://github.com/Shawn-E) *Rewriting to change to a constructor*