Properties

This endpoint is not generally available. For questions please contact sales.

GET /properties HTTP/2

The properties endpoint returns a list of properties. You can filter the list by various criteria.

Example use-cases:

  • Display a list of properties in your application.
  • Allow navigation to the details of a property.

Request

curl -X GET 'https://quis.de/api/v2/properties?api_key=<YOUR-API-KEY>'
Field Description Type Remarks
limit Maximum number of items to return integer max: 100, default: 10
offset Number of items to skip integer default: 0
parentId Filter by the parent property group string If left empty only properties without a parent are listed. Except when a query is provided.
query Filter the properties string Filtered by customId, externalId, address, etc.

Response

{
  "items": [
    {
      "id": "aee52a8c-6a50-4e3f-b5bd-6aecd2d4abbd",
      "customId": "123456789",
      "externalId": "e29266df-6501-4326-a7e1-9440d347f8df",
      "parentId": "9b4f4f58-92bb-4ea3-b623-53b2141a17de",
      "location": {
        "address": {
          "unstructured": "Musterstraße 1, 12345 Musterstadt"
        },
        "coordinates": {
          "latitude": 52.520008,
          "longitude": 13.404954
        }
      },
      "propertyType": {
        "type": "apartment",
        "subtype": "apartment_apartment"
      },
      "buildingYear": 1990,
      "livingArea": 100.5,
      "landArea": 100.5,
      "numberOfRooms": 3,
      "floor": 1,
      "condition": "moderate",
      "quality": "upscale",
      "energyCertificate": {
        "type": "consumption",
        "value": 89.75
      },
      "primaryEnergySource": "gas",
      "heatingTypes": [
        "gas",
        "floor"
      ],
      "equipments": [
        "balcony",
        "lift",
        "kitchen",
        "Sauna"
      ]
    },
    ...
  ],
  "totalItems": 15364,
  "meta": {
    "url": null,
    "version": "2.9.0"
  }
}
Field Description Type Remarks
items List of properties array of Property  
totalItems Total number of items integer  
meta Meta information of the API Meta  

© 2020-2024 QUIS® ist ein Service der Analyse & Konzepte immo.analytics GmbH