POST
/
v2
/
maps
/
properties
/
_aggregate
curl --request POST \
  --url https://api.f6o.co/v2/maps/properties/_aggregate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "query": {
    "fullTexts": [
      "<string>"
    ],
    "keywords": [
      "<string>"
    ],
    "filterProperty": {
      "indexTimestamp": [
        {
          "min": "2023-11-07T05:31:56Z",
          "max": "2023-11-07T05:31:56Z"
        }
      ],
      "meta": {
        "firstSeenAt": {
          "min": "2023-11-07T05:31:56Z",
          "max": "2023-11-07T05:31:56Z"
        },
        "lastUpdatedAt": {
          "min": "2023-11-07T05:31:56Z",
          "max": "2023-11-07T05:31:56Z"
        },
        "firstPublishedAt": {
          "min": "2023-11-07T05:31:56Z",
          "max": "2023-11-07T05:31:56Z"
        },
        "lastPublishedAt": {
          "min": "2023-11-07T05:31:56Z",
          "max": "2023-11-07T05:31:56Z"
        },
        "lastSeenAt": {
          "min": "2023-11-07T05:31:56Z",
          "max": "2023-11-07T05:31:56Z"
        },
        "isTotallyOffline": true
      },
      "tags": [
        "<string>"
      ],
      "isUrgent": true,
      "offer": [
        {
          "type": "OFFER_UNKNOWN",
          "renting": {
            "isSubLease": true,
            "isShortTerm": true,
            "isLongTerm": true,
            "isColocation": true
          },
          "isCurrentlyOccupied": true
        }
      ],
      "type": [
        "CLASS_UNKNOWN"
      ],
      "process": [
        "PROCESS_UNKNOWN"
      ],
      "price": {
        "latest": {
          "value": {
            "min": 123,
            "max": 123
          },
          "valuePerArea": {
            "min": 123,
            "max": 123
          },
          "source": {
            "website": "<string>",
            "url": "<string>",
            "flxId": "<string>"
          }
        },
        "lowest": {
          "value": {
            "min": 123,
            "max": 123
          },
          "valuePerArea": {
            "min": 123,
            "max": 123
          },
          "source": {
            "website": "<string>",
            "url": "<string>",
            "flxId": "<string>"
          }
        },
        "highest": {
          "value": {
            "min": 123,
            "max": 123
          },
          "valuePerArea": {
            "min": 123,
            "max": 123
          },
          "source": {
            "website": "<string>",
            "url": "<string>",
            "flxId": "<string>"
          }
        },
        "initial": {
          "value": {
            "min": 123,
            "max": 123
          },
          "valuePerArea": {
            "min": 123,
            "max": 123
          },
          "source": {
            "website": "<string>",
            "url": "<string>",
            "flxId": "<string>"
          }
        },
        "warrantyDeposit": {
          "min": 123,
          "max": 123
        },
        "charges": {
          "yearlyRentalFees": 123,
          "yearlyCondoniumFees": 123,
          "yearlyHeatingFees": 123,
          "yearlyElectricityFees": 123,
          "yearlyHousingTax": 123,
          "yearlyLivingTax": 123,
          "monthlyRentSupplement": 123
        },
        "isAuction": true,
        "scope": [
          "PRICING_ONE_OFF"
        ],
        "currency": [
          "CURRENCY_EUR"
        ],
        "variation": [
          {
            "sincePublished": {
              "min": 123,
              "max": 123
            },
            "sinceLastModified": {
              "min": 123,
              "max": 123
            }
          }
        ]
      },
      "habitation": {
        "type": "PROPERTY_TYPE_UNKNOWN",
        "roomCount": {
          "min": 123,
          "max": 123
        },
        "bedroomCount": {
          "min": 123,
          "max": 123
        },
        "bathroomCount": {
          "min": 123,
          "max": 123
        },
        "wcCount": {
          "min": 123,
          "max": 123
        },
        "roomsDetails": [
          {
            "roomType": "ROOM_TYPE_UNKNOWN",
            "area": 123,
            "floor": 123,
            "contextInfo": [
              "<string>"
            ]
          }
        ],
        "heatTypes": [
          "HEAT_TYPE_UNKNOWN"
        ],
        "heatTypeDetails": [
          "HEAT_DETAIL_UNKNOWN"
        ],
        "heatings": [
          "HEATING_UNKNOWN"
        ],
        "kitchenEquipped": [
          "KITCHEN_UNKNOWN_EQUIPPED"
        ],
        "features": {
          "propertyTotalFloor": {
            "min": 123,
            "max": 123
          },
          "propertyFloor": {
            "min": 123,
            "max": 123
          },
          "viewTypes": [
            "VIEW_TYPE_UNKNOWN"
          ],
          "exposure": [
            "EXPOSURE_UNKNOWN"
          ],
          "furniture": [
            "UNKNOWN_FURNITURE"
          ],
          "constructionMaterials": [
            "MATERIAL_UNKNOWN"
          ],
          "viewOns": [
            "VIEW_ON_UNKNOWN"
          ],
          "glazingTypes": [
            "GLAZING_TYPE_UNKNOWN"
          ],
          "hasThroughExposure": true
        },
        "characteristics": {
          "hasLift": true,
          "hasCellar": true,
          "hasBalcony": true,
          "hasTerrace": true,
          "hasGarden": true,
          "hasFireplace": true,
          "hasGrenier": true,
          "hasPool": true,
          "hasParking": true,
          "hasGarage": true,
          "hasLand": true,
          "hasConcierge": true,
          "hasDigicode": true,
          "hasInterphone": true,
          "hasAlarm": true,
          "hasVisAVis": true,
          "isPeaceful": true,
          "hasMezzanine": true,
          "hasJacuzzi": true
        },
        "climate": {
          "epcEnergy": [
            "ENERGY_CLASSIFICATION_UNKNOWN"
          ],
          "epcClimate": [
            "GREENHOUSE_CLASSIFICATION_UNKNOWN"
          ],
          "epcEnergyScore": {
            "min": 123,
            "max": 123
          },
          "epcClimateScore": {
            "min": 123,
            "max": 123
          }
        },
        "propertyCondition": [
          {
            "interiorCondition": "INTERIOR_CONDITION_UNKNOWN",
            "constructionYear": 123,
            "generalConditions": [
              "GENERAL_CONDITION_UNKNOWN"
            ],
            "renovationYear": 123
          }
        ],
        "surface": {
          "total": {
            "min": 123,
            "max": 123
          },
          "livingSpace": {
            "min": 123,
            "max": 123
          },
          "floorSpace": {
            "min": 123,
            "max": 123
          },
          "livingroom": {
            "min": 123,
            "max": 123
          },
          "kitchen": {
            "min": 123,
            "max": 123
          },
          "groundFloor": {
            "min": 123,
            "max": 123
          },
          "balconies": {
            "min": 123,
            "max": 123
          },
          "terraces": {
            "min": 123,
            "max": 123
          },
          "gardens": {
            "min": 123,
            "max": 123
          }
        }
      },
      "parking": {
        "type": [
          "PARKING_UNKNOWN"
        ],
        "count": {
          "min": 123,
          "max": 123
        },
        "numberOfCars": {
          "min": 123,
          "max": 123
        },
        "surface": {
          "min": 123,
          "max": 123
        }
      },
      "land": {
        "type": [
          "LAND_UNKNOWN"
        ],
        "haveBuildingPermit": true,
        "canConstruct": true,
        "surfaceConstructable": {
          "min": 123,
          "max": 123
        },
        "surface": {
          "min": 123,
          "max": 123
        },
        "isServiced": true,
        "haveWater": true,
        "haveElectricity": true,
        "haveTelecom": true
      },
      "location": [
        {
          "address": {
            "number": "<string>",
            "streetName": "<string>"
          },
          "postalCode": "<string>",
          "inseeCode": "<string>",
          "irisCode": "<string>",
          "department": "<string>",
          "city": "<string>",
          "locationCoordinate": {
            "location": {
              "preregisteredShape": {
                "index": "UNKNOWN_GEO_INDEX",
                "id": "<string>"
              },
              "geoDistance": {
                "distanceKm": 123,
                "pin": {
                  "lat": 123,
                  "lon": 123
                }
              },
              "geoBoundingBox": {
                "topLeft": {
                  "lat": 123,
                  "lon": 123
                },
                "bottomRight": {
                  "lat": 123,
                  "lon": 123
                }
              },
              "geoShape": {
                "relation": "UNKNOWN_SPATIAL_RELATION",
                "type": "UNKNOWN_GEO_SHAPE_TYPE",
                "coordinates": [
                  {
                    "lat": 123,
                    "lon": 123
                  }
                ]
              }
            },
            "h3Indices": {
              "h3Index1": "<string>",
              "h3Index2": "<string>",
              "h3Index3": "<string>",
              "h3Index4": "<string>",
              "h3Index5": "<string>",
              "h3Index6": "<string>",
              "h3Index7": "<string>",
              "h3Index8": "<string>",
              "h3Index9": "<string>",
              "h3Index10": "<string>",
              "h3Index11": "<string>",
              "h3Index12": "<string>"
            }
          },
          "cityCoordinate": {
            "location": {
              "preregisteredShape": {
                "index": "UNKNOWN_GEO_INDEX",
                "id": "<string>"
              },
              "geoDistance": {
                "distanceKm": 123,
                "pin": {
                  "lat": 123,
                  "lon": 123
                }
              },
              "geoBoundingBox": {
                "topLeft": {
                  "lat": 123,
                  "lon": 123
                },
                "bottomRight": {
                  "lat": 123,
                  "lon": 123
                }
              },
              "geoShape": {
                "relation": "UNKNOWN_SPATIAL_RELATION",
                "type": "UNKNOWN_GEO_SHAPE_TYPE",
                "coordinates": [
                  {
                    "lat": 123,
                    "lon": 123
                  }
                ]
              }
            },
            "h3Indices": {
              "h3Index1": "<string>",
              "h3Index2": "<string>",
              "h3Index3": "<string>",
              "h3Index4": "<string>",
              "h3Index5": "<string>",
              "h3Index6": "<string>",
              "h3Index7": "<string>",
              "h3Index8": "<string>",
              "h3Index9": "<string>",
              "h3Index10": "<string>",
              "h3Index11": "<string>",
              "h3Index12": "<string>"
            }
          }
        }
      ],
      "history": [
        {
          "seenAt": {
            "min": "2023-11-07T05:31:56Z",
            "max": "2023-11-07T05:31:56Z"
          },
          "price": {
            "min": 123,
            "max": 123
          },
          "pricePerArea": {
            "min": 123,
            "max": 123
          },
          "nbDaysPublished": {
            "min": 123,
            "max": 123
          },
          "source": {
            "website": "<string>",
            "url": "<string>",
            "flxId": "<string>"
          }
        }
      ],
      "adverts": [
        {
          "flxId": [
            "<string>"
          ],
          "isPro": true,
          "seller": [
            {
              "type": "SELLER_TYPE_UNKNOWN",
              "flxId": "<string>",
              "name": "<string>",
              "siren": "<string>"
            }
          ],
          "contactInCharge": {
            "firstName": "<string>",
            "lastName": "<string>",
            "phoneNumber": "<string>",
            "email": "<string>",
            "pseudonym": "<string>"
          },
          "source": {
            "website": "<string>",
            "url": "<string>",
            "flxId": "<string>"
          },
          "title": [
            "<string>"
          ],
          "description": [
            "<string>"
          ],
          "isOnline": true,
          "firstSeenAt": {
            "min": "2023-11-07T05:31:56Z",
            "max": "2023-11-07T05:31:56Z"
          },
          "lastUpdatedAt": {
            "min": "2023-11-07T05:31:56Z",
            "max": "2023-11-07T05:31:56Z"
          },
          "firstPublishedAt": {
            "min": "2023-11-07T05:31:56Z",
            "max": "2023-11-07T05:31:56Z"
          },
          "lastSeenAt": {
            "min": "2023-11-07T05:31:56Z",
            "max": "2023-11-07T05:31:56Z"
          },
          "price": {
            "latest": {
              "value": {
                "min": 123,
                "max": 123
              },
              "valuePerArea": {
                "min": 123,
                "max": 123
              },
              "source": {
                "website": "<string>",
                "url": "<string>",
                "flxId": "<string>"
              }
            },
            "lowest": {
              "value": {
                "min": 123,
                "max": 123
              },
              "valuePerArea": {
                "min": 123,
                "max": 123
              },
              "source": {
                "website": "<string>",
                "url": "<string>",
                "flxId": "<string>"
              }
            },
            "highest": {
              "value": {
                "min": 123,
                "max": 123
              },
              "valuePerArea": {
                "min": 123,
                "max": 123
              },
              "source": {
                "website": "<string>",
                "url": "<string>",
                "flxId": "<string>"
              }
            },
            "initial": {
              "value": {
                "min": 123,
                "max": 123
              },
              "valuePerArea": {
                "min": 123,
                "max": 123
              },
              "source": {
                "website": "<string>",
                "url": "<string>",
                "flxId": "<string>"
              }
            },
            "warrantyDeposit": {
              "min": 123,
              "max": 123
            },
            "charges": {
              "yearlyRentalFees": 123,
              "yearlyCondoniumFees": 123,
              "yearlyHeatingFees": 123,
              "yearlyElectricityFees": 123,
              "yearlyHousingTax": 123,
              "yearlyLivingTax": 123,
              "monthlyRentSupplement": 123
            },
            "isAuction": true,
            "scope": [
              "PRICING_ONE_OFF"
            ],
            "currency": [
              "CURRENCY_EUR"
            ],
            "variation": [
              {
                "sincePublished": {
                  "min": 123,
                  "max": 123
                },
                "sinceLastModified": {
                  "min": 123,
                  "max": 123
                }
              }
            ]
          },
          "location": {
            "preregisteredShape": {
              "index": "UNKNOWN_GEO_INDEX",
              "id": "<string>"
            },
            "geoDistance": {
              "distanceKm": 123,
              "pin": {
                "lat": 123,
                "lon": 123
              }
            },
            "geoBoundingBox": {
              "topLeft": {
                "lat": 123,
                "lon": 123
              },
              "bottomRight": {
                "lat": 123,
                "lon": 123
              }
            },
            "geoShape": {
              "relation": "UNKNOWN_SPATIAL_RELATION",
              "type": "UNKNOWN_GEO_SHAPE_TYPE",
              "coordinates": [
                {
                  "lat": 123,
                  "lon": 123
                }
              ]
            }
          },
          "hasAnomaly": true,
          "anomalies": [
            "UNKNOWN_ANOMALY"
          ]
        }
      ],
      "isCityCenter": true,
      "hasAnomaly": true,
      "estimatedPrice": {
        "value": {
          "min": 123,
          "max": 123
        },
        "valuePerArea": {
          "min": 123,
          "max": 123
        },
        "source": {
          "website": "<string>",
          "url": "<string>",
          "flxId": "<string>"
        }
      },
      "imagesLength": {
        "min": 123,
        "max": 123
      },
      "advertsLength": {
        "min": 123,
        "max": 123
      },
      "historyLength": {
        "min": 123,
        "max": 123
      },
      "anomalies": [
        "UNKNOWN_ANOMALY"
      ]
    }
  },
  "options": {
    "layer": "LAYER_TYPE_UNKNOWN",
    "type": "UNKNOWN_ANALYSIS_TYPE",
    "bounds": {
      "topLeft": {
        "lat": 123,
        "lon": 123
      },
      "bottomRight": {
        "lat": 123,
        "lon": 123
      }
    }
  },
  "field": "ANALYZED_FIELD_UNKNOWN"
}'
{
  "apiVersion": "<string>",
  "kind": "<string>",
  "context": "<string>",
  "internalDelay": 123,
  "data": [
    {
      "name": "<string>",
      "analysis": {
        "countValue": 123,
        "summaryValue": {
          "count": 123,
          "min": 123,
          "max": 123,
          "avg": 123,
          "sum": 123
        },
        "advancedKpiValue": {
          "count": 123,
          "min": 123,
          "max": 123,
          "avg": 123,
          "sum": 123,
          "sumOfSquares": 123,
          "variance": 123,
          "variancePopulation": 123,
          "varianceSampling": 123,
          "stdDeviation": 123,
          "stdDeviationSampling": 123,
          "stdDeviationPopulation": 123,
          "stdDeviationBounds": {
            "upper": 123,
            "lower": 123,
            "upperPopulation": 123,
            "lowerPopulation": 123,
            "upperSampling": 123,
            "lowerSampling": 123
          }
        },
        "boxplotValue": {
          "min": 123,
          "max": 123,
          "q1": 123,
          "q2": 123,
          "q3": 123,
          "lower": 123,
          "upper": 123
        },
        "percentilesValues": {
          "percentiles": {}
        }
      }
    }
  ]
}

Authorizations

x-api-key
string
headerrequired

API Key used to be authentified to these APIs. Please contact Fluximmo to get one

Body

application/json
query
object
options
object
field
enum<string>
default: ANALYZED_FIELD_UNKNOWN
Available options:
ANALYZED_FIELD_UNKNOWN,
ANALYZED_FIELD_ROOMS,
ANALYZED_FIELD_SURFACE,
ANALYZED_FIELD_PRICE_PER_AREA,
ANALYZED_FIELD_PRICE,
ANALYZED_FIELD_BEDROOMS

Response

200 - application/json
apiVersion
string
kind
string
context
string
internalDelay
integer
data
object[]