Search Events
https://api.eventfinda.co.nz/v2/events.xml
Searches the database and returns events matching the given criteria.
Example Request
https://api.eventfinda.co.nz/v2/events.xml?row=10&fields=event:(url,name,sessions),session:(timezone,datetime_start)&q=concert&order=popularityExample Response
<?xml version="1.0"?>
<error>An error occurred</error>
To include all available fields in the response remove the fields parameter from the request.
Parameters
The following parameters are available along with the common parameters.
artists |
Return events associated with the given artist ids, multiple ids can be separated by commas. |
category |
Only return events in the category specified by this ID, or its descendant categories. Specify multiple IDs by separating them with a comma (,). |
category_slug |
Only return events in the category specified by this URL slug, or its descendant categories. Specify multiple URL slugs by separating them with a comma (,). |
collection |
Only return events in the collection specified by this ID. Specify multiple IDs by separating them with a comma (,). |
collection_slug |
Only return events in the collection specified by this URL slug. Specify multiple URL slugs by separating them with a comma (,). You can find the URL slug for a collection by inspecting its URL on this site, e.g. the
Badjelly the Witch Glow Show collection has the URL slug of |
end_date |
Only return events on or before this date (format is ISO 8601, e.g. YYYY-MM-DD HH:mm:ss). The time part is optional. Defaults to 3 years from now if not specified. |
featured |
If set to 1, only return events marked as featured. |
free |
If set to 1, only return free events. |
location |
Only return events in the location/venue specified by this ID, or its descendant locations. Specify multiple IDs by separating them with a comma (,). |
location_slug |
Only return locations in the location/venue specified by this URL slug, or its child locations. Specify multiple URL slugs by separating them with a comma (,). |
order |
Specify the order the results should be in. Possible values are
|
point |
In the format latitude,longitude order and/or radius parameters.
|
presented_by |
Return events with a matching presented_by (case insensitive). |
price_max |
Return events who have a ticket type price less than this value |
price_min |
Return events who have a ticket type price greater or equal to this value |
radius |
Only include events within the given kilometers of the given |
start_date |
Only return events on or after this date (format is ISO 8601, e.g. YYYY-MM-DD HH:mm:ss). The time part is optional. Defaults to current time if not specified.
Note that because the |
ticketed |
If true only return events which are ticketed by Eventfinda. |
username |
Return events listed by the given username. |
Formatting datetime_summary Field
The following parameters allow you to format the datetime_summary field on the event result using the standard strftime arguments.
Example Request
This request specifies a date_format or %A %e %B and a date_start_end_separator of until
/events.xml?rows=2&fields=event:(name,datetime_summary)&date_format=%A%20%e%20%B&date_start_end_separator=%20until%20
Example Response
<?xml version="1.0"?>
<error>An error occurred</error>
date_format |
The format of the date part. Default '%a %e %b %Y' |
time_format |
The format of the time part. Default is no time part, ''. |
date_time_separator |
Character or characters to use to separate the date and time. Defaults to nothing, ''. |
date_start_end_separator |
Character or characters to use to separate the start and end. Defaults to ' - '. |