An unofficial wrapper for the official Hunter.FM API, dependency-free.

Installation

Node.js 14.0.0 or newer is required.

npm install hunter.fm
yarn add hunter.fm
pnpm add hunter.fm

Example Usage

const getRadioStations = require('hunter.fm');

getRadioStations()
  .then(stations => {
    console.log(stations);
  })
  .catch(console.error);

Try it yourself

Handling the return

The function getRadioStations returns an array of radio stations, each having the following structure:

Property | Type | Description | Example :---: | :---: | --- | --- id | String | Radio station's ID | lofi hash | String | Radio station's Hash | jic321Sd-de2s3d7s-S12e24s1daw2 name | String | Radio station's name | O Canal Lofi description | String | Radio station's description | Perfeita para te auxiliar a manter o foco em casa ou no trabalho. Para relaxar enquanto se lê um livro ou espera o sono chegar. logo | String | Radio station's logo | https://cdn.hunter.fm/image/station/lo-fi.png thumbnail | Object | Radio station's thumbnail | thumbnail#lowQuality | String | Radio station's low quality thumbnail | https://cdn.hunter.fm/image/thumb/station/lo-fi-second/50x50ht.jpg thumbnail#mediumQuality | String | Radio station's medium quality thumbnail | https://cdn.hunter.fm/image/thumb/station/lo-fi-second/100x100ht.jpg thumbnail#highQuality | String | Radio station's high quality thumbnail | https://cdn.hunter.fm/image/thumb/station/lo-fi-second/200x200ht.jpg thumbnail#highestQuality | String | Radio station's highest quality thumbnail | https://cdn.hunter.fm/image/thumb/station/lo-fi-second/1000x1000ht.jpg palette | String[] | Radio station's color palette | [ "#FF3B27", "#04BAFB" ] streams | Object | Radio station's streams | streams#lowQuality | String | Radio station's low quality stream | https://live.hunter.fm/lofi_low streams#mediumQuality | String | Radio station's medium quality stream | https://live.hunter.fm/lofi_normal streams#highQuality | String | Radio station's high quality stream | https://live.hunter.fm/lofi_high streamsHLS | Object | Radio station's HLS streams | streams#lowQuality | String | Radio station's low quality HLS stream file | https://hls.hunter.fm/lofi/32.m3u8 streams#mediumQuality | String | Radio station's medium quality HLS stream file | https://hls.hunter.fm/lofi/64.m3u8 streams#highQuality | String | Radio station's high quality HLS stream file | https://hls.hunter.fm/lofi/192.m3u8 genres | String[] | Radio station's music genres | [ "Hip Hop", "Lofi", "Relax" ] previousSong | Object | Radio station's previous song | previousSong#name | String | Song's name | Comfort previousSong#thumbnail | Object | Song's thumbnail | previousSong#thumbnail#lowQuality | String | Song's low quality thumbnail | https://cdn.hunter.fm//image/thumb/music/p4irjjm9jzyp7972xtme4mzgnhwp9m/100x100ht.jpg previousSong#thumbnail#mediumQuality | String | Song's medium quality thumbnail | https://cdn.hunter.fm//image/thumb/music/p4irjjm9jzyp7972xtme4mzgnhwp9m/300x300ht.jpg previousSong#thumbnail#highQuality | String | Song's high quality thumbnail | https://cdn.hunter.fm//image/thumb/music/p4irjjm9jzyp7972xtme4mzgnhwp9m/1000x1000ht.jpg previousSong#singers | String[] | Song's singers | [ "Pandrezz" ] previousSong#feats | String[] or null | Song's feats | null previousSong#duration | Number | Song's duration in milliseconds | 128000 currentSong | Object | Radio station's current song | currentSong#name | String | Song's name | Coney Island currentSong#thumbnail | Object | Song's thumbnail | currentSong#thumbnail#lowQuality | String | Song's low quality thumbnail | https://cdn.hunter.fm//image/thumb/music/60o79xd4jzyhad283dcnkjg431epyh/100x100ht.jpg currentSong#thumbnail#mediumQuality | String | Song's medium quality thumbnail | https://cdn.hunter.fm//image/thumb/music/60o79xd4jzyhad283dcnkjg431epyh/300x300ht.jpg currentSong#thumbnail#highQuality | String | Song's high quality thumbnail | https://cdn.hunter.fm//image/thumb/music/60o79xd4jzyhad283dcnkjg431epyh/1000x1000ht.jpg currentSong#singers | String[] | Song's singers | [ "Frook" ] currentSong#feats | String[] or null | Song's feats | null currentSong#duration | Number | Song's duration in milliseconds | 109000 currentSong#startedAt | Date | Song's start date timestamp | 2021-09-14T17:01:49.334Z currentSong#endsAt | Date | Song's end date timestamp | 2021-09-14T17:04:07.334Z nextSong | Object | Radio station's next song | nextSong#name | String | Song's name | Your Favorite Place nextSong#thumbnail | Object | Song's thumbnail | nextSong#thumbnail#lowQuality | String | Song's low quality thumbnail | https://cdn.hunter.fm//image/thumb/music/uq5kif7ajzymmzvxjfrnes4o8agzyv/100x100ht.jpg nextSong#thumbnail#mediumQuality | String | Song's medium quality thumbnail | https://cdn.hunter.fm//image/thumb/music/uq5kif7ajzymmzvxjfrnes4o8agzyv/300x300ht.jpg nextSong#thumbnail#highQuality | String | Song's high quality thumbnail | https://cdn.hunter.fm//image/thumb/music/uq5kif7ajzymmzvxjfrnes4o8agzyv/1000x1000ht.jpg nextSong#singers | String[] | Song's singers | [ "Joey Pecoraro" ] nextSong#feats | String[] or null | Song's feats | null

Contributing

Before creating an issue, please ensure that it hasn't already been reported or suggested.

When submitting a new pull request, please make sure the code style/format used is the same as the one used in the original code.

License

Refer to the LICENSE file.