Overview
This API represents address cleaning, correction, completion, geocoding, reverse geocoding, and proximity resources for intersection addresses, physical addresses and their occupants in British Columbia. Please read our [data collection notice](https://github.com/bcgov/api-specs/blob/master/COLLECTION_NOTICE.md#collection-notice). Please note that you may experience issues when submitting requests to the delivery or test environment if using this [OpenAPI specification](https://github.com/bcgov/api-specs) in other API console viewers. [API keys](https://api.gov.bc.ca/devportal/api-directory/273) are unique and can be acquired with a GitHub or IDIR account. **Notification:** If you have applications or web pages that link to the BC Address Geocoder you must use the following URL. *https://geocoder.api.gov.bc.ca* Please note that the following URLs were deprecated in September 2018 [More Details](https://www2.gov.bc.ca/gov/content?id=103ADC5A956842828554238DEF28D6E5). - http://apps.gov.bc.ca/pub/geocoder - https://apps.gov.bc.ca/pub/geocoder \ \
Geocoder REST 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 16 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Open Data
- Base URL
https://geocoder.api.gov.bc.ca/- Version
- 2.0.0
- Endpoints
- 16
- 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://geocoder.api.gov.bc.ca/addresses.OUTPUTFORMAT" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://geocoder.api.gov.bc.ca/addresses.OUTPUTFORMAT", {
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://geocoder.api.gov.bc.ca/addresses.OUTPUTFORMAT",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /addresses.{outputFormat} | Geocode an address |
| GET | /intersections/near.{outputFormat} | Find intersections near to a geographic point |
| GET | /intersections/nearest.{outputFormat} | Find nearest intersection to a geographic point |
| GET | /intersections/within.{outputFormat} | Find intersections in a geographic area |
| GET | /intersections/{intersectionID}.{outputFormat} | Get an intersection by its unique ID |
| GET | /occupants/addresses.{outputFormat} | Geocode an address and identify site occupants |
| GET | /occupants/near.{outputFormat} | Find occupants of sites near to a geographic point |
| GET | /occupants/nearest.{outputFormat} | Find occupants of the site nearest to a geographic point |
| GET | /occupants/within.{outputFormat} | Find occupants of sites in a geographic area |
| GET | /occupants/{occupantID}.{outputFormat} | Get an occupant (of a site) by its unique ID |
| GET | /parcels/pids/{siteID}.{outputFormat} | Get a comma-separated string of all pids for a given site |
| GET | /sites/near.{outputFormat} | Find sites near to a geographic point |
| GET | /sites/nearest.{outputFormat} | Find the site nearest to a geographic point |
| GET | /sites/within.{outputFormat} | Find sites in a geographic area |
| GET | /sites/{siteID}.{outputFormat} | Get a site by its unique ID |
| GET | /sites/{siteID}/subsites.{outputFormat} | Represents all subsites of a given site |
Questions
Does the Geocoder REST API API need an API key?
Yes. The Geocoder REST API API uses API key authentication; the documentation explains how to get credentials.
Does the Geocoder REST API API support HTTPS?
Yes, the Geocoder REST API API is served over HTTPS.
How many endpoints does the Geocoder REST API API have?
Its OpenAPI description lists 16 endpoints in version 2.0.0. All of them are shown on this page.
What are alternatives to the Geocoder REST 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).