{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:gov-bc-ca-bcgnws/get-feature-categories":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_feature_categories","summary":"Get all feature categories","description":"GET /featureCategories","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml"],"default":"json","description":"The format of the output."},"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-feature-classes":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_feature_classes","summary":"Get all feature classes","description":"GET /featureClasses","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml"],"default":"json","description":"The format of the output."},"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-feature-types":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_feature_types","summary":"Get all feature types","description":"GET /featureTypes","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml"],"default":"json","description":"The format of the output."},"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-features-feature-id":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_features_feature_id","summary":"Get a feature by its featureId","description":"GET /features/{featureId}","tags":["open-data"],"parameters":[{"name":"featureId","in":"query","required":true,"description":"The unique identifier for a feature","schema":{"type":"integer","description":"The unique identifier for a feature"},"example":8879}],"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-name-authorities":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_name_authorities","summary":"Get all name authorities","description":"GET /nameAuthorities","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml"],"default":"json","description":"The format of the output."},"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-names-changes":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_names_changes","summary":"Search for names with metadata changes in a given period","description":"GET /names/changes","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml","kml","csv"],"default":"json","description":"The format of the output."},"example":"json"},{"name":"fromDate","in":"query","required":true,"description":"Defines the earliest date (YYYY-MM-DD format) of the change time window for the search","schema":{"type":"integer","description":"Defines the earliest date (YYYY-MM-DD format) of the change time window for the search"},"example":"2025-10-15T13:51:40.925Z"},{"name":"toDate","in":"query","required":true,"description":"Defines the latest date (YYYY-MM-DD format) of the change time window for the search","schema":{"type":"integer","description":"Defines the latest date (YYYY-MM-DD format) of the change time window for the search"},"example":"2025-10-15T13:51:40.925Z"},{"name":"featureClass","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…"}},{"name":"featureCategory","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…"}},{"name":"featureType","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…"}},{"name":"sortBy","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":"string","enum":["name","featureType","decisionDate"],"default":"name","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.","schema":{"type":"integer","enum":[4326,4269,3005,3857,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries."}},{"name":"embed","in":"query","required":false,"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name","schema":{"type":"integer","enum":[0,1],"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name"}},{"name":"outputStyle","in":"query","required":false,"description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…","schema":{"type":"string","enum":["summary","detail"],"default":"summary","description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…"}},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of search results to return (1-200)","schema":{"type":"integer","default":20,"description":"The number of search results to return (1-200)"}},{"name":"startIndex","in":"query","required":false,"description":"The index of the first record to be returned (>= 1)","schema":{"type":"integer","default":1,"description":"The index of the first record to be returned (>= 1)"}}],"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-names-decisions-recent":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_names_decisions_recent","summary":"Search for names affected by recent naming decision","description":"GET /names/decisions/recent","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml","kml","csv"],"default":"json","description":"The format of the output."},"example":"json"},{"name":"days","in":"query","required":true,"description":"The number of days used to define the time window of naming decisions to search. The number is interpreted as searching for 'names…","schema":{"type":"integer","default":30,"description":"The number of days used to define the time window of naming decisions to search. The number is interpreted as searching for 'names…"},"example":"30"},{"name":"featureClass","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…"}},{"name":"featureCategory","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…"}},{"name":"featureType","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…"}},{"name":"sortBy","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":"string","enum":["name","featureType","decisionDate"],"default":"name","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.","schema":{"type":"integer","enum":[4326,4269,3005,3857,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries."}},{"name":"embed","in":"query","required":false,"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name","schema":{"type":"integer","enum":[0,1],"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name"}},{"name":"outputStyle","in":"query","required":false,"description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…","schema":{"type":"string","enum":["summary","detail"],"default":"summary","description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…"}},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of search results to return (1-200)","schema":{"type":"integer","default":20,"description":"The number of search results to return (1-200)"}},{"name":"startIndex","in":"query","required":false,"description":"The index of the first record to be returned (>= 1)","schema":{"type":"integer","default":1,"description":"The index of the first record to be returned (>= 1)"}}],"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-names-decisions-year":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_names_decisions_year","summary":"Search for names affected by naming decisions in a given year","description":"GET /names/decisions/year","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml","kml","csv"],"default":"json","description":"The format of the output."},"example":"json"},{"name":"year","in":"query","required":true,"description":"The year in which to search for names affected by naming decisions'.","schema":{"type":"integer","description":"The year in which to search for names affected by naming decisions'."},"example":"2007"},{"name":"featureClass","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…"}},{"name":"featureCategory","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…"}},{"name":"featureType","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…"}},{"name":"sortBy","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":"string","enum":["name","featureType","decisionDate"],"default":"name","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.","schema":{"type":"integer","enum":[4326,4269,3005,3857,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries."}},{"name":"embed","in":"query","required":false,"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name","schema":{"type":"integer","enum":[0,1],"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name"}},{"name":"outputStyle","in":"query","required":false,"description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…","schema":{"type":"string","enum":["summary","detail"],"default":"summary","description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…"}},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of search results to return (1-200)","schema":{"type":"integer","default":20,"description":"The number of search results to return (1-200)"}},{"name":"startIndex","in":"query","required":false,"description":"The index of the first record to be returned (>= 1)","schema":{"type":"integer","default":1,"description":"The index of the first record to be returned (>= 1)"}}],"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-names-inside":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_names_inside","summary":"Search in a geographic area","description":"GET /names/inside","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml","kml","csv"],"default":"json","description":"The format of the output."},"example":"json"},{"name":"bbox","in":"query","required":true,"description":"A geographic bounding box defining the search area. Must be specified as a string of the form…","schema":{"type":"string","description":"A geographic bounding box defining the search area. Must be specified as a string of the form…"},"example":"-119,49,-118,50"},{"name":"featureClass","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…"}},{"name":"featureCategory","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…"}},{"name":"featureType","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…"}},{"name":"sortBy","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":"string","enum":["name","featureType","decisionDate"],"default":"name","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.","schema":{"type":"integer","enum":[4326,4269,3005,3857,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries."}},{"name":"embed","in":"query","required":false,"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name","schema":{"type":"integer","enum":[0,1],"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name"}},{"name":"outputStyle","in":"query","required":false,"description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…","schema":{"type":"string","enum":["summary","detail"],"default":"summary","description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…"}},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of search results to return (1-200)","schema":{"type":"integer","default":20,"description":"The number of search results to return (1-200)"}},{"name":"startIndex","in":"query","required":false,"description":"The index of the first record to be returned (>= 1)","schema":{"type":"integer","default":1,"description":"The index of the first record to be returned (>= 1)"}}],"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-names-near":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_names_near","summary":"Search near to a geographic point","description":"GET /names/near","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml","kml","csv"],"default":"json","description":"The format of the output."},"example":"-119,49,-118,50"},{"name":"featurePoint","in":"query","required":true,"description":"A geographic coordinate specifying the centre point of the search area. Must be specified as a string of the form 'longitude,latitude'…","schema":{"type":"string","description":"A geographic coordinate specifying the centre point of the search area. Must be specified as a string of the form 'longitude,latitude'…"},"example":"-120,51"},{"name":"distance","in":"query","required":true,"description":"A radius (in kilometres) around the centre point.","schema":{"type":"string","description":"A radius (in kilometres) around the centre point."}},{"name":"featureClass","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…"}},{"name":"featureCategory","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…"}},{"name":"featureType","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…"}},{"name":"sortBy","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":"string","enum":["name","featureType","decisionDate"],"default":"name","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.","schema":{"type":"integer","enum":[4326,4269,3005,3857,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries."}},{"name":"embed","in":"query","required":false,"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name","schema":{"type":"integer","enum":[0,1],"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name"}},{"name":"outputStyle","in":"query","required":false,"description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…","schema":{"type":"string","enum":["summary","detail"],"default":"summary","description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…"}},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of search results to return (1-200)","schema":{"type":"integer","default":20,"description":"The number of search results to return (1-200)"}},{"name":"startIndex","in":"query","required":false,"description":"The index of the first record to be returned (>= 1)","schema":{"type":"integer","default":1,"description":"The index of the first record to be returned (>= 1)"}}],"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-names-not-official-search":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_names_not_official_search","summary":"Search by name, limit to unofficial names only","description":"GET /names/notOfficial/search","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml","kml","csv"],"default":"json","description":"The format of the output."},"example":"json"},{"name":"name","in":"query","required":true,"description":"A filter to search based on the the text of the name itself. Use the asterisk (*) as a wildcard character. For example 'vancouv*'","schema":{"type":"string","description":"A filter to search based on the the text of the name itself. Use the asterisk (*) as a wildcard character. For example 'vancouv*'"},"example":"Victoria"},{"name":"exactSpelling","in":"query","required":false,"description":"If the 'name' parameter is specified, 'exactSpelling' specifies whether to include only names that exactly match the search text…","schema":{"type":"integer","enum":[0,1],"default":0,"description":"If the 'name' parameter is specified, 'exactSpelling' specifies whether to include only names that exactly match the search text…"}},{"name":"featureClass","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…"}},{"name":"featureCategory","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…"}},{"name":"featureType","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…"}},{"name":"sortBy","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":"string","enum":["relevance","name","featureType","decisionDate"],"default":"relevance","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.","schema":{"type":"integer","enum":[4326,4269,3005,3857,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries."}},{"name":"embed","in":"query","required":false,"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name","schema":{"type":"integer","enum":[0,1],"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name"}},{"name":"outputStyle","in":"query","required":false,"description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…","schema":{"type":"string","enum":["summary","detail"],"default":"summary","description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…"}},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of search results to return (1-200)","schema":{"type":"integer","default":20,"description":"The number of search results to return (1-200)"}},{"name":"startIndex","in":"query","required":false,"description":"The index of the first record to be returned (>= 1)","schema":{"type":"integer","default":1,"description":"The index of the first record to be returned (>= 1)"}}],"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-names-official-search":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_names_official_search","summary":"Search by name, limit to official names only","description":"GET /names/official/search","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml","kml","csv"],"default":"json","description":"The format of the output."},"example":"json"},{"name":"name","in":"query","required":true,"description":"A filter to search based on the the text of the name itself. Use the asterisk (*) as a wildcard character. For example 'vancouv*'","schema":{"type":"string","description":"A filter to search based on the the text of the name itself. Use the asterisk (*) as a wildcard character. For example 'vancouv*'"},"example":"Victoria"},{"name":"exactSpelling","in":"query","required":false,"description":"If the 'name' parameter is specified, 'exactSpelling' specifies whether to include only names that exactly match the search text…","schema":{"type":"integer","enum":[0,1],"default":0,"description":"If the 'name' parameter is specified, 'exactSpelling' specifies whether to include only names that exactly match the search text…"}},{"name":"featureClass","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…"}},{"name":"featureCategory","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…"}},{"name":"featureType","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…"}},{"name":"sortBy","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":"string","enum":["relevance","name","featureType","decisionDate"],"default":"relevance","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.","schema":{"type":"integer","enum":[4326,4269,3005,3857,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries."}},{"name":"embed","in":"query","required":false,"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name","schema":{"type":"integer","enum":[0,1],"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name"}},{"name":"outputStyle","in":"query","required":false,"description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…","schema":{"type":"string","enum":["summary","detail"],"default":"summary","description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…"}},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of search results to return (1-200)","schema":{"type":"integer","default":20,"description":"The number of search results to return (1-200)"}},{"name":"startIndex","in":"query","required":false,"description":"The index of the first record to be returned (>= 1)","schema":{"type":"integer","default":1,"description":"The index of the first record to be returned (>= 1)"}}],"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-names-search":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_names_search","summary":"Search by name","description":"GET /names/search","tags":["open-data"],"parameters":[{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml","kml","csv"],"default":"json","description":"The format of the output."},"example":"json"},{"name":"name","in":"query","required":true,"description":"A filter to search based on the the text of the name itself. Use the asterisk (*) as a wildcard character. For example 'vancouv*'","schema":{"type":"string","description":"A filter to search based on the the text of the name itself. Use the asterisk (*) as a wildcard character. For example 'vancouv*'"},"example":"Victoria"},{"name":"exactSpelling","in":"query","required":false,"description":"If the 'name' parameter is specified, 'exactSpelling' specifies whether to include only names that exactly match the search text…","schema":{"type":"integer","enum":[0,1],"default":0,"description":"If the 'name' parameter is specified, 'exactSpelling' specifies whether to include only names that exactly match the search text…"}},{"name":"featureClass","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'class' The value of this parameter should be a…"}},{"name":"featureCategory","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'category' The value of this parameter should be a…"}},{"name":"featureType","in":"query","required":false,"description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…","schema":{"type":"string","default":"*","description":"A filter to limit the search to names associated with features of a certain 'type' The value of this parameter should be a…"}},{"name":"sortBy","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":"string","enum":["relevance","name","featureType","decisionDate"],"default":"relevance","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.","schema":{"type":"integer","enum":[4326,4269,3005,3857,26907,26908,26909,26910,26911],"default":4326,"description":"The EPSG code of the spatial reference system (SRS) to use for output geometries."}},{"name":"embed","in":"query","required":false,"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name","schema":{"type":"integer","enum":[0,1],"description":"A flag to indicate whether to embed the corresponding 'feature' into each matching name"}},{"name":"outputStyle","in":"query","required":false,"description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…","schema":{"type":"string","enum":["summary","detail"],"default":"summary","description":"A flag indicating whether to include with each matching name a succinct list of attributes (summary), or a comprehensive list of…"}},{"name":"itemsPerPage","in":"query","required":false,"description":"The number of search results to return (1-200)","schema":{"type":"integer","default":20,"description":"The number of search results to return (1-200)"}},{"name":"startIndex","in":"query","required":false,"description":"The index of the first record to be returned (>= 1)","schema":{"type":"integer","default":1,"description":"The index of the first record to be returned (>= 1)"}}],"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":"live"}},"/v1/open-data:gov-bc-ca-bcgnws/get-names-name-id-output-format":{"get":{"operationId":"open_data_gov_bc_ca_bcgnws_get_names_name_id_output_format","summary":"Get a name by its nameId","description":"GET /names/{nameId}.{outputFormat}","tags":["open-data"],"parameters":[{"name":"nameId","in":"query","required":true,"description":"The unique identifier for a name","schema":{"type":"integer","description":"The unique identifier for a name"},"example":22474},{"name":"outputFormat","in":"query","required":true,"description":"The format of the output.","schema":{"type":"string","enum":["json","xml","kml","csv","html"],"default":"json","description":"The format of the output."},"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":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"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"}}}}}}}