PropertyFinder

get/propertyfinder/brokerages

Request

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

Query parameters

pageinteger nullable

Page number, 1-based. Defaults to 1.

per_pageinteger nullable

Brokerages per page, 1 to 100. Defaults to 20.

qstring nullable

Name query.

textstring nullable

Free-text query.

location_idinteger nullable

Restrict to one location.

parent_idinteger nullable

Restrict to branches of one parent brokerage.

sortstring nullable

Upstream sort key, e.g. name_sort.

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.