Skip to content

Getting started

Welcome to the Comps Greece API documentation. Use the left navigation to browse endpoints and guides.

Environments

https://comparables-gr.realitycs.it

https://sandbox-comparables-gr.realitycs.it

All the requests do require an OAUTH 2.0 auth token in the header, see the authentication page for details.

How it works

The service finds comparables in the Greek market, that is properties similar to the one you are analysing, and returns their details. The usual flow is a search that returns a page of results, followed by a detail call on the ones you care about.

  1. Search, either by attribute starting from filters, or by property starting from a property you describe.
  2. Take the uuid of a result from the response.
  3. Read the Comparable Detail.
Endpoint Use it to
Search by Attribute Search by filters, returns a paginated list of summaries
Full Search by Attribute Same search, but with the full detail of every result inline
Search by Property Search starting from the description of a property
Comparable Detail Read one comparable by uuid

Request format

Searches are POST calls taking a JSON body, the detail call is a GET with the uuid in the path:

Content-Type: application/json

Search bodies are structured in three blocks:

  • Filters: the search criteria. Unused criteria can be left as null rather than omitted.
  • Pagination: page and limit.
  • Sorting: by and direction.

Choosing the search area

The area is expressed by marketParentZoneID or municipalityID. The ids come from the location taxonomies: market parent zone, municipality, province and region.

Codified fields

Every *ID filter is codified. Taxonomies General lists the value sets for comparableType, contractType, categoryType, propertyType, energyClass, clientType and the others, while the location ones are covered by Taxonomies Location.

Do not reuse the Italian codifications

This service mirrors Comps finder for the Greek market, but the two are not interchangeable and the ids do not carry over. In particular comparableType here is 1 Listings, 3 Sales and 4 Golden sale, a different set from the Italian one, and the geography is organised around the market parent zone rather than the market zone. Always resolve the ids against the taxonomies of this service.

Response format

Searches answer with the standard Insights envelope: _metadata with the outcome and the pagination, items with the results.

_metadata carries more than the status:

  • page, limit, total_count and pages with first, last, next, previous and self, to drive the pagination. next and previous are null at the ends.
  • query: the filters as they were actually interpreted, with the codified ids resolved into their labels. Useful to confirm the search you ran is the search you meant.

Not every field is always populated

Only the fields marked with an asterisk in Mapping of output data are guaranteed. Everything else is null when the information is not available for that comparable, so treat missing values as normal rather than exceptional.

Changes

All updates to the endpoints are tracked in the Changelog.