module async_api.py
🔗
function async_get_artist
🔗
async_get_artist(
mbid: str,
api_key: str = None,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.Artist]
Returns an artist for a given Musicbrainz MBID
https://api.setlist.fm/docs/1.0/resource__1.0_artist__mbid_.html
Args:
mbid
: a Musicbrainz MBID, e.g. 0bfba3d3-6a04-4779-bb0a-df07df5b0558api_key
: the setlist.fm api keyaccept
: content type for responseserialize
: defaults to False. if True, returns anArtist
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
**kwargs:
Returns:
Artist
if serialize is True, else httpx.Response
function async_get_artist_setlists
🔗
async_get_artist_setlists(
mbid: str,
p: int = 1,
api_key: str = None,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.ArtistSetListResponse]
Get a list of an artist's setlists
https://api.setlist.fm/docs/1.0/resource__1.0_artist__mbid__setlists.html
Args:
mbid
: a Musicbrainz MBID, e.g. 0bfba3d3-6a04-4779-bb0a-df07df5b0558p
: the number of the result pageapi_key
: the setlist.fm api keyaccept
: content type for responseserialize
: defaults to False. if True, returns anArtistSetListResponse
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
**kwargs:
Returns:
ArtistSetListResponse
if serialize is True, else httpx.Response
function async_get_city
🔗
async_get_city(
geoid: str,
api_key: str = None,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.City]
Get a city by its unique geoid
https://api.setlist.fm/docs/1.0/resource__1.0_city__geoId_.html
Args:
geoid
: the geoid of the city, e.g. 4930956api_key
: the setlist.fm api keyaccept
: content type for responseserialize
: defaults to False. if True, returns aCity
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
City
if serialize is True, else httpx.Response
function async_get_user
🔗
async_get_user(
user_id: str,
api_key: str = None,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.User]
Get a user by their userId
https://api.setlist.fm/docs/1.0/resource__1.0_user__userId_.html
Args:
user_id
: the user's userIdapi_key
: the setlist.fm api keyaccept
: content type for responseserialize
: defaults to False. if True, returns aUser
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
User
if serialize is True, else httpx.Response
function async_get_venue
🔗
async_get_venue(
venue_id: str,
api_key: str = None,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.Venue]
Get a venue by its venueId
https://api.setlist.fm/docs/1.0/resource__1.0_venue__venueId_.html
Args:
venue_id
: the venue's venueId, e.g. '6bd6ca6e'api_key
: the setlist.fm api keyaccept
: content type for responseserialize
: defaults to False. if True, returns aVenue
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
Venue
if serialize is True, else httpx.Response
function async_get_setlists_at_venue
🔗
async_get_setlists_at_venue(
venue_id: str,
p: int = None,
api_key: str = None,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.ArtistSetListResponse]
Get setlists for a specific venue
https://api.setlist.fm/docs/1.0/resource__1.0_venue__venueId__setlists.html
Args:
venue_id
: the venue's venueId, e.g. '6bd6ca6e'p
: the number of the result pageapi_key
: the setlist.fm api keyaccept
: content type for responseserialize
: defaults to False. if True, returns aArtistSetListResponse
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
ArtistSetListResponse
if serialize is True, else httpx.Response
function async_get_setlists_of_concerts_attended_by_user
🔗
async_get_setlists_of_concerts_attended_by_user(
user_id: str,
p: int = 1,
api_key: str = None,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.ArtistSetListResponse]
Get a list of setlists of concerts attended by a user
https://api.setlist.fm/docs/1.0/resource__1.0_user__userId__attended.html
Args:
user_id
: the user's userIdp
: the number of the result pageapi_key
: the setlist.fm api keyaccept
: content type for responseserialize
: defaults to False. if True, returns aArtistSetListResponse
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
ArtistSetListResponse
if serialize is True, else httpx.Response
function async_get_setlists_edited_by_user
🔗
async_get_setlists_edited_by_user(
user_id: str,
p: int = 1,
api_key: str = None,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.ArtistSetListResponse]
Get a list of setlists of concerts edited by a user
The list contains the current version, not the version edited.
https://api.setlist.fm/docs/1.0/resource__1.0_user__userId__attended.html
Args:
user_id
: the user's userIdp
: the number of the result pageapi_key
: the setlist.fm api keyaccept
: content type for responseserialize
: defaults to False. if True, returns aArtistSetListResponse
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
ArtistSetListResponse
if serialize is True, else httpx.Response
function async_search_artists
🔗
async_search_artists(
mbid: str = None,
name: str = None,
p: int = 1,
sort: setlist_fm_client.enums.Sort = <Sort.sort_name: 'sortName'>,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.ArtistSearchResponse]
Search for artists using their mbid or their name.
https://api.setlist.fm/docs/1.0/resource__1.0_async_searchartists.html
Args:
mbid
: mbid: a Musicbrainz MBID, e.g. 0bfba3d3-6a04-4779-bb0a-df07df5b0558name
: the artist's namep
: the number of the result pagesort
: the method in which to sort the result setaccept
: content type for responseapi_key
: the setlist.fm api keyserialize
: defaults to False. if True, returns aArtistSearchResponse
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
'ArtistSearchResponseif serialize is True, else
httpx.Response`
function async_search_cities
🔗
async_search_cities(
country: str = None,
name: str = None,
state: str = None,
state_code: str = None,
p: int = 1,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.CitiesSearchResponse]
Search for a city using various parameters
https://api.setlist.fm/docs/1.0/resource__1.0_async_searchcities.html
Args:
country
: the city's countryname
: the city's namestate
: the city's statestate_code
: the city's state codep
: the number of the result pageaccept
: content type for responseapi_key
: the setlist.fm api keyserialize
: defaults to False. if True, returns aCitySearchResponse
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
'CitySearchResponseif serialize is True, else
httpx.Response`
function async_search_countries
🔗
async_search_countries(
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.CountrySearchResponse]
Get a list of all supported countries
https://api.setlist.fm/docs/1.0/resource__1.0_async_searchcountries.html
Args:
accept
: content type for responseapi_key
: the setlist.fm api keyserialize
: defaults to False. if True, returns aCountrySearchResponse
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
'CountrySearchResponseif serialize is True, else
httpx.Response`
function async_search_venues
🔗
async_search_venues(
city_id: str = None,
city_name: str = None,
country: str = None,
state: str = None,
state_code: str = None,
p: int = 1,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.VenueSearchResponse]
Search for a venue using various parameters
https://api.setlist.fm/docs/1.0/resource__1.0_async_searchvenues.html
Args:
city_id
: the city's geoId, , e.g. '5128581'city_name
: the name of the city where the venue is locatedcountry
: the name of the country where the venue is locatedstate
: the name of the state where the venue is locatedstate_code
: the state code of the state where the venue is locatedp
: the number of the result pageaccept
: content type for responseapi_key
: the setlist.fm api keyserialize
: defaults to False. if True, returns aVenueSearchResponse
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
'VenueSearchResponseif serialize is True, else
httpx.Response`
function async_search_setlists
🔗
async_search_setlists(
artist_mbid: str = None,
artist_name: str = None,
city_id: str = None,
city_name: str = None,
country_code: str = None,
date: datetime.date = None,
last_updated: datetime.datetime = None,
state: str = None,
state_code: str = None,
tour_name: str = None,
venue_id: str = None,
venue_name: str = None,
year: Union[int, str] = None,
p: int = 1,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.ArtistSetListResponse]
Search for setlists using a variety of query params
https://api.setlist.fm/docs/1.0/resource__1.0_async_searchsetlists.html
Args:
artist_mbid
: the artist's Musicbrainz Identifierartist_name
: the artist's namecity_id
: the city's geoIdcity_name
: the name of the citycountry_code
: the country codedate
: the date of the eventlast_updated
: the datetime (UTC) when this setlist was last updated - either edited or reverted.state
: the statestate_code
: the state codetour_name
: the name of the tourvenue_id
: the venue idvenue_name
: the name of the venueyear
: the year of the eventp
: the number of the result pageaccept
: content type for responseapi_key
: the setlist.fm api keyserialize
: defaults to False. if True, returns aArtistSetListResponse
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
'ArtistSetListResponseif serialize is True, else
httpx.Response`
function async_get_setlist
🔗
async_get_setlist(
setlist_id: str,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.ArtistSetList]
Returns the current version of a setlist
If you pass the id of a setlist that got edited since you last accessed it, you'll get the current version.
https://api.setlist.fm/docs/1.0/resource__1.0_setlist__setlistId_.html
Args:
setlist_id
: the setlist's selistId, e.g. '63de4613'accept
: content type for responseapi_key
: the setlist.fm api keyserialize
: defaults to False. if True, returns aArtistSetList
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
'ArtistSetListif serialize is True, else
httpx.Response`
function async_get_setlist_by_version
🔗
async_get_setlist_by_version(
version_id: str,
accept: setlist_fm_client.enums.Accept = <Accept.json: 'application/json'>,
api_key: str = None,
serialize: bool = False,
**kwargs
) → Union[httpx.Response, setlist_fm_client.models.ArtistSetList]
Returns a setlist for the given versionId.
The setlist returned isn't necessarily the most recent version. E.g. if you pass the versionId of a setlist that got edited since you last accessed it, you'll get the same version as last time.
https://api.setlist.fm/docs/1.0/resource__1.0_setlist_version__versionId_.html
Args:
version_id
: the setlist's versionId, e.g. 'be1aaa0'accept
: content type for responseapi_key
: the setlist.fm api keyserialize
: defaults to False. if True, returns aArtistSetList
object**kwargs
: additional kwargs to pass down tohttpx.Client.get
Returns:
'ArtistSetListif serialize is True, else
httpx.Response`