Geocoder REST API
This API represents address cleaning, correction, completion, geocoding, reverse geocoding, and proximity resources for intersection addresses, physical…
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
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.
Please note that you may experience issues when submitting requests to the delivery or test environment if using this OpenAPI specification in other API console viewers.
API keys 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.
- http://apps.gov.bc.ca/pub/geocoder
- https://apps.gov.bc.ca/pub/geocoder
\
\
Endpoints 16
sites
- GETGeocode an address
/addresses.:outputFormat?addressString=525 Superior Street, Victoria, BC&locationDescriptor=any&maxResults=1&interpolation=adaptive&echo=true&brief=false&autoComplete=false&setBack=0&outputSRS=4326&minScore=1&matchPrecision=string&matchPrecisionNot=string&siteName=string&unitDesignator=APT&unitNumber=string&unitNumberSuffix=string&civicNumber=string&civicNumberSuffix=string&streetName=string&streetType=string&streetDirection=N&streetQualifier=string&localityName=string&provinceCode=BC&localities=string¬Localities=string&bbox=string¢re=string&maxDistance=0.0&extrapolate=true&parcelPoint=stringRepresents the set of geocoded and standardized sites and intersections whose address best matches a given query address. - GETFind sites near to a geographic point
/sites/near.:outputFormat?point=-122.377,50.121&maxDistance=0&outputSRS=4326&maxResults=1&locationDescriptor=any&setBack=0&brief=false&excludeUnits=false&onlyCivic=falseRepresents sites near a given point in the order of closest to farthest - GETFind the site nearest to a geographic point
/sites/nearest.:outputFormat?point=-122.377,50.121&maxDistance=0&outputSRS=4326&locationDescriptor=any&setBack=0&brief=false&excludeUnits=false&onlyCivic=falseRepresents the site nearest a given point - GETFind sites in a geographic area
/sites/within.:outputFormat?bbox=-119.51,49.48,-119.53,49.50&outputSRS=4326&maxResults=1&locationDescriptor=any&setBack=0&brief=false&excludeUnits=false&onlyCivic=falseRepresents sites within a given area - GETGet a site by its unique ID
/sites/:siteID.:outputFormat?outputSRS=4326&locationDescriptor=any&brief=false&setBack=0Represents an individual site - GETRepresents all subsites of a given site
/sites/:siteID/subsites.:outputFormat?outputSRS=4326&locationDescriptor=any&brief=false&setBack=0Represents all subsites of a given site
intersections
- GETFind intersections near to a geographic point
/intersections/near.:outputFormat?point=-122.377,50.121&maxDistance=0&outputSRS=4326&maxResults=1&minDegree=2&maxDegree=100Represents intersections near a given point - GETFind nearest intersection to a geographic point
/intersections/nearest.:outputFormat?point=-122.377,50.121&maxDistance=0&outputSRS=4326&minDegree=2&maxDegree=100Represents the closest intersection to a given point - GETFind intersections in a geographic area
/intersections/within.:outputFormat?bbox=-119.51,49.48,-119.53,49.50&outputSRS=4326&maxResults=200&minDegree=2&maxDegree=100Represents all intersections within a given area - GETGet an intersection by its unique ID
/intersections/:intersectionID.:outputFormat?outputSRS=4326Represents a individual intersection
occupants
- GETGeocode an address and identify site occupants
/occupants/addresses.:outputFormat?addressString=Sir James Douglas Elementary&tags=string&locationDescriptor=any&maxResults=1&interpolation=adaptive&echo=false&brief=false&autoComplete=false&setBack=0&outputSRS=4326&minScore=1&matchPrecision=OCCUPANT&matchPrecisionNot=string&siteName=string&unitDesignator=APT&unitNumber=string&unitNumberSuffix=string&civicNumber=string&civicNumberSuffix=string&streetName=string&streetType=string&streetDirection=N&streetQualifier=string&localityName=string&provinceCode=BC&localities=string¬Localities=string&bbox=string¢re=string&maxDistance=0.0&extrapolate=true&parcelPoint=stringRepresents the set of occupants whose addresses best match a given query address. Every occupant has an associated site which has a standardized address and a… - GETFind occupants of sites near to a geographic point
/occupants/near.:outputFormat?point=-122.377,50.121&tags=string&maxDistance=0&outputSRS=4326&maxResults=1&locationDescriptor=any&brief=false&setBack=0Represents occupants near a given point in order of closest to farthest - GETFind occupants of the site nearest to a geographic point
/occupants/nearest.:outputFormat?point=-122.377,50.121&maxDistance=0&tags=string&outputSRS=4326&locationDescriptor=any&brief=false&setBack=0Represents the closest occupant to a given point - GETFind occupants of sites in a geographic area
/occupants/within.:outputFormat?bbox=-123.14,49.28,-123.13,49.29&tags=string&outputSRS=4326&maxResults=200&locationDescriptor=any&brief=false&setBack=0Represents all occupants within a given area - GETGet an occupant (of a site) by its unique ID
/occupants/:occupantID.:outputFormat?outputSRS=4326&locationDescriptor=any&brief=false&setBack=0Represents an individual occupant
parcels
- GETGet a comma-separated string of all pids for a given site
/parcels/pids/:siteID.:outputFormatRepresents all parcel identifiers associated with an individual site
API details
- Base URL
https://geocoder.api.gov.bc.cahttps://geocodertst.api.gov.bc.cahttps://geocoderdlv.api.gov.bc.ca- Authentication
- An API key in the apikey header
- Operations
- 16 operations on 16 pathsGET 16
- Main resources
- sites 6intersections 5occupants 5parcels 1
- Description format
- OpenAPI 3.0.0, API version
2.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Geocoder REST 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 Geocoder REST API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the apikey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Geocode an address” (GET /addresses.:outputFormat?addressString=525 Superior Street, Victoria, BC&locationDescriptor=any&maxResults=1&interpolation=adaptive&echo=true&brief=false&autoComplete=false&setBack=0&outputSRS=4326&minScore=1&matchPrecision=string&matchPrecisionNot=string&siteName=string&unitDesignator=APT&unitNumber=string&unitNumberSuffix=string&civicNumber=string&civicNumberSuffix=string&streetName=string&streetType=string&streetDirection=N&streetQualifier=string&localityName=string&provinceCode=BC&localities=string¬Localities=string&bbox=string¢re=string&maxDistance=0.0&extrapolate=true&parcelPoint=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Geocoder REST API?
This API represents address cleaning, correction, completion, geocoding, reverse geocoding, and proximity resources for intersection addresses, physical… It is listed under Government & public and has 16 endpoints.
Who publishes the Geocoder REST 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 Geocoder REST API?
Its description lists 3 base URLs: https://geocoder.api.gov.bc.ca, https://geocodertst.api.gov.bc.ca, https://geocoderdlv.api.gov.bc.ca. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Geocoder REST API?
With an API key in the apikey header.
How many endpoints does the Geocoder REST API have?
16 operations on 16 paths (16 GET). The largest groups are sites, intersections, occupants, parcels.
Is forking the Geocoder REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.