PrivateProperty

get/privateproperty/listings/search

Request

  • Base URL: https://scrappa.co/api
  • URL: https://scrappa.co/api/privateproperty/listings/search
  • Auth: API key in header X-API-KEY

Query parameters

type'residential' | 'commercial' | 'farm'

residential, commercial, or farm. Default residential.

deal_type'sale' | 'rent'

sale or rent. Default sale.

location_idinteger

Location id from locations/children or locations/autocomplete.

location_namestring nullable

Name of the chosen location, used for display.

location_descriptorstring nullable

Parent region of the chosen location, used for display.

location_shape_typeinteger nullable

Shape type of the chosen location, used for display.

min_priceinteger nullable

Minimum price in rand.

max_priceinteger nullable

Maximum price in rand.

min_bedroomsinteger nullable

Minimum bedrooms. Residential only.

min_bathsinteger nullable

Minimum bathrooms. Residential only.

rental_price_type'PerMonth' | 'PerWeek' | 'PerDay' | 'PerSquareMetre' | 'null' nullable

PerMonth, PerWeek, PerDay, or PerSquareMetre. Requires deal_type=rent.

pageinteger

Page number, starting at 1.

has_poolboolean

Restrict to listings with a pool. Residential only.

has_staff_quartersboolean

Restrict to listings with staff quarters. Residential only.

has_flatletsboolean

Restrict to listings with flatlets. Residential only.

has_boreholeboolean

Restrict to listings with a borehole. Residential and farm only.

has_scenic_viewboolean

Restrict to listings with a scenic view. Residential and farm only.

has_alarmboolean

Restrict to listings with an alarm. Residential only.

has_electric_fencingboolean

Restrict to listings with electric fencing. Residential only.

has_security_postboolean

Restrict to listings with a security post. Residential only.

has_access_gateboolean

Restrict to listings with an access gate. Residential only.

has_intercomboolean

Restrict to listings with an intercom. Residential only.

sub_category[]string[]

Sub category filter. Valid values depend on type and deal_type.

Response

string required

Changes

No recorded changes to this operation across all 3 revisions of this API.