Find matching occupant tags

GET

/occupants/tags

const url = 'https://geocoder.api.gov.bc.ca/occupants/tags?tag=restaurant&maxResults=6';
const options = {method: 'GET', headers: {apikey: '<apikey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://geocoder.api.gov.bc.ca/occupants/tags?tag=restaurant&maxResults=6' \
  --header 'apikey: <apikey>'

Returns a list of occupant tags (business names or categories) that match the given search string. Useful for auto-complete or tag lookup. Returns up to maxResults matching tags.

Authorizations

apikey

Parameters

Query Parameters

tag

string

The tag search string to match (prefix match).

Example

restaurant

maxResults

string

default: 6

The maximum number of matching tags to return.

Responses

200

A list of matching tag strings.

*/*

Array<string>