SimilarHomesGroupResultModel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/eliq/main/json-schema/eliq-similar-homes-group-result-model-schema.json",
  "title": "SimilarHomesGroupResultModel",
  "description": "Model containing similar homes group result.",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/eliq-similar-homes-api-openapi.yml#/components/schemas/SimilarHomesGroupResultModel",
  "required": [
    "result_status"
  ],
  "type": "object",
  "properties": {
    "result": {
      "$ref": "#/$defs/SimilarHomesGroup"
    },
    "result_status": {
      "$ref": "#/$defs/SimilarHomesResultStatus"
    }
  },
  "$defs": {
    "LimitRange": {
      "required": [
        "max",
        "min"
      ],
      "type": "object",
      "properties": {
        "min": {
          "type": "number",
          "description": "Minimum number in the range. For example, if key is 'living_area' and min is 150, it means minimum 150 square meters.",
          "format": "double"
        },
        "max": {
          "type": "number",
          "description": "Maximum number in the range. For example, if key is 'living_area' and max is 200, it means maximum 200 square meters.",
          "format": "double"
        }
      },
      "description": "Available if type is 'limit_range'. Contains minimum and maximum values for the given key."
    },
    "SimilarHomesGroup": {
      "required": [
        "contributors",
        "filters"
      ],
      "type": "object",
      "properties": {
        "filters": {
          "minItems": 1,
          "type": "array",
          "items": {
            "$ref": "#/$defs/SimilarHomesGroupFilter"
          },
          "description": "A list of filters that was used when finding a similar homes group."
        },
        "contributors": {
          "type": "integer",
          "description": "Number of contributors in the group.",
          "format": "int32"
        }
      },
      "description": "Description of similar homes that a location is compared to."
    },
    "SimilarHomesGroupFilter": {
      "required": [
        "description",
        "key",
        "type"
      ],
      "type": "object",
      "properties": {
        "key": {
          "minLength": 1,
          "type": "string",
          "description": "This key refers to keys in home profile, for example 'house_type', 'heating_type_primary' or 'living_area'."
        },
        "description": {
          "minLength": 1,
          "type": "string",
          "description": "Description for the filter."
        },
        "type": {
          "$ref": "#/$defs/SimilarHomesGroupFilterType"
        },
        "limit_range": {
          "$ref": "#/$defs/LimitRange"
        },
        "limit_values": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "Available if type is 'limit_values'. For example, for key 'house_type', this would include the list of house types the location is compared with."
        }
      },
      "description": "Similar homes group filter."
    },
    "SimilarHomesGroupFilterType": {
      "enum": [
        "limit_values",
        "limit_range"
      ],
      "type": "string",
      "description": "Describes whether 'limit_values' or 'limit_range' should be used."
    },
    "SimilarHomesResultStatus": {
      "required": [
        "code"
      ],
      "type": "object",
      "properties": {
        "code": {
          "$ref": "#/$defs/SimilarHomesResultStatusCode"
        },
        "action": {
          "$ref": "#/$defs/SimilarHomesResultStatusAction"
        }
      },
      "description": "Contains information about the result, and whether it was successful or not."
    },
    "SimilarHomesResultStatusAction": {
      "type": "object",
      "properties": {
        "code": {
          "type": [
            "string",
            "null"
          ],
          "description": "A code for the action that should be taken. Please refer to documentation of specific endpoint for more information."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "A description of the action that should be taken."
        }
      },
      "description": "Available in cases where there are actions that can be done to make the result successful, such as entering information in the home profile options."
    },
    "SimilarHomesResultStatusCode": {
      "enum": [
        "ok",
        "not_ok"
      ],
      "type": "string",
      "description": "Indicating whether there is a result or not."
    }
  }
}