JSDoc: Class: SongKick

new SongKick(KEY)

Creates a new SongKick instance

Parameters:

Name	Type	Description
`KEY`	string	the SongKick API key

Source:

index.js, line 9

Methods

getArtistPastEvents(id, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves an artist's past events given the artist's id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		SongKick id of the artist
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 196

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getArtistPastEventsUsingMusicBrainz(id, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves an artist's past events given the artist's MusicBrainz id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		MusicBrainz id of the artist
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 209

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getArtistUpcomingEvents(id, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves the upcoming events of an artist given his/her SongKick id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		SongKick id of the artist
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 78

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getArtistUpcomingEventsUsingMusicBrainz(id, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves the upcoming events of an artist given his/her MusicBrainz id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		MusicBrainz id of the artist
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 91

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getEventDetails(id, dataTypeopt) → {Promise}

Retrieves the detials of an event given its SongKick id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		SongKick id of the event
`dataType`	String	<optional>	this can be either "json" or "xml" defaults to "json"

Source:

index.js, line 65

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getEventsSetList(id, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves an event's set list given the venue's id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		SongKick id of the venue
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 235

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getMetroAreaUpcomingEvents(id, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves a metro area's upcoming events of given the merto area's id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		SongKick id of the metro area
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 117

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getSimilarArtists(id, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves a list of similar artists given an artist id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		SongKick id of the artist
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 248

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getUserEvents(username, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves a user's events of tracked artists of a user.

Parameters:

Name	Type	Attributes	Description
`username`	Number		SongKick username of the user
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 183

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getUserPastEvents(username, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves a user's past events of tracked artists of a user.

Parameters:

Name	Type	Attributes	Description
`username`	Number		SongKick username of the user
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 170

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getUserUpcomingEvents(username, filter, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves a user's upcoming events of given the user's id.

Parameters:

Name	Type	Attributes	Description
`username`	Number		SongKick username of the user
`filter`	String		the data filter to use this can be either "attendance" or "tracked_artist"
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 131

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getUserUpcomingEventsAttendance(username, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves a user's upcoming events attendance of a user.

Parameters:

Name	Type	Attributes	Description
`username`	Number		SongKick username of the user
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 144

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getUserUpcomingTrackedArtist(username, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves a user's upcoming events of tracked artists of a user.

Parameters:

Name	Type	Attributes	Description
`username`	Number		SongKick username of the user
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 157

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getVenueDetails(id, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves the details of a given venue given its id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		SongKick id of the venue
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 222

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise

getVenueUpcomingEvents(id, dataTypeopt, createdAfteropt, pageopt, orderopt) → {Promise}

Retrieves a venue's upcoming events of given the venue's id.

Parameters:

Name	Type	Attributes	Description
`id`	Number		SongKick id of the venue
`dataType`	String	<optional>	can be either "json" or "xml" defaults to "json"
`createdAfter`	String	<optional>	a date to filter the results, this must be in this format "YYYY-MM-DDTHH:mm:iiZ" defaults to undefined
`page`	Number	<optional>	which page of the results to fetch, defaults to 0.
`order`	String	<optional>	the order in which the results should be sorted this can be either "asc" or "desc".

Source:

index.js, line 104

Returns:

a promise which will be resolved or rejected depending on the result of the request.

Type: Promise