API docs v3


The current version of the DigitalNZ API is version 3. We recommend that people build applications using this version of the API for new applications and migrate existing projects. We will continue to support versions 1 and 2 of the DigitalNZ API for the foreseeable future.

We currently provide three API calls for accessing the DigitalNZ collection:

  • 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 Search therefore behaves much like a search engine. Please be sure to read the Developer API Terms of Use to learn how you are allowed to use the metadata.

Man With Computer

Portrait of man with computers. K E Niven and Co :Commercial negatives. Ref: 1/2-225451-F. Alexander Turnbull Library, Wellington, New Zealand. http://beta.natlib.govt.nz/records/23146438