{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:gov-bc-ca-geocoder/get-addresses-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_addresses_output_format","summary":"Geocode an address","description":"GET /addresses.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"addressString","in":"query","required":false,"description":"Civic or intersection address as a single string. See addressString","schema":{"type":"string","description":"Civic or intersection address as a single string. See addressString"},"example":"525 Superior Street, Victoria, BC"},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of search results to return.","schema":{"type":"integer","default":1,"description":"The maximum number of search results to return."}},{"name":"interpolation","in":"query","required":false,"description":"accessPoint interpolation method. See interpolation","schema":{"type":"string","enum":["adaptive","linear","none"],"default":"adaptive","description":"accessPoint interpolation method. See interpolation"}},{"name":"echo","in":"query","required":false,"description":"If true, include unmatched address details such as site name in results.","schema":{"type":"boolean","default":true,"description":"If true, include unmatched address details such as site name in results."}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"autoComplete","in":"query","required":false,"description":"If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats.","schema":{"type":"boolean","default":false,"description":"If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats."}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"minScore","in":"query","required":false,"description":"The minimum score required for a match to be returned. See minScore","schema":{"type":"integer","default":1,"description":"The minimum score required for a match to be returned. See minScore"}},{"name":"matchPrecision","in":"query","required":false,"description":"Example: street,locality. A comma separated list of individual match precision levels to include in results. See matchPrecision","schema":{"type":"string","description":"Example: street,locality. A comma separated list of individual match precision levels to include in results. See matchPrecision"}},{"name":"matchPrecisionNot","in":"query","required":false,"description":"Example: street,locality. A comma separated list of individual match precision levels to exclude from results. See matchPrecisionNot","schema":{"type":"string","description":"Example: street,locality. A comma separated list of individual match precision levels to exclude from results. See matchPrecisionNot"}},{"name":"siteName","in":"query","required":false,"description":"A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird…","schema":{"type":"string","description":"A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird…"}},{"name":"unitDesignator","in":"query","required":false,"description":"The type of unit within a house or building. See unitDesignator","schema":{"type":"string","enum":["APT","BLDG","BSMT","FLR","LOBBY","LWR","PAD","PH","REAR","RM","SIDE","SITE","SUITE","TH","UNIT","UPPR"],"description":"The type of unit within a house or building. See unitDesignator"}},{"name":"unitNumber","in":"query","required":false,"description":"The number of the unit, suite, or apartment within a house or building.","schema":{"type":"string","description":"The number of the unit, suite, or apartment within a house or building."}},{"name":"unitNumberSuffix","in":"query","required":false,"description":"A letter that follows the unit number as in Unit 1A or Suite 302B.","schema":{"type":"string","description":"A letter that follows the unit number as in Unit 1A or Suite 302B."}},{"name":"civicNumber","in":"query","required":false,"description":"The official number assigned to a site by an address authority. See civicNumber","schema":{"type":"string","description":"The official number assigned to a site by an address authority. See civicNumber"}},{"name":"civicNumberSuffix","in":"query","required":false,"description":"A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See civicNumberSuffix","schema":{"type":"string","description":"A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See civicNumberSuffix"}},{"name":"streetName","in":"query","required":false,"description":"The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See streetName","schema":{"type":"string","description":"The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See streetName"}},{"name":"streetType","in":"query","required":false,"description":"The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See streetType","schema":{"type":"string","description":"The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See streetType"}},{"name":"streetDirection","in":"query","required":false,"description":"The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities. See streetDirection","schema":{"type":"string","enum":["N","S","E","W","O","NE","NO","NW","SE","SO","SW"],"description":"The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities. See streetDirection"}},{"name":"streetQualifier","in":"query","required":false,"description":"Example: the Bridge in Johnson St Bridge. The qualifier of a street name. See streetQualifier","schema":{"type":"string","description":"Example: the Bridge in Johnson St Bridge. The qualifier of a street name. See streetQualifier"}},{"name":"localityName","in":"query","required":false,"description":"The name of the locality assigned to a given site by an address authority. See localityName","schema":{"type":"string","description":"The name of the locality assigned to a given site by an address authority. See localityName"}},{"name":"provinceCode","in":"query","required":false,"description":"The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC.","schema":{"type":"string","default":"BC","description":"The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC."}},{"name":"localities","in":"query","required":false,"description":"A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns…","schema":{"type":"string","description":"A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns…"}},{"name":"notLocalities","in":"query","required":false,"description":"A comma-separated list of localities to exclude from the search.","schema":{"type":"string","description":"A comma-separated list of localities to exclude from the search."}},{"name":"bbox","in":"query","required":false,"description":"Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See bbox","schema":{"type":"string","description":"Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See bbox"}},{"name":"centre","in":"query","required":false,"description":"Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search…","schema":{"type":"string","description":"Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search…"}},{"name":"maxDistance","in":"query","required":false,"description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.","schema":{"type":"number","description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited."}},{"name":"extrapolate","in":"query","required":false,"description":"If true, uses supplied parcelPoint to derive an appropriate accessPoint. See extrapolate","schema":{"type":"boolean","description":"If true, uses supplied parcelPoint to derive an appropriate accessPoint. See extrapolate"}},{"name":"parcelPoint","in":"query","required":false,"description":"The coordinates of a point (x,y) known to be inside the parcel containing a given address. See parcelPoint","schema":{"type":"string","description":"The coordinates of a point (x,y) known to be inside the parcel containing a given address. See parcelPoint"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-intersections-near-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_intersections_near_output_format","summary":"Find intersections near to a geographic point","description":"GET /intersections/near.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"point","in":"query","required":true,"description":"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…","schema":{"type":"string","description":"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…"},"example":"-122.377,50.121"},{"name":"maxDistance","in":"query","required":false,"description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.","schema":{"type":"integer","description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited."}},{"name":"outputSRS","in":"query","required":true,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of search results to return.","schema":{"type":"integer","default":1,"description":"The maximum number of search results to return."}},{"name":"minDegree","in":"query","required":false,"description":"The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.","schema":{"type":"integer","default":2,"description":"The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1."}},{"name":"maxDegree","in":"query","required":false,"description":"The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.","schema":{"type":"integer","default":100,"description":"The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-intersections-nearest-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_intersections_nearest_output_format","summary":"Find nearest intersection to a geographic point","description":"GET /intersections/nearest.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"point","in":"query","required":true,"description":"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…","schema":{"type":"string","description":"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…"},"example":"-122.377,50.121"},{"name":"maxDistance","in":"query","required":false,"description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.","schema":{"type":"integer","description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited."}},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"minDegree","in":"query","required":false,"description":"The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.","schema":{"type":"integer","default":2,"description":"The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1."}},{"name":"maxDegree","in":"query","required":false,"description":"The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.","schema":{"type":"integer","default":100,"description":"The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-intersections-within-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_intersections_within_output_format","summary":"Find intersections in a geographic area","description":"GET /intersections/within.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"bbox","in":"query","required":true,"description":"A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox","schema":{"type":"string","description":"A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox"},"example":"-119.51,49.48,-119.53,49.50"},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of search results","schema":{"type":"integer","default":200,"description":"The maximum number of search results"}},{"name":"minDegree","in":"query","required":false,"description":"The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.","schema":{"type":"integer","default":2,"description":"The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1."}},{"name":"maxDegree","in":"query","required":false,"description":"The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.","schema":{"type":"integer","default":100,"description":"The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-intersections-intersection-id-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_intersections_intersection_id_output_format","summary":"Get an intersection by its unique ID","description":"GET /intersections/{intersectionID}.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"intersectionID","in":"query","required":true,"description":"A unique intersection identifier","schema":{"type":"string","description":"A unique intersection identifier"}},{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-occupants-addresses-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_occupants_addresses_output_format","summary":"Geocode an address and identify site occupants","description":"GET /occupants/addresses.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"addressString","in":"query","required":false,"description":"Occupant name OR Occupant name ** address","schema":{"type":"string","description":"Occupant name OR Occupant name ** address"},"example":"Sir James Douglas Elementary"},{"name":"tags","in":"query","required":false,"description":"Example: schools;courts;employment A list of tags separated by semicolons.","schema":{"type":"string","description":"Example: schools;courts;employment A list of tags separated by semicolons."}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of search results to return.","schema":{"type":"integer","default":1,"description":"The maximum number of search results to return."}},{"name":"interpolation","in":"query","required":false,"description":"accessPoint interpolation method. See interpolation","schema":{"type":"string","enum":["adaptive","linear","none"],"default":"adaptive","description":"accessPoint interpolation method. See interpolation"}},{"name":"echo","in":"query","required":false,"description":"If true, include unmatched address details such as site name in results.","schema":{"type":"boolean","default":false,"description":"If true, include unmatched address details such as site name in results."}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"autoComplete","in":"query","required":false,"description":"If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats.","schema":{"type":"boolean","default":false,"description":"If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats."}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"minScore","in":"query","required":false,"description":"The minimum score required for a match to be returned. See minScore","schema":{"type":"integer","default":1,"description":"The minimum score required for a match to be returned. See minScore"}},{"name":"matchPrecision","in":"query","required":false,"description":"Example: street,locality. A comma separated list of individual match precision levels to include in results. See matchPrecision","schema":{"type":"string","default":"OCCUPANT","description":"Example: street,locality. A comma separated list of individual match precision levels to include in results. See matchPrecision"}},{"name":"matchPrecisionNot","in":"query","required":false,"description":"Example: street,locality. A comma separated list of individual match precision levels to exclude from results. See matchPrecisionNot","schema":{"type":"string","description":"Example: street,locality. A comma separated list of individual match precision levels to exclude from results. See matchPrecisionNot"}},{"name":"siteName","in":"query","required":false,"description":"A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird…","schema":{"type":"string","description":"A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird…"}},{"name":"unitDesignator","in":"query","required":false,"description":"The type of unit within a house or building. See unitDesignator","schema":{"type":"string","enum":["APT","BLDG","BSMT","FLR","LOBBY","LWR","PAD","PH","REAR","RM","SIDE","SITE","SUITE","TH","UNIT","UPPR"],"description":"The type of unit within a house or building. See unitDesignator"}},{"name":"unitNumber","in":"query","required":false,"description":"The number of the unit, suite, or apartment within a house or building.","schema":{"type":"string","description":"The number of the unit, suite, or apartment within a house or building."}},{"name":"unitNumberSuffix","in":"query","required":false,"description":"A letter that follows the unit number as in Unit 1A or Suite 302B.","schema":{"type":"string","description":"A letter that follows the unit number as in Unit 1A or Suite 302B."}},{"name":"civicNumber","in":"query","required":false,"description":"The official number assigned to a site by an address authority. See civicNumber","schema":{"type":"string","description":"The official number assigned to a site by an address authority. See civicNumber"}},{"name":"civicNumberSuffix","in":"query","required":false,"description":"A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See civicNumberSuffix","schema":{"type":"string","description":"A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See civicNumberSuffix"}},{"name":"streetName","in":"query","required":false,"description":"The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See streetName","schema":{"type":"string","description":"The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See streetName"}},{"name":"streetType","in":"query","required":false,"description":"The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See streetType","schema":{"type":"string","description":"The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See streetType"}},{"name":"streetDirection","in":"query","required":false,"description":"The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities. See streetDirection","schema":{"type":"string","enum":["N","S","E","W","O","NE","NO","NW","SE","SO","SW"],"description":"The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities. See streetDirection"}},{"name":"streetQualifier","in":"query","required":false,"description":"The qualifier of a street name (e.g., the Bridge in Johnson St Bridge)","schema":{"type":"string","description":"The qualifier of a street name (e.g., the Bridge in Johnson St Bridge)"}},{"name":"localityName","in":"query","required":false,"description":"The name of the locality assigned to a given site by an address authority. See streetDirection","schema":{"type":"string","description":"The name of the locality assigned to a given site by an address authority. See streetDirection"}},{"name":"provinceCode","in":"query","required":false,"description":"The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC.","schema":{"type":"string","default":"BC","description":"The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC."}},{"name":"localities","in":"query","required":false,"description":"A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns…","schema":{"type":"string","description":"A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns…"}},{"name":"notLocalities","in":"query","required":false,"description":"A comma-separated list of localities to exclude from the search.","schema":{"type":"string","description":"A comma-separated list of localities to exclude from the search."}},{"name":"bbox","in":"query","required":false,"description":"Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See bbox","schema":{"type":"string","description":"Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See bbox"}},{"name":"centre","in":"query","required":false,"description":"Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search…","schema":{"type":"string","description":"Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search…"}},{"name":"maxDistance","in":"query","required":false,"description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.","schema":{"type":"number","description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited."}},{"name":"extrapolate","in":"query","required":false,"description":"If true, uses supplied parcelPoint to derive an appropriate accessPoint. See extrapolate","schema":{"type":"boolean","description":"If true, uses supplied parcelPoint to derive an appropriate accessPoint. See extrapolate"}},{"name":"parcelPoint","in":"query","required":false,"description":"The coordinates of a point (x,y) known to be inside the parcel containing a given address. See parcelPoint","schema":{"type":"string","description":"The coordinates of a point (x,y) known to be inside the parcel containing a given address. See parcelPoint"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-occupants-near-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_occupants_near_output_format","summary":"Find occupants of sites near to a geographic point","description":"GET /occupants/near.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"point","in":"query","required":true,"description":"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…","schema":{"type":"string","description":"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…"},"example":"-122.377,50.121"},{"name":"tags","in":"query","required":false,"description":"Example: schools;courts;employment A list of tags separated by semicolons.","schema":{"type":"string","description":"Example: schools;courts;employment A list of tags separated by semicolons."}},{"name":"maxDistance","in":"query","required":false,"description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.","schema":{"type":"integer","description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited."}},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of search results to return.","schema":{"type":"integer","default":1,"description":"The maximum number of search results to return."}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-occupants-nearest-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_occupants_nearest_output_format","summary":"Find occupants of the site nearest to a geographic point","description":"GET /occupants/nearest.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"point","in":"query","required":true,"description":"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…","schema":{"type":"string","description":"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…"},"example":"-122.377,50.121"},{"name":"maxDistance","in":"query","required":false,"description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.","schema":{"type":"integer","description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited."}},{"name":"tags","in":"query","required":false,"description":"Example: schools;courts;employment A list of tags separated by semicolons.","schema":{"type":"string","description":"Example: schools;courts;employment A list of tags separated by semicolons."}},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-occupants-within-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_occupants_within_output_format","summary":"Find occupants of sites in a geographic area","description":"GET /occupants/within.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"bbox","in":"query","required":true,"description":"A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox","schema":{"type":"string","description":"A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox"},"example":"-123.14,49.28,-123.13,49.29"},{"name":"tags","in":"query","required":false,"description":"Example: schools;courts;employment A list of tags separated by semicolons.","schema":{"type":"string","description":"Example: schools;courts;employment A list of tags separated by semicolons."}},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of search results to return.","schema":{"type":"integer","default":200,"description":"The maximum number of search results to return."}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-occupants-occupant-id-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_occupants_occupant_id_output_format","summary":"Get an occupant (of a site) by its unique ID","description":"GET /occupants/{occupantID}.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"occupantID","in":"query","required":true,"description":"Occupant identifier","schema":{"type":"string","description":"Occupant identifier"}},{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-parcels-pids-site-id-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_parcels_pids_site_id_output_format","summary":"Get a comma-separated string of all pids for a given site","description":"GET /parcels/pids/{siteID}.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"siteID","in":"query","required":true,"description":"A unique, but not immutable, site identifier.","schema":{"type":"string","description":"A unique, but not immutable, site identifier."}},{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-sites-near-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_sites_near_output_format","summary":"Find sites near to a geographic point","description":"GET /sites/near.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"point","in":"query","required":true,"description":"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…","schema":{"type":"string","description":"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…"},"example":"-122.377,50.121"},{"name":"maxDistance","in":"query","required":false,"description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.","schema":{"type":"integer","description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited."}},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of search results to return.","schema":{"type":"integer","default":1,"description":"The maximum number of search results to return."}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"excludeUnits","in":"query","required":false,"description":"If true, excludes sites that are units of a parent site","schema":{"type":"boolean","default":false,"description":"If true, excludes sites that are units of a parent site"}},{"name":"onlyCivic","in":"query","required":false,"description":"If true, excludes sites without a civic address","schema":{"type":"boolean","default":false,"description":"If true, excludes sites without a civic address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-sites-nearest-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_sites_nearest_output_format","summary":"Find the site nearest to a geographic point","description":"GET /sites/nearest.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"point","in":"query","required":true,"description":"Centre point of search. See point","schema":{"type":"string","description":"Centre point of search. See point"},"example":"-122.377,50.121"},{"name":"maxDistance","in":"query","required":false,"description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.","schema":{"type":"integer","description":"The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited."}},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"excludeUnits","in":"query","required":false,"description":"If true, excludes sites that are units of a parent site","schema":{"type":"boolean","default":false,"description":"If true, excludes sites that are units of a parent site"}},{"name":"onlyCivic","in":"query","required":false,"description":"If true, excludes sites without a civic address","schema":{"type":"boolean","default":false,"description":"If true, excludes sites without a civic address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-sites-within-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_sites_within_output_format","summary":"Find sites in a geographic area","description":"GET /sites/within.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"bbox","in":"query","required":true,"description":"A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox","schema":{"type":"string","description":"A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See bbox"},"example":"-119.51,49.48,-119.53,49.50"},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of search results to return.","schema":{"type":"integer","default":1,"description":"The maximum number of search results to return."}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"excludeUnits","in":"query","required":false,"description":"If true, excludes sites that are units of a parent site","schema":{"type":"boolean","default":false,"description":"If true, excludes sites that are units of a parent site"}},{"name":"onlyCivic","in":"query","required":false,"description":"If true, excludes sites without a civic address","schema":{"type":"boolean","default":false,"description":"If true, excludes sites without a civic address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-sites-site-id-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_sites_site_id_output_format","summary":"Get a site by its unique ID","description":"GET /sites/{siteID}.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"siteID","in":"query","required":true,"description":"A unique, but not immutable, site identifier.","schema":{"type":"string","description":"A unique, but not immutable, site identifier."}},{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"},"example":"json"},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:gov-bc-ca-geocoder/get-sites-site-id-subsites-output-format":{"get":{"operationId":"open_data_gov_bc_ca_geocoder_get_sites_site_id_subsites_output_format","summary":"Represents all subsites of a given site","description":"GET /sites/{siteID}/subsites.{outputFormat}","tags":["open-data"],"x-apizie-access":"read","parameters":[{"name":"siteID","in":"query","required":true,"description":"A unique, but not immutable, site identifier.","schema":{"type":"string","description":"A unique, but not immutable, site identifier."}},{"name":"outputFormat","in":"query","required":true,"description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)","schema":{"type":"string","enum":["json","geojson","xhtml","kml","gml","csv","shpz"],"default":"json","description":"Results format. See outputFormat . Note: GeoJSON and KML formats only support EPSG:4326 (outputSRS=4326)"}},{"name":"outputSRS","in":"query","required":false,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS","schema":{"type":"integer","enum":[4326,4269,3005,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS"}},{"name":"locationDescriptor","in":"query","required":false,"description":"Describes the nature of the address location. See locationDescriptor","schema":{"type":"string","enum":["any","accessPoint","frontDoorPoint","parcelPoint","rooftopPoint","routingPoint"],"default":"any","description":"Describes the nature of the address location. See locationDescriptor"}},{"name":"brief","in":"query","required":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.","schema":{"type":"boolean","default":false,"description":"If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats."}},{"name":"setBack","in":"query","required":false,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…","schema":{"type":"integer","default":0,"description":"The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}