Skip to content

About data.govt.nz APIs

The metadata and many datasets on data.govt.nz are available for use via an Application Programming Interface (API). When using our API you need to know what you can and cannot do with the data and where to find technical documentation.

Learning outcomes

  • Learn what the data.govt.nz APIs are
  • Understand where you can get techincal documentation for using the APIs

There are thousands of datasets on Data.govt.nz. These are available in machine and human readable formats (with some variation in what agencies provide) and can be downloaded in your preferred format as files. 

An Application Programming Interface (API) is also built into Data.govt.nz. Essentially, an API is a way to connect to the metadata and a datasets actual data (machine readable permitting) in the catalogue so you can make use of it where you want to. The advantage of an API is that every time the dataset is updated by agencies, you're use of this data will be updated as well. For example, if you had a website that showed all the bus stops in the Wellington region, when the bus stop dataset is revised to reflect any closed or new bus stops, the information you use through an API will be updated as well.

The data and metadata you access via the data.govt.nz API is licensed under the same license as the downloadable file version of the dataset. The licensing requirements are included on each dataset landing page eg Creative Commons Attribution 3.0 New Zealand.

General CKAN techincal documentation

The data.govt.nz APIs are built on open source software called "Comprehensive Knowledge Archive Network" or CKAN for short (pronounced "Sea-Can").

Currently data.govt.nz is running CKAN 2.7.x.

CKAN has detailed documentation covering the use of the APIs it makes available.

There are further more specific "how-to" guides for developers covering more advanced API use, links to reusable code and examples within this developer section of data.govt.nz.

Contributing 

If you have a useful example or "how-to" that others could learn from you are welcome to submit your guide via a pull request for review at: https://github.com/data-govt-nz/developers

 

Last Updated: 25/09/2018 9:12am