v1

latestOpenAPI 3.1.02026-08-04123846.7 KB

Property

Search for properties using the stored procedure address filters.

Args: filters: Collection of optional address filters such as StreetName or PostalCode that are forwarded to :data:~services.stored_procedures.USP_SEARCH_SERVICE_PROPERTY.

Returns:
    A list of :class:`PropertySearchResult` objects containing normalized
    PID, jurisdiction, address, and actual use type information.

Business Rules:
    * A ``404`` response is returned when the underlying search yields no
      rows.

get/property/search

Query parameters

unit_numberstring nullable

street_directionstring nullable

street_numberstring nullable

street_namestring nullable

postal_codestring nullable

Response

Successful Response

pidstring nullable

Parcel identifier (PID) returned by the property search result.

jurisdictionstring nullable

Jurisdiction name returned by the search.

addressstring nullable

Formatted address string supplied by the stored procedure.

actual_use_typestring nullable

Detailed actual use type classification from the source data.

Example response

[
  {
    "pid": "012-345-678",
    "jurisdiction": "Vancouver",
    "address": "123 W MAIN ST VANCOUVER BC",
    "actual_use_type": "Dwelling - Single Family"
  }
]