address

Suggest Addresses for the given search term

If your municipality has supplied ReCollect with specific address data, then the ReCollect address suggest API can be used to search for addresses to avoid needing geocoding.

This method will return an array of possible address matches. Each match will include a parcel_id attribute. This attribute can be used to lookup service details, but it should not be used as a permanent identifier, as it may change in the future. Only the place_id should be used as a permanent, external identifier.

Once you have a parcel_id, you can look up service details using the HTTP GET /api/places API.

get/areas/{area_id}/services/{svc_id}/address-suggest

Request

  • Base URL: https://api.recollect.net/api
  • URL: https://api.recollect.net/api/areas/{area_id}/services/{svc_id}/address-suggest
  • Auth: none declared

Path parameters

area_idstring required

Area ID or Area name can be used.

svc_idstring required

Service ID. When used with an Area, a Service name (like "waste") can be used.

Query parameters

qstring required

Query string - the address you are searching for. (Example: "123 Main st")

localestring

The locale code for this request. (eg: "en" or "fr")

offsetinteger

Skip this number of results from the beginning of the list

limitinteger

Return at most this number of results

Response

200 OK

parcel_idstring
place_idstring
area_idinteger
namestring

Changes

No recorded changes to this operation across all 1 revision of this API.