Public APIs / Open Data / DigitalNZ
DigitalNZ API
OpenAPI specification of DigitalNZ's Record API. For more information about the API see digitalnz.org/developers. To learn more about the metadata/fields used in the API see the Metadata Dictionary.
Open the DigitalNZ documentation Build something with it
Key facts
Authentication is described in the provider's OpenAPI spec and documentation. Most need a key or OAuth.
What you could build with DigitalNZ
Open data APIs give public datasets on everything from statistics to transport to weather.
- A city data dashboard
- Market research reports
- Data-driven SEO content
OpenAPI spec
DigitalNZ has a machine-readable OpenAPI definition. Load it into Postman, Insomnia or a code generator to get every endpoint and a typed client in minutes.
How we would integrate DigitalNZ
- Generate a typed client from the OpenAPI spec, so every endpoint and field is checked at build time.
- Sign up with the provider, get a key and store it on the server in an env.php or secret store.
- Put a small backend in front of it, so the browser talks to your server and your server talks to the API.
- Cache results in your own database, so pages stay fast and you stay inside rate limits.
- Add monitoring: if the API goes down or changes, you get an alert before your customers notice.
Questions about DigitalNZ
Does the DigitalNZ API need an API key?
Authentication is described in the provider's OpenAPI spec and documentation. Most need a key or OAuth.
Is there an OpenAPI (Swagger) spec for DigitalNZ?
Yes. The spec is linked on this page, so you can generate a client or import it into Postman.
Can I call DigitalNZ from the browser?
It is not documented. Plan for a small server-side proxy to be safe.
Does DigitalNZ support HTTPS?
Yes, it is served over HTTPS.
Can you build an app with DigitalNZ for me?
Yes. FullStack Partner has developers who build and run products on APIs like this one. Send us a few lines and we reply with a plan and a fixed price.