Do you sell tickets for an event, performance or venue?
Find out more about Eventfinda Ticketing.

You're viewing documentation for a legacy API

Search Events

/events/search/{arg1}/{value1}/{arg2}/{value2}…

Searches the database and returns events matching the given criteria.

Request

/events/search/category/152/location/2/start_date/2007-09-01

Response

<events count="849">
  […]
  <event id="6274" slug="2007/sep/auckland-city/snow-patrol" 
         url="http://www.eventfinda.co.nz/2007/sep/auckland-city/snow-patrol">
    Snow Patrol
  </event>
  <event id="6710" slug="2007/oct/auckland/linkin-park"
         url="http://www.eventfinda.co.nz/2007/oct/auckland/linkin-park.html">
    Linkin Park
  </event>
  <event id="5528" slug="2007/oct/auckland/hinder"
         url="http://www.eventfinda.co.nz/2007/oct/auckland/hinder.html">
    Hinder
  </event>
  […]
</events>

Search Parameters

The following search parameters are available:

rows Specifies how many events to return. If this parameter is not specified, 50 events will be returned. The total number of events that match is given as the 'count' attribute of the events element.
offset Specifies an offset into the search results. Combined with the rows parameter, this will let you return any subset of the full results.
category Only return events in the category specified by this ID, or its sub-categories.
category_slug Only return events in the category specified by this URL slug, or its sub-categories.
location Only return events in the location/venue specified by this ID, or its child locations.
location_slug Only return locations in the location/venue specified by this URL slug, or its child locations.
start_date Only return events on or after this date (format YYYY-MM-DD).
end_date Only return events on or before this date (format YYYY-MM-DD).
featured If set to 1, only return events marked as Featured.
free If set to 1, only return free events.
terms Terms to search for in event text. This value must be URL-encoded.
popular If set to 1, order upcoming events by most popular.

Search Events (Detailed)

/events/searchDetailed/{arg1}/{value1}/{arg2}/{value2}…

Searches the database and returns events matching the given criteria.

Request

/events/searchDetailed/category/152/location/2/start_date/2007-09-01

Response

<events count="849">
  […]
  <event id="5985" slug="2007/aug/auckland-city/roc-tha-block" url="http://www.eventfinda.co.nz/2007/aug/auckland-city/roc-tha-block">
    <name><![CDATA[Roc Tha Block]]></name>
    <category_id>152</category_id>
    <category id="152" slug="rock-gigs">
      <name><![CDATA[Rock]]></name>
      <parent id="6" slug="concerts-gig-guide">
        <name><![CDATA[Concerts & Gig Guide]]></name>
        <parent id="246" slug="whatson">
          […]
        </parent>
      </parent>
    </category>
    <location id="904" slug="vector-arena" type="venue">
      <name><![CDATA[Vector Arena]]></name>
      <parent id="148" slug="auckland-cbd">
        <name><![CDATA[Auckland CBD]]></name>
        <parent id="28" slug="auckland-central">
          […]
        </parent>
      </parent>
      <lat>-36.8472</lat>
      <long>174.7773</long>
      <description><![CDATA[A world class, indoor, multi-purpose, all weather arena attracting the cream of world sports and entertainment from rock concerts to classical ...]]></description>
    </location>
    <image_url>https://cdn.eventfinda.co.nz/uploads/events/transformed/5985-5950-1.jpg</image_url>
    <dates>
      <date>
        <location_id>904</location_id>
        <start_date>2007-09-01</start_date>
      </date>
      […]
    </dates>
    <featured>1</featured>
    <different>0</different>
    <free>0</free>  
    <description><![CDATA[UPDATED: Thursday night's Roc Tha Block concert at Vector Arena - featuring Akon, The Game and Naughty by Nature - has been postponed until September 1 due to a delay in processing the rappers' visas to ...]]></description>
    <images>
      <image id="5130" is_primary="1">
        <image_transformation transform_type_id="1" filename="5985-5950-1.jpg" mime_type="image/jpeg" width="205" height="115"/>
        <image_transformation transform_type_id="2" filename="5985-5950-2.jpg" mime_type="image/jpeg" width="80" height="45"/>
        <image_transformation transform_type_id="3" filename="5985-5950-3.jpg" mime_type="image/jpeg" width="100" height="56"/>
        […]
      </image>
    </images>
  </event>   
  […]
</events>

Notes

The detailed search call accepts exactly the same search parameters as the normal search (see above). The difference is that it returns all the details for an event, and the event's location and category, potentially saving quite a few extra API calls.

The event details returned as part of the detailed search response are the same as those returned by the Get Event By Id and Get Event By Slug calls.

Get Event By ID

/events/get/id/{$id}

Return the event specified by the numeric ID {$id}.

Request

/events/get/id/5528

Response

<event id="5528" slug="2007/oct/auckland-city/queen-we-will-rock-you"
       url="http://www.eventfinda.co.nz/2007/oct/auckland-city/queen-we-will-rock-you.html">
  <name>Queen - We Will Rock You</name>
  <category_id>152</category_id>
  <website_url>http://website.com/<website_url>
  <image_url>https://cdn.eventfinda.co.nz/uploads/events/500/5528-5289.jpg</image_url>
  <dates>
    <date>
      <location_id>910<location_id>
      <start_date>2007-10-26</start_date>
      <start_time>20:00</start_time>
      <end_date>2007-11-11</end_date>
    </date>
    […]
  </dates>
  <featured>1</featured>
  <different>0</different>
  <free>0</free>
  <tickets>
    <agent_id>1</agent_id>
    <pricing>
      <cost value="60.00">Low</cost>
      <cost value="115.00">High</cost>
    </pricing>
    <on_sale_date_time>2007-05-28 09:00:00</on_sale_date_time>
  </tickets>
  <artists>
    <artist id="21" slug="annie-crummer">Annie Crummer</artist>
    <artist id="22" slug="miguel-ayesa">Miguel Ayesa</artist>
    […]
  </artists>
  <restrictions id="4">Licensed All Ages</restrictions>
  <description>
    We Will Rock You, the musical by Queen and Ben Elton is an electrifying show that's guaranteed
    to blow your mind.
    […]
  </description>
</event>

Notes

For unapproved (i.e. user contributed and not yet moderated) venues, the location_id field will refer to the parent location for the venue. The additional plaintext tag venue_name will be present, along with the optional tag venue_address to specify the venue information.

User-contributed fields will be displayed according to availability of the data. Applications should check for the presence of each tag before attempting to read the value.

Optional Fields

agent_id Will be specified only where a major ticketing agent is responsible for ticketing the event. If tickets are provided through other means, the following fields may be available under the tickets element (both are optional):
<tickets>
  […]
  <phone>09 123 4567</phone>
  <website_url>http://website.com/</website_url>
  […]
</tickets>
end_date Where unspecified, should be assumed to be the same as start_date.
image_url Will only be specified where an image has been provided (always present for featured music events).
on_sale_date_time Where unspecified, tickets should be assumed to have been on sale from the time the event was entered. This is an optional field for promoters and will likely only be populated in the event tickets were not on sale at the time the event was entered.
restrictions May not be specified as licensing information is sometimes unavailable. Where unspecified, events should not necessarily be assumed to be All Ages.
website_url Will be specified only where a website for the event exists. Please also refer to the artist record's website_url field.

Get Event By Slug

/events/get/slug/{$slug}

Return the event specified by the alphanumeric URL Slug {$slug}.

Request

/events/get/slug/2007/oct/auckland-city/queen-we-will-rock-you

Response

<event id="5528" slug="2007/oct/auckland-city/queen-we-will-rock-you"
        url="http://www.eventfinda.co.nz/2007/oct/auckland-city/queen-we-will-rock-you.html">
  <name>Queen - We Will Rock You</name>
  <category_id>152</category_id>
  <website_url>http://website.com/<website_url>
  <image_url>https://cdn.eventfinda.co.nz/uploads/events/500/5528-5289.jpg</image_url>
  <dates>
    <date>
      <location_id>910<location_id>
      <start_date>2007-10-26</start_date>
      <start_time>20:00</start_time>
      <end_date>2007-11-11</end_date>
    </date>
    […]
  </dates>
  <featured>1</featured>
  <different>0</different>
  <free>0</free>
  <tickets>
    <agent_id>1</agent_id>
    <pricing>
      <cost value="60.00">Low</cost>
      <cost value="115.00">High</cost>
    </pricing>
    <on_sale_date_time>2007-05-28 09:00:00</on_sale_date_time>
  </tickets>
  <artists>
    <artist id="21" slug="annie-crummer">Annie Crummer</artist>
    <artist id="22" slug="miguel-ayesa">Miguel Ayesa</artist>
    […]
  </artists>
  <restrictions id="4">Licensed All Ages</restrictions>
  <description>
    We Will Rock You, the musical by Queen and Ben Elton is an electrifying show that's guaranteed
    to blow your mind.
    […]
  </description>
</event>

Notes

See notes above for Get Event by ID.