Brazil: property price statistics

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "group_by"
  ],
  "properties": {
    "street": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80,
      "description": "Street name, accents and abbreviations optional, e.g. \"Rua Tabapuã\" or \"Av Pres Wilson\". Exact name matches win; otherwise every word must appear."
    },
    "number": {
      "type": "integer",
      "minimum": 1,
      "maximum": 99999,
      "description": "Building number on the street (requires street)"
    },
    "district": {
      "type": "string",
      "minLength": 2,
      "maxLength": 40,
      "description": "One of the 96 São Paulo districts (distritos), e.g. Pinheiros, Itaim Bibi, Mooca"
    },
    "asset_class": {
      "type": "string",
      "enum": [
        "RESIDENCIAL",
        "TERRENO",
        "COMERCIAL",
        "INDUSTRIAL",
        "OUTROS",
        "GARAGEM/DEPOSITO"
      ],
      "description": "RESIDENCIAL (apartments and houses), TERRENO (land), COMERCIAL, INDUSTRIAL, GARAGEM/DEPOSITO or OUTROS"
    },
    "year_from": {
      "type": "integer",
      "minimum": 2019,
      "maximum": 2030
    },
    "year_to": {
      "type": "integer",
      "minimum": 2019,
      "maximum": 2030
    },
    "min_value_brl": {
      "type": "number",
      "minimum": 0
    },
    "max_value_brl": {
      "type": "number",
      "minimum": 0
    },
    "min_area_m2": {
      "type": "number",
      "minimum": 0,
      "description": "Built area"
    },
    "max_area_m2": {
      "type": "number",
      "minimum": 0
    },
    "include": {
      "type": "string",
      "enum": [
        "clean",
        "market",
        "all"
      ],
      "description": "clean: market sales with a trustworthy price per m² (outliers and implausible prices removed). market: every market sale, outliers flagged. all: also non-market transfers such as partial shares and in-kind transfers.",
      "default": "clean"
    },
    "group_by": {
      "type": "array",
      "minItems": 1,
      "maxItems": 3,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "district",
          "year",
          "month",
          "asset_class",
          "street"
        ]
      },
      "description": "Dimensions to group by, e.g. [\"district\"] or [\"year\",\"asset_class\"]"
    },
    "min_deals": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000,
      "default": 5,
      "description": "Drop groups with fewer deals"
    },
    "sort": {
      "type": "string",
      "enum": [
        "deals",
        "median_price_m2",
        "key"
      ],
      "description": "Default: key (chronological) when grouping by year or month, otherwise deals"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "default": 100
    }
  }
}

{
  "data_through": "",
  "groups": [
    {
      "district": "",
      "year": 0,
      "deals": 0,
      "median_price_m2_brl": 0,
      "p25_price_m2_brl": 0,
      "p75_price_m2_brl": 0,
      "median_price_m2_brl_real": 0,
      "median_value_brl": 0,
      "median_area_m2": 0,
      "total_value_brl": 0
    }
  ]
}