All feeds can return any of the following formats, according to the extension used in the feed URI:
URI Extension | Response data format |
---|---|
json |
JSON. Can be decoded with PHP json_decode function. |
pc8 |
PHP variable dump. Must be decoded using PHP eval function. |
ps8 |
PHP serialized data. Can be decoded using PHP unserialize function. |
Token Short Code | Variable |
---|---|
af |
affcode |
ai |
artirstid |
cc |
connectcode |
ci |
connectid |
ct |
clientid |
dt |
date |
ev |
eventid |
fd |
startdate |
gt |
globaltype |
gu |
guest |
it |
itemid |
ky |
cypherkey |
li |
limit |
md |
media |
me |
memberid |
mi |
microsite |
mk |
marketareaid |
mt |
musictypeid |
nc |
nocache |
nd |
numdays |
nw |
numweeks |
of |
offset |
og |
originatorid |
or |
origin |
ot |
tipperc |
pc |
promocode |
pe |
pastevents |
rv |
reventid |
sa |
subaf |
so |
source |
sw |
startweekday |
td |
enddate |
us |
userid |
uv |
urvenueid |
ve |
venueid |
vi |
venueinfo |
vn |
venueid |
vt |
venuetypeid |
wb |
website |
Feed URI
Version 1:
/api/v1/venues/venues.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/venues/venues.[json|ps8|pc8]
Parameters
marketareaid
: Market area ID.venuetypeid
: Venue type ID.venuetypeids
: Venue type IDs.venueid
: Venue ID.urvenueid
: UrVenue IDvenueids
: List of venue IDs, separated by comma.urvenueids
: List of UrVenue IDs, separated by comma.All parameters are optional.
Feed URI
Version 1:
/api/v1/venues/venuerooms.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/venues/venuerooms.[json|ps8|pc8]
Parameters
This feed returns all the rooms in the system. If there are too many records, you can send a limit
and offset
for the query:
limit
: Numeric value for the LIMIT
clause in the query.offset
: Numeric value for the OFFSET
clause in the query.IMPORTANT: These two parameters are not required and should be used ONLY if there are too many records in the query.
Returns the information of all resident artists.
Feed URI
Version 1:
/api/v1/venues/residentartists.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/venues/residentartists.[json|ps8|pc8]
Parameters
marketareaid
: Market area ID.venuetypeid
: Venue type ID.venuetypeids
: Venue type IDs.venueid
: Venue ID.urvenueid
: UrVenue IDvenueids
: List of venue IDs, separated by comma.urvenueids
: List of UrVenue IDs, separated by comma.Use only one of the parameters.
Feed URI
Version 1:
/api/v1/events/events.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/events/events.[json|ps8|pc8]
Parameters
marketareaid
: Market area ID.startdate
: Start date.enddate
: End date.venuetypeid
: Venue type ID.eventtypeid
: Event type ID.musictypeid
: Music type ID.eventid
: Event ID.venueid
: Venue ID.urvenueid
: UrVenue ID.venueids
: List of venue IDs, separated by comma.urvenueids
: List of UrVenue IDs, separated by comma.artistid
: Artist ID.All parameters are optional. If no startdate
is set, it defaults to today. If no enddate
is set, it defaults to 1 month after startdate
for multiple venues and 3 months after startdate
for single venue.
Feed URI
Version 1:
/api/v1/events/calevents.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/events/calevents.[json|ps8|pc8]
Parameters
venueid
: Venue ID.urvenueid
: UrVenue ID.startdate
: Reference date to start the calendar. By default is set to today.numweeks
: Number of weeks to show in the calendar. Default is 6 weeks.startweekday
: Weekday to start the calendar. Can be any weekday (Monday
,Tuesday
,Wednesday
,Thursday
,Friday
,Saturday
,Sunday
). Default is Monday
.roomid
: Venue room ID.Either venueid
or urvenueid
is required. DO NOT USE BOTH.
Feed URI
Version 1:
/api/v1/events/multicalevents.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/events/multicalevents.[json|ps8|pc8]
Parameters
venueids
: Venue ID.urvenueids
: UrVenue ID.startdate
: Reference date to start the calendar. By default is set to today.numweeks
: Number of weeks to show in the calendar. Default is 6 weeks.startweekday
: Weekday to start the calendar. Can be any weekday (Monday
,Tuesday
,Wednesday
,Thursday
,Friday
,Saturday
,Sunday
). Default is Monday
.Either venueids
or urvenueids
is required. DO NOT USE BOTH.
Feed URI
Version 1:
/api/v1/events/uvcalevents.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/events/uvcalevents.[json|ps8|pc8]
Parameters
venueid
: Venue ID.urvenueid
: UrVenue IDstartdate
: Calendar start date.enddate
: Calendar end date.Either venueid
or urvenueid
is required. DO NOT USE BOTH.
Feed URI
Version 1:
/api/v1/events/eventdetails.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/events/eventdetails.[json|ps8|pc8]
Parameters
eventid
: Event ID (VEA)Feed URI
Version 1:
/api/v1/events/reventdetails.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/events/reventdetails.[json|ps8|pc8]
Parameters
reventid
: Recurrent Event ID (VEA)Feed URI
Version 1:
/api/v1/artists/artistevents.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/artists/artistevents.[json|ps8|pc8]
Parameters
artistid
: Artist ID. Required.startdate
: Start date for events. If not set, it is set to today.Feed URI
Version 1:
/api/v1/artists/artistcalevents.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/artists/artistcalevents.[json|ps8|pc8]
Parameters
artistid
: Artist ID. Required.numweeks
: Number of weeks to show in the calendar. Optional, default value is 6 weeks.startdate
: Reference date to start the calendar. Optional, by default is set to today.startweekday
: Weekday to start the calendar. Can be any weekday: Monday
,Tuesday
,Wednesday
,Thursday
,Friday
,Saturday
,Sunday
. Optional, default value: Monday
.Information of a single artist.
Feed URI
Version 1:
/api/v1/artists/artistinfo.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/artists/artistinfo.[json|ps8|pc8]
Parameters
artistid
: Artist ID. Required.Feed URI
Version 1:
/api/v1/artists/artists.[json|ps8|pc8]
Version 2:
/api/v2/TOKENS/artists/artists.[json|ps8|pc8]
Parameters
startdate
: Start date. Find artists with events on startdate
and after.enddate
: End date. Find artists with events up to this date.marketareaid
: Find artists with events in this market area.marketareaids
: Find artists with events in this market areas.All parameters are optional. If no parameter is set, it returns all the existing artists.