Overview
The groundwater wells, aquifers and registry API contains information related to groundwater wells and aquifers as well as a register of qualified well drillers and well pump installers registered to operate in B.C.
Groundwater Wells, Aquifers and Registry API is an open data API from gov.bc.ca. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 24 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Open Data
- Base URL
https://apps.nrs.gov.bc.ca/gwells/api/v1/- Version
- v1
- Endpoints
- 24
- OpenAPI
- Specification ↗
- Spec updated
- 2021-06-21
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://apps.nrs.gov.bc.ca/gwells/api/v1/aquifer-codes/demand/" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://apps.nrs.gov.bc.ca/gwells/api/v1/aquifer-codes/demand/", {
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://apps.nrs.gov.bc.ca/gwells/api/v1/aquifer-codes/demand/",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /aquifer-codes/demand/ | return a list of aquifer demand codes |
| GET | /aquifer-codes/materials/ | return a list of aquifer material codes |
| GET | /aquifer-codes/productivity/ | return a list of aquifer productivity codes |
| GET | /aquifer-codes/quality-concerns/ | return a list of quality concern codes |
| GET | /aquifer-codes/subtypes/ | return a list of aquifer subtype codes |
| GET | /aquifer-codes/vulnerability/ | return a list of aquifer vulnerability codes |
| GET | /aquifer-codes/water-use/ | return a list of water use codes |
| GET | /aquifers/ | return a list of aquifers |
| GET | /aquifers/names/ | List all aquifers in a simplified format |
| GET | /aquifers/{aquifer_id}/ | return details of aquifers |
| GET | /aquifers/{aquifer_id}/files | list files found for the aquifer identified in the uri |
| GET | /cities/drillers/ | returns a list of cities with a qualified, registered operator (driller or installer) |
| GET | /cities/installers/ | returns a list of cities with a qualified, registered operator (driller or installer) |
| GET | /config | serves general configuration |
| GET | /drillers/ | Returns a list of all person records |
| GET | /drillers/names/ | Search for a person in the Register |
| GET | /drillers/{person_guid}/files/ | list files found for the aquifer identified in the uri |
| GET | /keycloak | serves keycloak config |
| GET | /submissions/options/ | Options required for submitting activity report forms |
| GET | /surveys/ | returns a list of active surveys |
| GET | /wells/ | returns a list of wells |
| GET | /wells/tags/ | seach for wells by tag or owner |
| GET | /wells/{tag}/files | list files found for the well identified in the uri |
| GET | /wells/{well_tag_number} | Return well detail. |
Questions
Does the Groundwater Wells, Aquifers and Registry API API need an API key?
Yes. The Groundwater Wells, Aquifers and Registry API API uses API key authentication; the documentation explains how to get credentials.
Does the Groundwater Wells, Aquifers and Registry API API support HTTPS?
Yes, the Groundwater Wells, Aquifers and Registry API API is served over HTTPS.
How many endpoints does the Groundwater Wells, Aquifers and Registry API API have?
Its OpenAPI description lists 24 endpoints in version v1. All of them are shown on this page.
What are alternatives to the Groundwater Wells, Aquifers and Registry API API?
Other Open Data APIs include Search Services, Wayback API, Wikipedia, Nasdaq Data Link, University of Oslo.
Similar open data APIs
Compare alternatives →Search Services
Open DataAPI for Internet Archive's Search-related services
Wayback API
Open DataAPI for Internet Archive's Wayback Machine
Wikipedia
Open DataMediawiki Encyclopedia
Nasdaq Data Link
Open DataThe source for financial, economic, and alternative datasets, serving investment professionals.
University of Oslo
Open DataCourses, lecture videos, detailed information for courses etc. for the University of Oslo (Norway)
Data API
Open DataServes the Clever Data API
Listed from APIs.guru (CC0).