pandora-api 1.0.3 | Documentation

pandora-api

1.0.3

Client ▸
- Instance members
- #rest
- #user
- #login
Client#ready
Client#debug
Art
RESTManager ▸
- Instance members
- #cookies
- #url
- #user
- #request
- #request
- #getCookieString
- #getCookieString
- #setCookies
- #getCSRFToken
- #authLogin
- #getStations
- #playlistGetFragment
- #forceActiveSession
Song ▸
- Instance members
- #client
- #station
- #userSeed
- #genres
- #monthlyListening
- #listeningTimestamp
- #shareURL
- #seed
- #canStartFromTrack
- #sharingAllowed
- #buyingAllowed
- #tiredAllowed
- #skipWithoutLimit
- #skippingAllowed
- #feedbackAllowed
- #composerName
- #artistSeoToken
- #albumSeoToken
- #compilation
- #amazonURL
- #itunesURL
- #featured
- #bookmarked
- #adUrls
- #title
- #id
- #trackType
- #pandoraId
- #token
- #identity
- #length
- #rating
- #gain
- #detailURL
- #trackSeoToken
- #audioURL
- #rights
- #audioEncoding
- #audioToken
- #audioReciptURL
- #audioSkipURL
- #artist
- #album
- #trackKey
Station ▸
- Instance members
- #client
- #id
- #name
- #factoryId
- #pandoraId
- #art
- #created
- #lastPlayed
- #isNew
- #deletingAllowed
- #renamingAllowed
- #editingAllowed
- #seedingAllowed
- #shared
- #transformingAllowed
- #isOnDemandEditorial
- #advertiser
- #suffleAllowed
- #autoSharingAllowed
- #advertisingKey
- #artistMessages
- #thumbprint
- #shuffle
- #genres
- #genreSponsorship
- #adGenre
- #antiTarget
- #initialSeed
- #adkv
- #creatorUsername
- #artId
- #getSongList
User ▸
- Instance members
- #client
- #token
- #id
- #email
- #username
- #explicit
- #birthYear
- #zip
- #gender
- #minor
- #private
- #emailOptOut
- #allowComments
- #notifyOnComment
- #notifyOnFollower
- #recieveArtistEmails
- #recieveAudioPromos
- #isNew
- #config
- #adkv
- #activeVxRewards
- #listenerToken
- #highQuality
- #seenTutorial
- #smartConversionAdUrl
- #smartConversionTimeoutMillis
- #smartConversionDisabled
- #stationCount
- #webClientVersion
- #placeholderImageURL
- #autoplay
- #kruxToken
- #stations
- #getStations
- #makeActive

Need help reading this?

Client

Represents the Pandora "client" and gives a reference to the user for all classes.

new Client()

Extends EventEmitter

Instance Members

▸ rest

The REST manager for this client.

rest

Type: RESTManager

▸ user

Represents the connection to the user's Pandora account. Determined after login.

user

Type: (User | null)

▸ login(username, password)

Parameters

username (string) The Pandora account's username.

password (string) The Pandora account's password.

Returns

Promise:

Client#ready

Emitted when the client successfully logs in to the Pandora API.

Client#ready

Client#debug

Emitted for debug information, especially on API requests.

Client#debug

Art

Type: Object

Properties

url (String) : The URL for this art.

size (number) : The size in pixels of this art.

RESTManager

Handles all REST requests related to the API.

new RESTManager(client: Client)

Parameters

client (Client) The client that runs the REST manager.

Instance Members

▸ cookies

The cookies for this REST manager.

Type: Object

▸ url

The Pandora Website URL

url

Type: String

▸ user

The user object gotten after login.

user

Type: (User | null)

▸ request(endpoint, options)

Requests the API.

request(endpoint: string, options: Object): Promise<Object>

Parameters

endpoint (string) The endpoint you want to request for.

options

(Object
            = {})

The Request options.

Name	Description
options.method `string` (default `'post'`)	The method you want the request to use.
options.query `Object`	An object indicating the different queries.
options.headers `Object`	An objects containing the headers you want to include.
options.content `Snekfetch.Data`	The body of the request
options.cookies `boolean` (default `true`)	Whether or not to include cookies with the request.
options.auth `boolean` (default `true`)	Whether ot not to include the authToken if RESTManager#user is defined.
options.raw `boolean` (default `false`)	Set to true if you want to get the raw result from snekfetch, instead of attempting to parse it.

Returns

Promise<Object>: The request response in JSON unless raw was defined.

▸ request(endpoint, options)

Util

request(endpoint: any, options: any)

Parameters

endpoint (any)

options

(any
            = {})

▸ getCookieString()

getCookieString()

▸ getCookieString()

Get the HTTP-serialized cookie string.

getCookieString(): String

Returns

String:

▸ setCookies(header)

Set the cookies from the HTTP-set-cookie header.

setCookies(header: Array<String>): Object

Parameters

header (Array<String>) An array of strings from the header.

Returns

Object:

▸ getCSRFToken()

Methods

getCSRFToken()

▸ authLogin(username, password)

Calls the auth/login endpoint.

authLogin(username: String, password: String): Promise<Object>

Parameters

username (String) The username.

password (String) The password.

Returns

Promise<Object>:

▸ getStations(options)

Gets a list of stations.

getStations(options: Object)

Parameters

options

(Object
            = {})

Name	Description
options.pageSize `number`	How big each page is.

▸ playlistGetFragment(stationId, isStationStart, options)

Calls the playlist/getFragment endpoint.

playlistGetFragment(stationId: String, isStationStart: boolean, options: Object): Promise<Object>

Parameters

stationId (String) The station id.

isStationStart (boolean) Should be set to true if you're starting the station for the first time.

options

(Object
            = {})

Name	Description
options.audioFormat `string`	The audio format to use. Current types are unknown.
options.fragmentRequestReason `string`	Should be "Normal", other reasons currently unknown.

Returns

Promise<Object>:

▸ forceActiveSession(options)

Forces this client-session to be the active listener.

forceActiveSession(options: any)

Parameters

options

(any
            = {})

Song

Represents a Pandora Song.

new Song(client: Client, station: Station, raw: Object)

Parameters

client (Client) The client that initiated this song.

station (Station) The station that initiated this song.

raw (Object) The raw data from the API.

Instance Members

▸ client

The client that initiated this song.

client

Type: Client

▸ station

The station that initiated this song.

station

Type: Station

▸ userSeed

The user seed for this song.

userSeed

Type: string

▸ genres

The genre(s) for this song.

genres

Type: Array<string>

▸ monthlyListening

Monthly listening. (?)

monthlyListening

Type: number

▸ listeningTimestamp

Listening timestamp. (?)

listeningTimestamp

Type: string

▸ shareURL

The URL used for sharing this song.

shareURL

Type: string

▸ seed

Is seed. (?)

seed

Type: boolean

▸ canStartFromTrack

Whether or not this song allows starting the station from the track.

canStartFromTrack

Type: boolean

▸ sharingAllowed

Whether or not this song allows sharing.

sharingAllowed

Type: boolean

▸ buyingAllowed

Whether or not this song allows buying its track.

buyingAllowed

Type: boolean

▸ tiredAllowed

Whether or not this song allows the user to say they're "tired of it".

tiredAllowed

Type: boolean

▸ skipWithoutLimit

Whether or not this song allows skipping without limits.

skipWithoutLimit

Type: boolean

▸ skippingAllowed

Whether or not this song allows skipping at all.

skippingAllowed

Type: boolean

▸ feedbackAllowed

Whether or not this song allows feedback.

feedbackAllowed

Type: boolean

▸ composerName

The composer name for this song.

composerName

Type: string

▸ artistSeoToken

The SEO token for the artist of this song.

artistSeoToken

Type: string

▸ albumSeoToken

The SEO token for the album of this song.

albumSeoToken

Type: string

▸ compilation

Whether or not this song is a compilation of other songs.

compilation

Type: boolean

▸ amazonURL

The Amazon URL for this song.

amazonURL

Type: string

▸ itunesURL

The ITunes URL for this song.

itunesURL

Type: string

▸ featured

Whether or not this is a featured song.

featured

Type: boolean

▸ bookmarked

Whether or not this is a bookmarked song.

bookmarked

Type: boolean

▸ adUrls

The URLs for the ads attributed to this song.

adUrls

Properties

flexSkip (string) : The ad used if the user wants to gain more skips.

flexReplay (string) : The ad used if the user wants to gain more replays.

flexThumbsDown (string) : The ad used if the user wants to skip using a thumbs down.

nowPlayingStation (string) : The ad used for now playing songs.

nowPlayingStationAdUnit (string) : The nowplaying ad unit. (?)

nowPlayingStationAdTargeting (string) : The nowplaying ad 'targeting'. (?)

backstage (string) : The "backstage" ad. (?)

backstageAdUnit (string) : The "backstage" ad unit. (?)

backstageAdTargeting (string) : The "backstage" ad targeting. (?)

▸ title

The title for this song.

title

Type: string

▸ id

The music ID for this song.

Type: string

▸ trackType

The track type for this song. (?)

trackType

Type: string

▸ pandoraId

The internal pandora ID for this song.

pandoraId

Type: string

▸ token

This song's token.

token

Type: string

▸ identity

This song's identity.

identity

Type: string

▸ length

The length of this song in seconds.

length

Type: number

▸ rating

The rating of this song (possibly internal?). (?)

rating

Type: number

▸ gain

How much gain is modified in the provided audio URL.

gain

Type: string

▸ detailURL

The URL for getting details about the song.

detailURL

Type: string

▸ trackSeoToken

The track's SEO token.

trackSeoToken

Type: string

▸ audioURL

The audio URL for this song.

audioURL

Type: string

▸ rights

The rights that this song. These should NEVER BE IGNORED.

rights

Type: Array<string>

▸ audioEncoding

The audio encoding for the provided audio URL.

audioEncoding

Type: string

▸ audioToken

The token id for the provided audio URL.

audioToken

Type: string

▸ audioReciptURL

The recipt URL for the provided audio URL. (?)

audioReciptURL

Type: string

▸ audioSkipURL

The skip URL for the provided audio URL. (?)

audioSkipURL

Type: string

▸ artist

The artist of this song.

artist

Properties

name (string) : The name of the artist of this song.

musicId (string) : The ID of the artist's music. (?)

art (Array<Art>) : The art for the artist.

detailURL (string) : The URL used for getting details about the artist.

▸ album

The album for this song.

album

Properties

title (string) : The title of this song's album.

art (Array<Art>) : The art for this album.

detailURL (string) : The detail URL for getting information about this song's album.

▸ trackKey

The song's track key.

trackKey

Properties

trackId (string) : The track ID. (?)

trackType (string) : The track type. (?)

spinId (string) : The spin id. (?)

Station

Represents a Pandora Station.

new Station(client: Client, raw: Object)

Parameters

client (Client) The client that initiated this station.

raw (Object) The raw data from the API.

Instance Members

▸ client

The client that initiated this station.

client

Type: Client

▸ id

This station's ID.

Type: string

▸ name

This station's name.

name

Type: string

▸ factoryId

The internal Factory Pandora ID.

factoryId

Type: string

▸ pandoraId

This internal Pandora ID.

pandoraId

Type: string

▸ art

The station art.

art

Type: Array<Art>

▸ created

The date this station was created.

created

Type: date

▸ lastPlayed

The date this station was last played.

lastPlayed

Type: date

▸ isNew

Whether or not this is a new station.

isNew

Type: boolean

▸ deletingAllowed

Whether or not the user is allowed to delete this station.

deletingAllowed

Type: boolean

▸ renamingAllowed

Whether or not the user is allowed to rename this station.

renamingAllowed

Type: boolean

▸ editingAllowed

Whether or not the user is allowed to set the description of this station.

editingAllowed

Type: boolean

▸ seedingAllowed

Whether or not the user is allowed to add a seed to this station.

seedingAllowed

Type: boolean

▸ shared

Whether or not this station is shared with other people.

shared

Type: boolean

▸ transformingAllowed

Whether or nor the user is allowed to transform this station.

transformingAllowed

Type: boolean

▸ isOnDemandEditorial

Whether or not this station is on demand for editorials. (?)

isOnDemandEditorial

Type: boolean

▸ advertiser

Whether or not this station is for advertisers. (?)

advertiser

Type: boolean

▸ suffleAllowed

Whether or not the user is allowed to shuffle this station.

suffleAllowed

Type: boolean

▸ autoSharingAllowed

Whether or not the user is allowed to automatically share this station. (?)

autoSharingAllowed

Type: boolean

▸ advertisingKey

The advertising key for this station.

advertisingKey

Type: string

▸ artistMessages

Whether or not artist audio messages are enabled for this station.

artistMessages

Type: boolean

▸ thumbprint

Whether or not this station is the user's thumbprint radio.

thumbprint

Type: boolean

▸ shuffle

Whether or not this station is on shuffle mode. (?)

shuffle

Type: boolean

▸ genres

The genre(s) that this station is classified under.

genres

Type: Array<string>

▸ genreSponsorship

The sponsorship for this genre. (?)

genreSponsorship

Type: string

▸ adGenre

The genre for the advertisements. (?)

adGenre

Type: string

▸ antiTarget

(?)

antiTarget

Type: boolean

▸ initialSeed

The initial seed for this station.

initialSeed

Properties

musicId (string) : The music id for this seed. (?)

pandoraId (string) : The pandora id for this seed.

▸ adkv

Look, adkv is back. For all your adkv needs.

adkv

Properties

artist (string) : The artist for this adkv.

genre (string) : The genre for this adkv.

clean (string) : Whether or not this adkv is clean. (?)

gcat (string) : Green Cats. Maybe? No? (?)

▸ creatorUsername

The username of the user who made this station.

creatorUsername

Type: string

▸ artId

The ID for the art of this station.

artId

Type: string

▸ getSongList(isStationStart, options)

Returns a list of songs to play.

getSongList(isStationStart: boolean, options: Object): Promise<Array<Song>>

Parameters

isStationStart (boolean) Whether or not this is the first time requested for songs from this station.

options

(Object
            = {})

Name	Description
options.audioFormat `string`	The audioURL return format.

Returns

Promise<Array<Song>>:

User

Represents the user that is logged in.

new User(client: Client, raw: Object)

Parameters

client (Client) The client that initiated this user.

raw (Object) The raw data from the API.

Instance Members

▸ client

The client that initiated this user.

client

Type: Client

▸ token

The token used for future requests.

token

Type: string

▸ id

The user's ID.

Type: string

▸ email

The email for this user.

Type: string

▸ username

The username for this user.

username

Type: string

▸ explicit

Whether or not this user allows explicit content.

explicit

Type: boolean

▸ birthYear

The user account's birth year.

birthYear

Type: number

▸ zip

The user account's zip code. (Presumably estimated.)

zip

Type: string

▸ gender

The user's gender.

gender

Type: string

▸ minor

Presumably whether or not the user is under 13.

minor

Type: boolean

▸ private

Whether or not this user's profile is private.

private

Type: boolean

▸ emailOptOut

Tells if the user has opted out of Pandora's emails.

emailOptOut

Type: boolean

▸ allowComments

Whether or not this profile allows comments.

allowComments

Type: boolean

▸ notifyOnComment

Whether or not the user recieves notifications on new comments.

notifyOnComment

Type: boolean

▸ notifyOnFollower

Whether or not the user recieves notifications on a new follower.

notifyOnFollower

Type: boolean

▸ recieveArtistEmails

Whether or not the user has promo emails enabled for artists.

recieveArtistEmails

Type: boolean

▸ recieveAudioPromos

Whether or not the user will recieve audio promos for artists.

recieveAudioPromos

Type: boolean

▸ isNew

Whether or not this is a new account.

isNew

Type: boolean

▸ config

This user's custom configuration.

config

Properties

branding (string) : What type of branding to use for Pandora.

dailySkipLimit (number) : How many skips the user gets per day.

stationSkipLimit (number) : How many skips the user gets per station.

inactivityTimeout (number) : How long it takes for the user to timeout when no activity is detected.

experiments (Array<number>) : I'm not exactly sure what this is for.

flags (Array<string>) : Other options that may or may not be attributed to if the user is a Pandora Premium subscriber.

monthlyListeningCapHours (number) : Not exactly sure. I guess the amount of hours until you can't listen anymore per month?

▸ adkv

Okay, now the variable names are just getting weird. I have no idea what this one does or means.

adkv

Type: Object

▸ activeVxRewards

Active VX Rewards?

activeVxRewards

Type: Array

▸ listenerToken

The pandora listener token.

listenerToken

Type: string

▸ highQuality

Whether or not this user uses high quality audio files or not.

highQuality

Type: boolean

▸ seenTutorial

Assumingly, this indicates whether the user has seen the intro tutorial that Pandora provides.

seenTutorial

Type: boolean

▸ smartConversionAdUrl

Smart conversion ad URL.

smartConversionAdUrl

Type: string

▸ smartConversionTimeoutMillis

I have no idea what smart conversion is, but here's a timeout for it.

smartConversionTimeoutMillis

Type: number

▸ smartConversionDisabled

Whether or not smart conversion is disabled.

smartConversionDisabled

Type: boolean

▸ stationCount

How many stations this user has.

stationCount

Type: number

▸ webClientVersion

What web client the user last used, I assume.

webClientVersion

Type: string

▸ placeholderImageURL

The placeholder image for this account, if the user does not have an avatar.

placeholderImageURL

Type: string

▸ autoplay

Whether or not autoplay is enabled for playlists.

autoplay

Type: boolean

▸ kruxToken

A kruxToken. For all your kruxing needs.

kruxToken

Type: string

▸ stations

A list of this user's stations.

stations

Type: Map<string, Station>

▸ getStations()

Reset and get the list of stations from the user.

getStations(): Promise<Map<string, Station>>

Returns

Promise<Map<string, Station>>:

▸ makeActive()

Make this session the active listener since Pandora cannot allow more than one listener on an account at a time.

makeActive(): undefined

Returns

undefined: