☰NZGD External API
Retrieve data from NZGD
The NZGD External API provides a direct connection between your organization’s database and the NZGD, enabling you to transfer data and files in and out of the database without needing to interact with the NZGD solution.
Getting started
Welcome to NZGD External API! To access the APIs, you must first create an account. The following steps will help you get started with using the APIs:
Get familiar with the API Use Policy
Follow our guide to prepare some details we need from you.
Send us the details at support@nzgd.org.nz.
Once your sign up request has been approved, you will receive a confirmation email and details about how to sign up.
Access our APIs!
If you need further help or clarification please contact support@nzgd.org.nz.
About NZGD
The NZGD is a centralised platform for engineers to share and access geotechnical data. Originating from the Canterbury earthquakes, the NZGD has grown to be a nationally important dataset to the geotechnical industry. It is focused on providing more efficient access to geotechnical information, to support building construction and compliance for local and central government. It is also used to support the wider construction industry and the development of geotechnical research.
The database contains extensive geotechnical investigations, geological surveys, and monitoring systems across New Zealand. Leveraging state-of-the-art technology and data management systems, the database provides engineers, geologists, building control and policy makers with comprehensive insights into soil behaviour, ground stability, and seismic hazards.
.png)
API Overview
The NZGD External API provides a wide range of functionality for developers, including:
Retrieve and Search
Retrieve and search metadata from investigations and related information. This includes files, monitoring installations, liquid and plastic limit tests, particle size distribution general, and water contents.
Manage Metadata
Manage existing content using the an NZGD id. This includes publishing, removing, submitting, moving records to draft, and uploading files and links for Investigations and related information like liquid and plastic limit tests.
Legal
By using the NZGD External API, you accept the API Use Policy.
Support
If you have any questions or run into any issues while using the NZGD External API, you can find help in the FAQs page. If you have any further queries, email support@nzgd.org.nz.