{"note":"OpenAPI conversion -- returning structured metadata","name":"gov-bc-ca-geocoder","description":"Geocoder REST API","version":"2.0.0","base_url":"https://geocoder.api.gov.bc.ca/","endpoints":16,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Geocoder REST API\n@base https://geocoder.api.gov.bc.ca/\n@version 2.0.0\n@auth ApiKey apikey in header\n@common_fields {outputFormat: str(json/geojson/xhtml/kml/gml/csv/shpz)=json # Results format. See outputFormat.   Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)}\n@endpoints 16\n@toc addresses.{outputFormat}(1), occupants(5), sites(5), intersections(4), parcels(1)\n\n@group addresses.{outputFormat}\n@endpoint GET /addresses.{outputFormat}\n@desc Geocode an address\n@optional {addressString: str # Civic or intersection address as a single string. See addressString, locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, maxResults: int=1 # The maximum number of search results to return., interpolation: str(adaptive/linear/none)=adaptive # accessPoint interpolation method. See interpolation, echo: bool=true # If true, include unmatched address details such as site name in results., brief: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., autoComplete: bool=false # If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats., exactSpelling: bool=false # If true, autoComplete suggestions are limited to addresses beginning with the provided partial address., fuzzyMatch: bool=false # If true, autoComplete suggestions are sorted using a fuzzy match comparison to the addressString., setBack: int=0 # 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: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, minScore: int=1 # The minimum score required for a match to be returned. See minScore, matchPrecision: str # Example: street,locality.  A comma separated list of individual match precision levels to include in results. See matchPrecision, matchPrecisionNot: str # Example: street,locality.  A comma separated list of individual match precision levels to exclude from results. See matchPrecisionNot, siteName: str # 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: str(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: str # The number of the unit, suite, or apartment within a house or building., unitNumberSuffix: str # A letter that follows the unit number as in Unit 1A or Suite 302B., civicNumber: str # The official number assigned to a site by an address authority. See civicNumber, civicNumberSuffix: str # A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See civicNumberSuffix, streetName: str # The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See streetName, streetType: str # The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See streetType, streetDirection: str(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: str # Example: the Bridge in Johnson St Bridge. The qualifier of a street name. See streetQualifier, localityName: str # The name of the locality assigned to a given site by an address authority. See localityName, provinceCode: str=BC # The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC., localities: str # 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: str # A comma-separated list of localities to exclude from the search., bbox: str # Example: -126.07929,49.7628,-126.0163,49.7907.  A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See bbox, centre: str # 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: num # The maximum distance (in metres) to search from the given point.  If not specified, the search distance is unlimited., extrapolate: bool # If true, uses supplied parcelPoint to derive an appropriate accessPoint.           See extrapolate, parcelPoint: str # The coordinates of a point (x,y) known to be inside the parcel containing a given address. See parcelPoint}\n@returns(200) A list of matching sites or intersections and their physical locations. See addresses response\n\n@endgroup\n\n@group occupants\n@endpoint GET /occupants/addresses.{outputFormat}\n@desc Geocode an address and identify site occupants\n@optional {addressString: str # Occupant name OR Occupant name ** address, tags: str # Example: schools;courts;employmentA list of tags separated by semicolons., tagCondition: str(or/and)=or # The 'or' condition will return occupants having one or more of the tags in their keyword list. The 'and' condition will return occupants having all of the tags in their keyword list., locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, maxResults: int=1 # The maximum number of search results to return., interpolation: str(adaptive/linear/none)=adaptive # accessPoint interpolation method. See interpolation, echo: bool=false # If true, include unmatched address details such as site name in results., brief: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., autoComplete: bool=false # If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats., exactSpelling: bool=false # If true, autoComplete suggestions are limited to addresses beginning with the provided partial address., fuzzyMatch: bool=false # If true, autoComplete suggestions are sorted using a fuzzy match comparison to the addressString., setBack: int=0 # 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: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, minScore: int=1 # The minimum score required for a match to be returned. See minScore, matchPrecision: str=OCCUPANT # Example: street,locality.  A comma separated list of individual match precision levels to include in results. See matchPrecision, matchPrecisionNot: str # Example: street,locality.  A comma separated list of individual match precision levels to exclude from results. See matchPrecisionNot, siteName: str # 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: str(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: str # The number of the unit, suite, or apartment within a house or building., unitNumberSuffix: str # A letter that follows the unit number as in Unit 1A or Suite 302B., civicNumber: str # The official number assigned to a site by an address authority. See civicNumber, civicNumberSuffix: str # A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See civicNumberSuffix, streetName: str # The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See streetName, streetType: str # The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See streetType, streetDirection: str(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: str # The qualifier of a street name (e.g., the Bridge in Johnson St Bridge), localityName: str # The name of the locality assigned to a given site by an address authority. See streetDirection, provinceCode: str=BC # The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC., localities: str # 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: str # A comma-separated list of localities to exclude from the search., bbox: str # Example: -126.07929,49.7628,-126.0163,49.7907.  A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See bbox, centre: str # 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: num # The maximum distance (in metres) to search from the given point.  If not specified, the search distance is unlimited., extrapolate: bool # If true, uses supplied parcelPoint to derive an appropriate accessPoint.           See extrapolate, parcelPoint: str # The coordinates of a point (x,y) known to be inside the parcel containing a given address. See parcelPoint}\n@returns(200) A list of matching occupants, sites, and their physical locations. Response document will contain one About Query Representation and one Site Address Representation plus Occupant Representation for each matching occupant.\n\n@endgroup\n\n@group sites\n@endpoint GET /sites/nearest.{outputFormat}\n@desc Find the site nearest to a geographic point\n@required {point: str # Centre point of search. See point}\n@optional {maxDistance: int # The maximum distance (in metres) to search from the given point.  If not specified, the search distance is unlimited., outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, setBack: int=0 # 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: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., excludeUnits: bool=false # If true, excludes sites that are units of a parent site, onlyCivic: bool=false # If true, excludes sites without a civic address}\n@returns(200) The nearest site in Site Address Representation\n\n@endgroup\n\n@group occupants\n@endpoint GET /occupants/nearest.{outputFormat}\n@desc Find occupants of the site nearest to a geographic point\n@required {point: str # 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.}\n@optional {maxDistance: int # The maximum distance (in metres) to search from the given point.  If not specified, the search distance is unlimited., tags: str # Example: schools;courts;employmentA list of tags separated by semicolons., outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, brief: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., setBack: int=0 # 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.}\n@returns(200) The nearest occupant in Site Address Representation plus Occupant Representation\n\n@endgroup\n\n@group intersections\n@endpoint GET /intersections/nearest.{outputFormat}\n@desc Find nearest intersection to a geographic point\n@required {point: str # 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.}\n@optional {maxDistance: int # The maximum distance (in metres) to search from the given point.  If not specified, the search distance is unlimited., outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, minDegree: int=2 # The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1., maxDegree: int=100 # The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.}\n@returns(200) The nearest intersection in Intersection Address Representation\n\n@endgroup\n\n@group sites\n@endpoint GET /sites/near.{outputFormat}\n@desc Find sites near to a geographic point\n@required {point: str # 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.}\n@optional {maxDistance: int # The maximum distance (in metres) to search from the given point.  If not specified, the search distance is unlimited., outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, maxResults: int=1 # The maximum number of search results to return., locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, setBack: int=0 # 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: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., excludeUnits: bool=false # If true, excludes sites that are units of a parent site, onlyCivic: bool=false # If true, excludes sites without a civic address}\n@returns(200) A list of selected sites that are near a given point in order of closest to farther. Each site in the response document is structured as a Site Address Representation\n\n@endgroup\n\n@group occupants\n@endpoint GET /occupants/near.{outputFormat}\n@desc Find occupants of sites near to a geographic point\n@required {point: str # 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.}\n@optional {tags: str # Example: schools;courts;employmentA list of tags separated by semicolons., maxDistance: int # The maximum distance (in metres) to search from the given point.  If not specified, the search distance is unlimited., outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, maxResults: int=1 # The maximum number of search results to return., locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, brief: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., setBack: int=0 # 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.}\n@returns(200) A list of selected occupants that are near a given point in order of closest to farther. Each occupant is returned as a Site Address Representation plus a Occupant Representation\n\n@endgroup\n\n@group intersections\n@endpoint GET /intersections/near.{outputFormat}\n@desc Find intersections near to a geographic point\n@required {point: str # 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., outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS}\n@optional {maxDistance: int # The maximum distance (in metres) to search from the given point.  If not specified, the search distance is unlimited., maxResults: int=1 # The maximum number of search results to return., minDegree: int=2 # The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1., maxDegree: int=100 # The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.}\n@returns(200) A list of selected intersections near a given point. Each intersection is in Intersection Address Representation\n\n@endgroup\n\n@group sites\n@endpoint GET /sites/within.{outputFormat}\n@desc Find sites in a geographic area\n@required {bbox: str # A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox}\n@optional {outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, maxResults: int=1 # The maximum number of search results to return., locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, setBack: int=0 # 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: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., excludeUnits: bool=false # If true, excludes sites that are units of a parent site, onlyCivic: bool=false # If true, excludes sites without a civic address}\n@returns(200) A list of selected sites within a given area. Each site in the response document is structured as a Site Address Representation\n\n@endgroup\n\n@group occupants\n@endpoint GET /occupants/within.{outputFormat}\n@desc Find occupants of sites in a geographic area\n@required {bbox: str # A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox}\n@optional {tags: str # Example: schools;courts;employmentA list of tags separated by semicolons., outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, maxResults: int=200 # The maximum number of search results to return., locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, brief: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., setBack: int=0 # 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.}\n@returns(200) A list of selected occupants within the given area. Each occupant is returned in a Site Address Representation plus Occupant Representation\n\n@endgroup\n\n@group intersections\n@endpoint GET /intersections/within.{outputFormat}\n@desc Find intersections in a geographic area\n@required {bbox: str # A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox}\n@optional {outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, maxResults: int=200 # The maximum number of search results, minDegree: int=2 # The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1., maxDegree: int=100 # The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.}\n@returns(200) A list of selected intersections within the given area. Each intersection is in Each intersection is in Intersection Address Representation\n\n@endgroup\n\n@group sites\n@endpoint GET /sites/{siteID}/subsites.{outputFormat}\n@desc Represents all subsites of a given site\n@required {siteID: str # A unique, but not immutable, site identifier.}\n@optional {outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, brief: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., setBack: int=0 # 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.}\n@returns(200) Returns all subsites of a given site in Site Address Representation\n\n@endpoint GET /sites/{siteID}.{outputFormat}\n@desc Get a site by its unique ID\n@required {siteID: str # A unique, but not immutable, site identifier.}\n@optional {outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, brief: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., setBack: int=0 # 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.}\n@returns(200) The site with the requested siteID in Site Address Representation\n\n@endgroup\n\n@group occupants\n@endpoint GET /occupants/{occupantID}.{outputFormat}\n@desc Get an occupant (of a site) by its unique ID\n@required {occupantID: str # Occupant identifier}\n@optional {outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, locationDescriptor: str(any/accessPoint/frontDoorPoint/parcelPoint/rooftopPoint/routingPoint)=any # Describes the nature of the address location. See locationDescriptor, brief: bool=false # If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats., setBack: int=0 # 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.}\n@returns(200) The occupant with the requested occupantID in Site Address Representation plus Occupant Representation\n\n@endgroup\n\n@group parcels\n@endpoint GET /parcels/pids/{siteID}.{outputFormat}\n@desc Get a comma-separated string of all pids for a given site\n@required {siteID: str # A unique, but not immutable, site identifier.}\n@returns(200) A comma-separated string containing all the parcel identifiers associated with the requested siteID\n\n@endgroup\n\n@group intersections\n@endpoint GET /intersections/{intersectionID}.{outputFormat}\n@desc Get an intersection by its unique ID\n@required {intersectionID: str # A unique intersection identifier}\n@optional {outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS}\n@returns(200) The Intersection with the requested intersectionID in Intersection Address Representation\n\n@endgroup\n\n@end\n"}