​For Developers

Metro support innovation in Canterbury and encourage developers to use our bus data to create apps, online tools and widgets. The purpose of this section is to provide an overview of​ the da​ta feeds that are available for MetroInfo's Bus Network in order to assist independent developers to what information is available and can be integrated into their own applications.

There are 6 main groupings of data.

  • Routes
  • Bus Stops
  • Bus ETA (expected time of arrival)
  • Service Announcements
  • Timetables

 

Access to data and the Terms and Conditions of use are located here.

A reminder – anything you create with this data must adhere to our terms and conditions including making sure your app or tool does not use any Metro branding or logos – this is because when people see our branding (or anything similar) they assume it’s ours and we get the credit for it. Ensure you get the credit when deserved and make sure whatever you design does not have any of our branding, logos or trading names and doesn’t include the word ‘official’.

Note: Canterbury Regional Council reserves the right to discontinue the publication of the data feeds and/or to modify the url of the data feeds without notice. Canterbury Regional Council will not be liable for any modification, suspension or discontinuance of the service.

Tips and Tricks

There is a number of unique terminologies used in the Canterbury bus data. Below are all terms and an explanation of what each means. If you need further assistance please email metroinfo@ecan.govt.nz.

Bus route Schedules Pages

IMPORTANT - Some routes have multiple schedules, to display the correct route information you must choose the longest schedule in both directions otherwise you could be providing misleading information by not showing the entire route. This data also shows routes for Christchurch and Timaru.

Term Description
"Content Expires" Date and time at which the data may change and time the document cache will be refreshed
"RouteNo" Bus route number
"Name" Name of route and the direction it is travelling
"Destination Name" End destination for this direction of the route (NB this can change multiple times in one routes data depending on how many types of trips the buses run e.g. Express trips or some trips that travel further than others on the same bus route)
"ValidFrom" Start date for the route
"ValidUntil" End date for the bus route - if omitted then there is no end date
"Direction" Direction in which the bus service is operating e.g. <AC> = anti clockwise
"Length"  
"Schedule" Indicates status of schedule e.g. "Active"(currently operating) or "Inactive" (no longer operating) or "Pending" (will operate in the future)
"Platform Tag" Data only key number for the particular bus stop (this is NOT the public 5 digit bus stop number)
"Platform Number" 5 digit number that is on each bus stop pole that uniquely identifies the bus stop
"Name" The common name of the Platform which can default to the nearest intersection
"ScheduleAdheranceTimepoint" true or false True= is a timing point for buses, false = is not the timing point for buses
"X" or "Express" Express trip - will not stop at all bus stops
Route directions  
AC Anti Clockwise (Buses travel around the city in anti-clockwise direction)
CL Clockwise
EB Eastbound
NB Northbound
WB Westbound
SB Southbound
IB Inbound
OB Outbound

 

GPS Data for bus arrivals

IMPORTANT - PlatformTag will provide the data to bus eta's but developers will need to use the relating "PlatformNumber" when displaying to the public. Only PlatformNumbers are displayed at bus stops therefore the general public do not know the PlatformTags.

Term Description
"Content Expires" Date and time at which the data may change and time the document cache will be refreshed
"MaxArrivalScope" Maximum amount of minutes data is shown for e.g. buses up to 30mins away
"PlatformTag" Data only key number for the particular bus stop (this is NOT the public 5 digit bus stop number)
"Name" Name of the bus stop
"RouteNo" Bus route number
"Name" Name of route and the direction it is travelling
"Destination Name" End destination for this direction of the route (NB this can change multiple times in one routes data depending on how many types of trips the buses run e.g. Express trips or some trips that travel further than others on the same bus route)
"TripETA" Amount of minutes until that bus arrives at the bus stop
"WheelchairAccess" True = does have wheelchair access, False = no wheelchair access

 

Some of the data feeds have been formulated in the same format as Google Transit. Others are xml/rss and json feeds. For information on how to read, access and use the data in Google Transit format visit https://developers.google.com/transit/gtfs/reference. Additional information schema information is available via the data.ecan.govt.nz service. Look for Journey Planner schema.​​​