Bc

Groundwater Wells, Aquifers and Registry API

The groundwater wells, aquifers and registry API contains information related to groundwater wells and aquifers as well as a register of qualified well…

Government & public#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

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.

Endpoints 24

aquifer-codes

  • GETaquifer-codes_demand_list/aquifer-codes/demand/?limit=0&offset=0return a list of aquifer demand codes
  • GETaquifer-codes_materials_list/aquifer-codes/materials/?limit=0&offset=0return a list of aquifer material codes
  • GETaquifer-codes_productivity_list/aquifer-codes/productivity/?limit=0&offset=0return a list of aquifer productivity codes
  • GETaquifer-codes_quality-concerns_list/aquifer-codes/quality-concerns/?limit=0&offset=0return a list of quality concern codes
  • GETaquifer-codes_subtypes_list/aquifer-codes/subtypes/?limit=0&offset=0return a list of aquifer subtype codes
  • GETaquifer-codes_vulnerability_list/aquifer-codes/vulnerability/?limit=0&offset=0return a list of aquifer vulnerability codes
  • GETaquifer-codes_water-use_list/aquifer-codes/water-use/?limit=0&offset=0return a list of water use codes

aquifers

  • GETaquifers_list/aquifers/?aquifer_id=0.0&ordering=string&search=string&limit=0&offset=0return a list of aquifers
  • GETaquifers_names_list/aquifers/names/?search=stringList all aquifers in a simplified format
  • GETaquifers_read/aquifers/:aquifer_id/return details of aquifers
  • GETaquifers_files_list/aquifers/:aquifer_id/fileslist files found for the aquifer identified in the uri

cities

  • GETcities_drillers_list/cities/drillers/returns a list of cities with a qualified, registered operator (driller or installer)
  • GETcities_installers_list/cities/installers/returns a list of cities with a qualified, registered operator (driller or installer)

config

  • GETconfig_list/configserves general configuration

drillers

  • GETdrillers_list/drillers/?search=string&ordering=string&limit=0&offset=0Returns a list of all person records
  • GETdrillers_names_list/drillers/names/?search=stringSearch for a person in the Register
  • GETdrillers_files_list/drillers/:person_guid/files/list files found for the aquifer identified in the uri

keycloak

  • GETkeycloak_list/keycloakserves keycloak config

submissions

  • GETsubmissions_options_list/submissions/options/Options required for submitting activity report forms

surveys

  • GETsurveys_list/surveys/returns a list of active surveys

wells

  • GETwells_list/wells/?limit=0&offset=0returns a list of wells
  • GETwells_tags_list/wells/tags/?search=string&ordering=stringseach for wells by tag or owner
  • GETwells_files_list/wells/:tag/fileslist files found for the well identified in the uri
  • GETwells_read/wells/:well_tag_numberReturn well detail. This view is open to all, and has no permissions.

API details

Base URL
https://apps.nrs.gov.bc.ca/gwells/api/v1
Authentication
An API key in the JWT header
Operations
24 operations on 27 pathsGET 24
Main resources
aquifer-codes 7aquifers 4wells 4drillers 3cities 2config 1keycloak 1submissions 1surveys 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Groundwater Wells, Aquifers and Registry API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Groundwater Wells, Aquifers and Registry API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the JWT header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “aquifer-codes_demand_list” (GET /aquifer-codes/demand/?limit=0&offset=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Groundwater Wells, Aquifers and Registry API?

The groundwater wells, aquifers and registry API contains information related to groundwater wells and aquifers as well as a register of qualified well… It is listed under Government & public and has 24 endpoints.

Who publishes the Groundwater Wells, Aquifers and Registry API?

It is listed from Bc's public API description (an OpenAPI document), not published by Bc on Swastik Codes. Anyone who controls gov.bc.ca can claim the profile by adding a DNS TXT record.

What is the base URL of the Groundwater Wells, Aquifers and Registry API?

Requests go to https://apps.nrs.gov.bc.ca/gwells/api/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Groundwater Wells, Aquifers and Registry API?

With an API key in the JWT header.

How many endpoints does the Groundwater Wells, Aquifers and Registry API have?

24 operations on 27 paths (24 GET). The largest groups are aquifer-codes, aquifers, wells, drillers.

Is forking the Groundwater Wells, Aquifers and Registry API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.