DigitalNZ API
OpenAPI specification of DigitalNZ's Record API. For more information about the API see [digitalnz.org/developers](https://digitalnz.org/developers). To learn…
Data & analytics#openapi#open-data
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
To get a sense of what content is available via the API take a look at the search feature on the DigitalNZ website.
The terms of use specify how developers can use the DigitalNZ API.
Endpoints 3
API calls
- GETRun queries against DigitalNZ metadata search service.
/records.:format?text=string&and[category][]=Newspapers&and[content_partner][]=string&and[primary_collection][]=string&and[collection][]=string&and[usage][]=Share&and[subject][]=string&and[dc_type][]=string&and[format][]=string&and[placename][]=string&and[creator][]=string&and[title][]=string&and[date]=string&and[year]=string&and[decade]=string&and[century]=string&without[{filter_field}]=string&and[or][{filter_field}][]=string&and[is_commercial_use]=true&and[has_large_thumbnail_url]=Y&and[has_lat_lng]=true&geo_bbox=string&fields=string&sort=syndication_date&direction=asc&page=1&per_page=20&facets=category&facets_page=&facets_per_page=10&exclude_filters_from_facets=falseThis is the main search endpoint allowing queries against the records database. - GETView metadata associated with a single record.
/records/:record_id.:format?fields=stringIf you know its record_id you can use this endpoint to view all metadata associated with that specific record. - GETThe "More Like This" call returns similar records to the specified ID.
/records/:record_id/more_like_this.:format?fields=string&mlt_fields=string&filtering=stringThis feature returns a set of search results that are similar (ie have similar metadata) to a specific record.
API details
- Base URL
https://api.digitalnz.org- Authentication
- An API key in the api_key query parameter
- Operations
- 3 operations on 3 pathsGET 3
- Main resources
- API calls 3
- Response formats
application/jsonapplication/xml- Description format
- OpenAPI 3.0.1, API version
3 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the DigitalNZ API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the DigitalNZ API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the api_key query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Run queries against DigitalNZ metadata search service.” (GET /records.:format?text=string&and[category][]=Newspapers&and[content_partner][]=string&and[primary_collection][]=string&and[collection][]=string&and[usage][]=Share&and[subject][]=string&and[dc_type][]=string&and[format][]=string&and[placename][]=string&and[creator][]=string&and[title][]=string&and[date]=string&and[year]=string&and[decade]=string&and[century]=string&without[{filter_field}]=string&and[or][{filter_field}][]=string&and[is_commercial_use]=true&and[has_large_thumbnail_url]=Y&and[has_lat_lng]=true&geo_bbox=string&fields=string&sort=syndication_date&direction=asc&page=1&per_page=20&facets=category&facets_page=&facets_per_page=10&exclude_filters_from_facets=false), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the DigitalNZ API?
OpenAPI specification of DigitalNZ's Record API. For more information about the API see [digitalnz.org/developers](https://digitalnz.org/developers). To learn… It is listed under Data & analytics and has 3 endpoints.
Who publishes the DigitalNZ API?
It is listed from Digitalnz's public API description (an OpenAPI document), not published by Digitalnz on Swastik Codes. Anyone who controls digitalnz.org can claim the profile by adding a DNS TXT record.
What is the base URL of the DigitalNZ API?
Requests go to https://api.digitalnz.org. Endpoint paths are added to this base URL.
How do I authenticate with the DigitalNZ API?
With an API key in the api_key query parameter.
How many endpoints does the DigitalNZ API have?
3 operations on 3 paths (3 GET). The largest groups are API calls.
Is forking the DigitalNZ API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.