Eventfinda Developer API: Locations

List Locations

/locations/list

List all locations down to a suburb level in alphabetical order. Note that a parent_id will not be supplied for top-level locations.

Response

<locations>
  […]
  <location id="216" slug="east-tamaki" parent_id="1382">East Tamaki</location>
  <location id="152" slug="auckland-city-eden-terrace" parent_id="28">Eden Terrace</location>
  <location id="135" slug="southland-edendale" parent_id="18">Edendale</location>
  <location id="740" slug="tararua-ekatahuna" parent_id="739">Ekatahuna</location>
  <location id="153" slug="auckland-ellerslie" parent_id="28">Ellerslie</location>
  <location id="573" slug="taranaki-eltham" parent_id="7">Eltham</location>
  <location id="154" slug="auckland-city-epsom" parent_id="28">Epsom</location>
  […]
</locations>

List Regions

/locations/regionList

List all regions (top-level locations) in geographical order.

Response

<locations>
  […]
  <location id="2" slug="auckland-region">Auckland Region</location>
  <location id="3" slug="waikato">Waikato</location>
  <location id="4" slug="bay-of-plenty">Bay of Plenty</location>
  […]
<locations>

This response includes the number of active events in each location (the "count"). The count also includes events in child locations of each location. By default, the count shown is for upcoming events in the whole of New Zealand. You can change this behaviour using the following optional parameters, for example, to show accurate counts for just ballet events next month.

List Child Locations

/locations/getChildren/id/{$id}

Return the sub-locations/venues (if any) of the location specified by the numeric ID {$id}. List all sub-locations in alphabetical order.

Request

/locations/getChildren/id/2

Response

<locations>
  […]
  <location id="33" slug="manukau" parent_id="2">Manukau</location>
  <location id="34" slug="north-shore" parent_id="2">North Shore</location>
  <location id="35" slug="auckland-papakura" parent_id="2">Papakura</location>
  […]
</locations>

Get Location By ID

/locations/get/id/{$id}

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

Request

/locations/get/id/148

Response

<location id="148" slug="auckland-cbd" parent_id="28">Auckland CBD</location>

Get Location By Slug

/locations/get/slug/{$slug}

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

Request

/locations/get/slug/auckland-cbd

Response

<location id="148" slug="auckland-cbd" parent_id="28">Auckland CBD</location>

Get Parent Location

/locations/getParent/id/{$id}

Returns the parent location (if applicable) for the location specified by the numeric ID {$id}.

Request

/locations/getParent/id/34

Response

<location id="2" slug="auckland-region" parent_id="574">Auckland Region</location>