PropertyFinder

get/propertyfinder/locations

Request

  • Base URL: https://scrappa.co/api
  • URL: https://scrappa.co/api/propertyfinder/locations
  • Auth: API key in header X-API-KEY

Query parameters

namestring nullable

Substring match on the location name.

category_idstring nullable

Location category id. Defaults to 1.

typesstring nullable

Location types to include.

pageinteger nullable

Page number, 1-based. Defaults to 1.

limitinteger nullable

Locations per page, 1 to 50. Defaults to 20.

sortstring nullable

Upstream sort key.

locale'en' | 'ar' | 'null' nullable

en or ar. Defaults to en.

country'ae' | 'sa' | 'qa' | 'bh' | 'eg' | 'null' nullable

ae, sa, qa, bh or eg. Defaults to ae.

Response

string required

Changes

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