6.0.0 • Published 5 years ago

@datafire/gov_bc_ca_geocoder v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/gov_bc_ca_geocoder

Client library for Geocoder REST API

Installation and Usage

npm install --save @datafire/gov_bc_ca_geocoder
let gov_bc_ca_geocoder = require('@datafire/gov_bc_ca_geocoder').create({
  apikey: ""
});

.then(data => {
  console.log(data);
});

Description

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.

Developer API keys are unique and can be acquired with a GitHub account. Production government applications may use organization API keys acquired by contacting DataBC. API keys are further described in the Developer guide.

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.

Actions

addresses.outputFormat.get

Represents the set of geocoded and standardized sites and intersections whose address best matches a given query address.

gov_bc_ca_geocoder.addresses.outputFormat.get({
  "outputFormat": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • addressString string: Civic or intersection address as a single string. See addressString
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • maxResults integer: The maximum number of search results to return.
    • interpolation string (values: adaptive, linear, none): accessPoint interpolation method. See interpolation
    • echo boolean: If true, include unmatched address details such as site name in results.
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • autoComplete boolean: If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats.
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • minScore integer: The minimum score required for a match to be returned. See minScore
    • matchPrecision string: Example: street,locality. A comma separated list of individual match precision levels to include in results. See matchPrecision
    • matchPrecisionNot string: Example: street,locality. A comma separated list of individual match precision levels to exclude from results. See matchPrecisionNot
    • siteName string: A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird House).See siteName
    • unitDesignator string (values: APT, BLDG, BSMT, FLR, LOBBY, LWR, PAD, PH, REAR, RM, SIDE, SITE, SUITE, TH, UNIT, UPPR): The type of unit within a house or building. See unitDesignator
    • unitNumber string: The number of the unit, suite, or apartment within a house or building.
    • unitNumberSuffix string: A letter that follows the unit number as in Unit 1A or Suite 302B.
    • civicNumber string: The official number assigned to a site by an address authority. See civicNumber
    • civicNumberSuffix string: A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See civicNumberSuffix
    • streetName string: The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See streetName
    • streetType string: The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See streetType
    • streetDirection string (values: N, S, E, W, O, NE, NO, NW, SE, SO, SW): The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities. See streetDirection
    • streetQualifier string: Example: the Bridge in Johnson St Bridge. The qualifier of a street name. See streetQualifier
    • localityName string: The name of the locality assigned to a given site by an address authority. See localityName
    • provinceCode string: The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC.
    • localities string: A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns addresses in Nanaimo
    • notLocalities string: A comma-separated list of localities to exclude from the search.
    • bbox string: Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See bbox
    • centre string: Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search area. This parameter must be specified together with 'maxDistance'. See centre
    • maxDistance number: The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.
    • extrapolate boolean: If true, uses supplied parcelPoint to derive an appropriate accessPoint. See extrapolate
    • parcelPoint string: The coordinates of a point (x,y) known to be inside the parcel containing a given address. See parcelPoint

Output

Output schema unknown

intersections.near.outputFormat.get

Represents intersections near a given point

gov_bc_ca_geocoder.intersections.near.outputFormat.get({
  "outputFormat": "",
  "point": "",
  "outputSRS": 0
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • point required string: The point (x,y) from which the nearest site will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.
    • maxDistance integer: The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.
    • outputSRS required integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • maxResults integer: The maximum number of search results to return.
    • minDegree integer: The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.
    • maxDegree integer: The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.

Output

Output schema unknown

intersections.nearest.outputFormat.get

Represents the closest intersection to a given point

gov_bc_ca_geocoder.intersections.nearest.outputFormat.get({
  "outputFormat": "",
  "point": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • point required string: Example: -122.377,50.121 The point (x,y) from which the nearest site will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.
    • maxDistance integer: The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • minDegree integer: The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.
    • maxDegree integer: The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.

Output

Output schema unknown

intersections.within.outputFormat.get

Represents all intersections within a given area

gov_bc_ca_geocoder.intersections.within.outputFormat.get({
  "outputFormat": "",
  "bbox": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormattarget="_blank">outputFormat
    • bbox required string: A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • maxResults integer: The maximum number of search results
    • minDegree integer: The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.
    • maxDegree integer: The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.

Output

Output schema unknown

intersections.intersectionID.outputFormat.get

Represents a individual intersection

gov_bc_ca_geocoder.intersections.intersectionID.outputFormat.get({
  "intersectionID": "",
  "outputFormat": ""
}, context)

Input

  • input object
    • intersectionID required string: A unique intersection identifier
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS

Output

Output schema unknown

occupants.addresses.outputFormat.get

Represents 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 coordinate location on the Earth.

gov_bc_ca_geocoder.occupants.addresses.outputFormat.get({
  "outputFormat": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • addressString string: Occupant name OR Occupant name ** address
    • tags string: Example: schools;courts;employmentA list of tags separated by semicolons.
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • maxResults integer: The maximum number of search results to return.
    • interpolation string (values: adaptive, linear, none): accessPoint interpolation method. See interpolation
    • echo boolean: If true, include unmatched address details such as site name in results.
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • autoComplete boolean: If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats.
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • minScore integer: The minimum score required for a match to be returned. See minScore
    • matchPrecision string: Example: street,locality. A comma separated list of individual match precision levels to include in results. See matchPrecision
    • matchPrecisionNot string: Example: street,locality. A comma separated list of individual match precision levels to exclude from results. See matchPrecisionNot
    • siteName string: A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird House).See siteName
    • unitDesignator string (values: APT, BLDG, BSMT, FLR, LOBBY, LWR, PAD, PH, REAR, RM, SIDE, SITE, SUITE, TH, UNIT, UPPR): The type of unit within a house or building. See unitDesignator
    • unitNumber string: The number of the unit, suite, or apartment within a house or building.
    • unitNumberSuffix string: A letter that follows the unit number as in Unit 1A or Suite 302B.
    • civicNumber string: The official number assigned to a site by an address authority. See civicNumber
    • civicNumberSuffix string: A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See civicNumberSuffix
    • streetName string: The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See streetName
    • streetType string: The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See streetType
    • streetDirection string (values: N, S, E, W, O, NE, NO, NW, SE, SO, SW): The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities. See streetDirection
    • streetQualifier string: The qualifier of a street name (e.g., the Bridge in Johnson St Bridge)
    • localityName string: The name of the locality assigned to a given site by an address authority. See streetDirection
    • provinceCode string: The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC.
    • localities string: A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns addresses in Nanaimo
    • notLocalities string: A comma-separated list of localities to exclude from the search.
    • bbox string: Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See bbox
    • centre string: Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search area. This parameter must be specified together with 'maxDistance'. See centre
    • maxDistance number: The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.
    • extrapolate boolean: If true, uses supplied parcelPoint to derive an appropriate accessPoint. See extrapolate
    • parcelPoint string: The coordinates of a point (x,y) known to be inside the parcel containing a given address. See parcelPoint

Output

Output schema unknown

occupants.near.outputFormat.get

Represents occupants near a given point in order of closest to farthest

gov_bc_ca_geocoder.occupants.near.outputFormat.get({
  "outputFormat": "",
  "point": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • point required string: The point (x,y) from which the nearest site will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.
    • tags string: Example: schools;courts;employmentA list of tags separated by semicolons.
    • maxDistance integer: The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • maxResults integer: The maximum number of search results to return.
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.

Output

Output schema unknown

occupants.nearest.outputFormat.get

Represents the closest occupant to a given point

gov_bc_ca_geocoder.occupants.nearest.outputFormat.get({
  "outputFormat": "",
  "point": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • point required string: The point (x,y) from which the nearest site will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.
    • maxDistance integer: The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.
    • tags string: Example: schools;courts;employmentA list of tags separated by semicolons.
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.

Output

Output schema unknown

occupants.within.outputFormat.get

Represents all occupants within a given area

gov_bc_ca_geocoder.occupants.within.outputFormat.get({
  "outputFormat": "",
  "bbox": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • bbox required string: A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox
    • tags string: Example: schools;courts;employmentA list of tags separated by semicolons.
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • maxResults integer: The maximum number of search results to return.
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.

Output

Output schema unknown

occupants.occupantID.outputFormat.get

Represents an individual occupant

gov_bc_ca_geocoder.occupants.occupantID.outputFormat.get({
  "occupantID": "",
  "outputFormat": ""
}, context)

Input

  • input object
    • occupantID required string: Occupant identifier
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.

Output

Output schema unknown

parcels.pids.siteID.outputFormat.get

Represents all parcel identifiers associated with an individual site

gov_bc_ca_geocoder.parcels.pids.siteID.outputFormat.get({
  "siteID": "",
  "outputFormat": ""
}, context)

Input

  • input object
    • siteID required string: A unique, but not immutable, site identifier.
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat

Output

Output schema unknown

sites.near.outputFormat.get

Represents sites near a given point in the order of closest to farthest

gov_bc_ca_geocoder.sites.near.outputFormat.get({
  "outputFormat": "",
  "point": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • point required string: The point (x,y) from which the nearby sites will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.
    • maxDistance integer: The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • maxResults integer: The maximum number of search results to return.
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • excludeUnits boolean: If true, excludes sites that are units of a parent site
    • onlyCivic boolean: If true, excludes sites without a civic address

Output

Output schema unknown

sites.nearest.outputFormat.get

Represents the site nearest a given point

gov_bc_ca_geocoder.sites.nearest.outputFormat.get({
  "outputFormat": "",
  "point": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • point required string: Centre point of search. See point
    • maxDistance integer: The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • excludeUnits boolean: If true, excludes sites that are units of a parent site
    • onlyCivic boolean: If true, excludes sites without a civic address

Output

Output schema unknown

sites.within.outputFormat.get

Represents sites within a given area

gov_bc_ca_geocoder.sites.within.outputFormat.get({
  "outputFormat": "",
  "bbox": ""
}, context)

Input

  • input object
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • bbox required string: A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • maxResults integer: The maximum number of search results to return.
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • excludeUnits boolean: If true, excludes sites that are units of a parent site
    • onlyCivic boolean: If true, excludes sites without a civic address

Output

Output schema unknown

sites.siteID.outputFormat.get

Represents an individual site

gov_bc_ca_geocoder.sites.siteID.outputFormat.get({
  "siteID": "",
  "outputFormat": ""
}, context)

Input

  • input object
    • siteID required string: A unique, but not immutable, site identifier.
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.

Output

Output schema unknown

sites.siteID.subsites.outputFormat.get

Represents all subsites of a given site

gov_bc_ca_geocoder.sites.siteID.subsites.outputFormat.get({
  "siteID": "",
  "outputFormat": ""
}, context)

Input

  • input object
    • siteID required string: A unique, but not immutable, site identifier.
    • outputFormat required string (values: json, geojson, xhtml, kml, gml, csv, shpz): Results format. See outputFormat
    • outputSRS integer (values: 4326, 4269, 3005, 26907, 26908, 26909, 26910, 26911): The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS
    • locationDescriptor string (values: any, accessPoint, frontDoorPoint, parcelPoint, rooftopPoint, routingPoint): Describes the nature of the address location. See locationDescriptor
    • brief boolean: If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.
    • setBack integer: The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.

Output

Output schema unknown

Definitions

This integration has no definitions

datafire
@infinitebrahmanuniverse/nolb-_datafire_g@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_g
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago