CompSearchRequest
A deal search: the filters, the order and the page.
- advisedType: null | string
By Id Only deals this company advised on, on either side.
- areaType: null | number | stringFormat: double
Max Largest leasable area, in square metres.
- areaType: null | number | stringFormat: double
Min Smallest leasable area, in square metres.
- categoryType: null | array of string …50
Property types:
residential,office,retail,industrial,social_infrastructure,hotel,land,special_purpose. A deal matches when any of its property's types is chosen, so a mixed office and retail property is found under either; its medians count under its main type. - countryType: null | string
ISO 3166-1 alpha-2 country code.
- currencyType: null | string
The ISO 4217 currency the price filters, the price sort and the summary work in; your own currency when omitted. Prices are never converted: a deal in another currency is left out of price filters and sorted after the others.
- fromType: null | stringFormat: date
A custom period's first day (inclusive).
- includeType: boolean
Hidden Also the deals hidden from the list. A search only: the summary never counts a hidden deal, and the change feed always lists one.
- incompleteType: boolean
Only deals that lack something (price, buyer, seller, property, location, address).
- limitType: integer | stringFormat: int32min:1max:100
Results per page, 1-100 (default 100).
- localityType: null | array of string …50
Localities (cities or districts), any of them.
- nearType: nullableProperties: 2
A point to search around; needs
radius. Not withwithin. - offsetType: integer | stringFormat: int32min:0max:10000
Results to skip, 0-10,000.
- partyType: null | string
Id Only deals where this contact or company is a party (in any role, or the role in
partyRole). - partyType: enumnullable
Role With
partyId: the role the party must have —seller,buyer,seller_advisororbuyer_advisor.valuessellerbuyerseller_advisorbuyer_advisor - periodType: null | string
The period on the deal date:
last_12_months,last_24_months,last_5_years,all(default) orcustomwithfromandto. Sendingfromortoalone makes the period custom. - priceType: null | number | stringFormat: double
Max Highest price, in full units of the request
currency. - priceType: null | number | stringFormat: double
Min Lowest price, in full units of the request
currency; deals priced in another currency never match. - priceType: null | number | stringFormat: double
Per Sqm Max Highest price per square metre, in the request
currency. - priceType: null | number | stringFormat: double
Per Sqm Min Lowest price per square metre, in the request
currency. - projectType: null | string
Id Only the deal of this project of yours.
- queryType: null | stringmax length:100
Free text over the deal's name, the property, its street address, the place and the parties' names; at most 100 characters.
- radiusType: null | integer | stringFormat: int32
The radius around
near, in metres (at most 100000). - sortType: null | string
dealDate(default, newest first),signedOn,completedOn,price,yield,pricePerSqmorleasableArea; prefix-for descending. Deals without the value sort last; on a price sort, deals in another currency come after those in the request currency. - sourceType: …50enum
Channel Source channels, any of:
own_project,news,market_contact,none. - toType: null | stringFormat: date
A custom period's last day (inclusive).
- withinnullable
An area as a GeoJSON
PolygonorMultiPolygon(coordinates[longitude, latitude]), as the property and mandate searches take it; only deals whose property's address lies inside match (an area-only location never does). Not withnear. - yieldType: null | number | stringFormat: double
Max Highest yield, in percent.
- yieldType: null | number | stringFormat: double
Min Lowest yield, in percent.