API docs v3

The current DigitalNZ API is version 3.

We provide three API calls (endpoints) for accessing the DigitalNZ corpus:

  • Search records to query the DigitalNZ metadata search service
  • Get metadata for a specific record
  • Sets for returning data from your virtual Set collections

Remember that DigitalNZ does not have a copy of items in the collection. Instead, we hold metadata about items in other collections, together with a pointer to the content object. digitalnz.org therefore behaves much like a search engine.

The Metadata Dictionary provides further detail about the common fields used in the DigitalNZ harvesting system.

Detail on the API parameters

For more detail about the API parameters and responses, please see the DigitalNZ OpenAPI spec on SwaggerHub.

Terms of use

Please be sure to read the Developer API Terms of Use to learn how you are allowed to use the metadata.