Search

Base URLs:

• https://apis.lightstone.co.za/lspsearch/v1

AutoComplete

Perfect for auto-complete scenarios.

GET /complete

or

GET /complete/extend

Search fields include : Street number, Street name, Street type, Suburb name, Estate Name, Sectional scheme unit number, sectional scheme unit name, Erf number, Portion Number, Township name, Municipality, Province.

Parameters

Name	In	Type	Required	Description
query	query	string	false	To be used for search as you type
rowlimit	query	integer	false	Format - int32. Number of records to be returned.
tophits	query	integer	false	Format - int32. Number of Records to be returned per context.
relevanceScore	query	integer	false	Format - int32. Record score needs to be greater then relevence score to be returned.
filter	query	array	false	Contexts to filter.
validatedonly	query	string	false	Type to filter on ( “true”, “false”, “all” )
includeassociations	query	boolean	false	Include associations.
useSearchAsYouType	query	boolean	false	Use search-as-you-type.

tophits: Format - int32. Number of Records to be returned per ( “suburb”, “street”, “sectionalscheme”, “property”, “municipality”, “estate”, “town”, “legalentity”)

filter: Contexts to filter on ( “suburb”, “street”, “sectionalscheme”, “property”, “municipality”, “estate”, “town”, “legalentity” )

Feedback

PLEASE NORE THIS API IS STILL IN BETA

The Lightstone Search API allows customers to send feedback using REST calls. There are several types of feedback that are supported by the current system. In order to follow up on feedback, a reference ID will be returned once it has been submitted.

Feedback generally falls into three categories:

The address or place you were searching for could not be found, and you would either like to add a missing place or manually enter the address.

An address has been found using the search API, but additional information is needed, such as building and floor numbers, delivery instructions, etc. A change has occurred (for example, the name of a street has changed, etc.).

Lastly, there is general feedback (about a product, company, etc.) and results (such as reviews, questions, etc.).

With our feedback API, you can send a very flexible payload with very few restrictions. You only need to send a dictionary of key/value pairs and the type of feedback you are submitting. Each of these key-value pairs follows a simple pattern, and there are no restrictions on which fields are actually required!

POST /feedback?type=

This method exposes the feedback call. You should call it after determining that the address was not located using Lightstone Search, or the address returned was the wrong address, in your opinion.

Metadata (body)

• selected_item_*

• selected_item_id

• selected_item_name

• selected_item_description

• selected_item_type

• selected_item_sub_type

• selected_item_center_lat

• selected_item_center_lng

• selected_item_validated

• feedback_*

• feedback_place_name

• feedback_place_address

• feedback_additional_information

• feedback_user_email

• map_*

• map_center_lat

• map_center_lng

• map_zoom

• map_bounds