DigitalNZ API API

Overview

OpenAPI specification of DigitalNZ's Record API. For more information about the API see [digitalnz.org/developers](https://digitalnz.org/developers). To learn more about the metadata/fields used in the API see the [Metadata Dictionary](https://docs.google.com/document/pub?id=1Z3I_ckQWjnQQ4SzpORbClcIXUheO-Jd4jt-oZFuMcoQ). To get a sense of what content is available via the API take a look at the search feature on the [DigitalNZ website](https://digitalnz.org/records?text=all%20sorts&tab=Images). The [terms of use](https://digitalnz.org/about/terms-of-use/developer-api-terms-of-use) specify how developers can use the DigitalNZ API.

DigitalNZ API is an open data API from digitalnz.org. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 3 endpoints.

At a glance

Authentication

API key

HTTPS

Yes

CORS

Unknown

Category

Open Data

Base URL

https://api.digitalnz.org

Version

3

Endpoints

3

OpenAPI

Specification ↗

Spec updated

2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "https://api.digitalnz.org/records.FORMAT" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("https://api.digitalnz.org/records.FORMAT", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://api.digitalnz.org/records.FORMAT",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions