API Documentation
This page describes what information our APIs return, and how to retrieve it. To review the API Terms of Use and apply for a client API key, go to our
Developer API page.
Please review whether the API returns all the information you require. For example, images are not provided.
Event Search API
Search for upcoming events. If no parameters are passed, then all the upcoming events will be returned. To improve response time, please use a combination of the parameters to retrieve only the desired events.
Parameters
- eventName (optional) – The name of the event, such as the name of a festival. Most events do not have names. If an event has no artists, then it will have a name.
- artistIds (optional) – One or more artist ids to retrieve events for. Artist ids can be determined by looking at an existing event where they are performing.
- venueIds (optional) – One or more venue ids to retrieve events for. Venue ids can be determined by looking at an existing event for that location.
- locationIds (optional) – One or more location ids to retrieve events for. Location ids can be determined by using the Locations API below. All live streams will be included unless livestreamInd is set to false.
- startDate (optional) – Retrieve events occurring at or after this local date (only future events will be returned).
- endDate (optional) – Retrieve events occurring at or before this local date.
- createdStartDate (optional) – Retrieve events added to Edmtrain at or after this UTC date (only future events will be returned).
- createdEndDate (optional) – Retrieve events added to Edmtrain at or before this UTC date.
- festivalInd (optional) – Set to true to return only festivals (default is not set). Set to false to exclude festivals.
- livestreamInd (optional) – Set to true to return only live streams (default is not set). Set to false to exclude live streams.
- includeElectronicGenreInd (optional) – Set to true to include electronic shows (default is true). Set to false to exclude electronic shows.
- includeOtherGenreInd (optional) – Set to true to include other genre shows (default is false).
- client – Your assigned client API key.
Request Examples
- events?client=...
- events?eventName=Electric%20Zoo&client=...
- events?artistIds=195&client=...
- events?venueIds=344&client=...
- events?locationIds=36,38,46&client=...
- events?startDate=2017-01-01&client=...
- events?festivalInd=true&client=...
Response Example
Note, start time and end time are only possible for live streams. It isn't possible to have an end time without having a start time.
b2bInd indicates whether that artist is performing back to back with the next artist in the list. Any number of artists may perform b2b e.g. 3 artists. The same artist may perform in multiple b2b's for the same event.
Nearby Events API
Find upcoming events that are nearby the provided latitude, longitude, and state. If the provided coordinates are not near a supported country, then all festivals and all live streams will be returned.
Parameters
- latitude – Latitude for determining nearby events.
- longitude – Longitude for determining nearby events.
- state – Name of the state or province where the provided latitude and longitude is located.
- livestreamInd (optional) – Set to false to exclude live streams (default is not set).
- includeElectronicGenreInd (optional) – Set to true to include electronic shows (default is true). Set to false to exclude electronic shows.
- includeOtherGenreInd (optional) – Set to true to include other genre shows (default is false).
- client – Your assigned client API key.
Request Examples
- events?latitude=33.962&longitude=-118.358&state=California&client=...
Response Example
See the above response example for Event Search API.
Locations API
Retrieves information about the specified location. If the city/state parameters are not supplied, then all the popular locations will be returned (same locations that are used in Edmtrain's location dropdowns).
Parameters
- state (optional unless city is supplied) – The state or province of the desired location.
- city (optional) – The city or town of the desired location.
- client – Your assigned client API key.
Request Examples
- locations?client=...
- locations?state=Nevada&client=...
- locations?state=Nevada&city=Las%20Vegas&client=...
Response Example
API Errors
If an error occurs, then the success attribute will be set to false. The message attribute will indicate the type of error.
Response Example
locations?state=fake&client=...