Technical documentation and code examples for developer use with the data.govt.nz Application Programming Interfaces (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.
Data.govt.nz's data APIs are made openly available for users and it's worth taking a moment to find out what you can and cannot do when using our APIs in your own applications.
Data.govt.nz's datasets, organisations and groups can be accessed and queried as JSON date through the metadata API; this page describes how.
The data.govt.nz DataStore API allows you to access and query the rows and columns of raw data listed by agencies in machine readable CSV format via a JSON API endpoint.
Using the ckanapi-exporter tool you can extract all dataset metadata into a single CSV file.
Export an agencies datasets into sub-folders including any hosted or referenced data files and a json file with metadata.
Guidance and tutorials on using the data.govt.nz catalogue to publish open data listings. This includes a helpful checklist, general user help and specific 'how to' articles for New Zealand government agencies listing open datasets.
A draft checklist of the things you should consider before releasing open data.
Government agencies can publish and update their datasets on the data.govt.nz catalogue by applying for a publisher account.
Add government datasets to the listing on data.govt.nz.
Metadata describes your dataset to others in a standardised way. Having good quality metadata helps people discover and use your dataset. This guidance provides a description and examples of good practice metadata when releasing on data.govt.nz.
Learn how to prepare a machine readable CSV file and publish to the data.govt.nz data catalogue.
Public Service Commission ask agencies to disclose their Departmental Secretary or Chief Executive Expenses at least annually. Data.govt.nz allows you to self-manage the update process to the CE Expenses datasets. This allows agencies to publish faster and meet the disclosure deadline.
This walkthrough will help you correctly set up Creative Commons licences for your data layers in ArcGIS Online open data portal. Setting licences correctly here flows through to data.govt.nz when you make use of automated harvesting.
Data.govt.nz allows people to request open data from agencies with a data request form. This guidance page helps agencies resolve data requests they receive by using the response features built into data.govt.nz.
Data.govt.nz adopted an international data harvesting open standard (data.json) to automate agency dataset updates and additions. There are tools available to help generate the correct format and the open standard data schema is detailed with examples.
Machine and human readable formats, such as PDF, CSV, and XLS, ensures that you maximise the value of your open data while complying with open government data and information policies.
There are 15 key things you can do to ensure your data API is user-friendly.
Following best practice guidance from CERT NZ, we have made Publisher accounts on data.govt.nz more secure by using two-factor authentication.
Step by step guides to help you work through processes involved with managing and releasing data.
Guide to reviewing and safely releasing open data for reuse.
Read inspiring New Zealand stories about innovative projects that use open data. You can also hear about the challenges, successes and benefits of initiatives to publish open data.
Te Papa has used Wellington City Council's freely available cyber twin of Wellington City so museum visitors can explore the impact of tsunamis.
In 2011 Charities Services (then the Charities Commission) made advanced search functionality available for the Charities Register and licensed the data for re-use under a Creative Commons BY licence.
The Department of Internal Affairs manages the local councils website at localcouncils.govt.nz, which presents data from New Zealand’s 78 local authorities in a consistent format that enables it to be compared and analysed.
Affordability in NZ is an open source web application, created by transportation consultancy MRCagney, which uses open government data to show people which suburbs will be most affordable for them.
The ANZ Bank uses open data to create industry insight reports that inform investment in the craft beer industry.