POST
/
v2
/
maps
/
dvf
/
_aggregate
curl --request POST \
  --url https://api.f6o.co/v2/maps/dvf/_aggregate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "field": "ANALYZED_FIELD_UNKNOWN",
  "options": {
    "bounds": {
      "bottomRight": {
        "lat": 123,
        "lon": 123
      },
      "topLeft": {
        "lat": 123,
        "lon": 123
      }
    },
    "layer": "LAYER_TYPE_UNKNOWN",
    "type": "UNKNOWN_ANALYSIS_TYPE"
  },
  "query": {
    "filters": {
      "flxId": "<string>",
      "group": "LOCAL_GROUP_UNKNOWN",
      "inflatedPrice": [
        {
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          },
          "value": {
            "max": 123,
            "min": 123
          },
          "valuePerArea": {
            "max": 123,
            "min": 123
          },
          "valuePerAreaCarrez": {
            "max": 123,
            "min": 123
          }
        }
      ],
      "location": {
        "address": {
          "number": "<string>",
          "streetName": "<string>"
        },
        "city": "<string>",
        "cityCoordinate": {
          "h3Indices": {
            "h3Index1": "<string>",
            "h3Index10": "<string>",
            "h3Index11": "<string>",
            "h3Index12": "<string>",
            "h3Index2": "<string>",
            "h3Index3": "<string>",
            "h3Index4": "<string>",
            "h3Index5": "<string>",
            "h3Index6": "<string>",
            "h3Index7": "<string>",
            "h3Index8": "<string>",
            "h3Index9": "<string>"
          },
          "location": {
            "geoBoundingBox": {
              "bottomRight": {
                "lat": 123,
                "lon": 123
              },
              "topLeft": {
                "lat": 123,
                "lon": 123
              }
            },
            "geoDistance": {
              "distanceKm": 123,
              "pin": {
                "lat": 123,
                "lon": 123
              }
            },
            "geoShape": {
              "coordinates": [
                {
                  "lat": 123,
                  "lon": 123
                }
              ],
              "relation": "UNKNOWN_SPATIAL_RELATION",
              "type": "UNKNOWN_GEO_SHAPE_TYPE"
            },
            "preregisteredShape": {
              "id": "<string>",
              "index": "UNKNOWN_GEO_INDEX"
            }
          }
        },
        "department": "<string>",
        "inseeCode": "<string>",
        "irisCode": "<string>",
        "locationCoordinate": {
          "h3Indices": {
            "h3Index1": "<string>",
            "h3Index10": "<string>",
            "h3Index11": "<string>",
            "h3Index12": "<string>",
            "h3Index2": "<string>",
            "h3Index3": "<string>",
            "h3Index4": "<string>",
            "h3Index5": "<string>",
            "h3Index6": "<string>",
            "h3Index7": "<string>",
            "h3Index8": "<string>",
            "h3Index9": "<string>"
          },
          "location": {
            "geoBoundingBox": {
              "bottomRight": {
                "lat": 123,
                "lon": 123
              },
              "topLeft": {
                "lat": 123,
                "lon": 123
              }
            },
            "geoDistance": {
              "distanceKm": 123,
              "pin": {
                "lat": 123,
                "lon": 123
              }
            },
            "geoShape": {
              "coordinates": [
                {
                  "lat": 123,
                  "lon": 123
                }
              ],
              "relation": "UNKNOWN_SPATIAL_RELATION",
              "type": "UNKNOWN_GEO_SHAPE_TYPE"
            },
            "preregisteredShape": {
              "id": "<string>",
              "index": "UNKNOWN_GEO_INDEX"
            }
          }
        },
        "postalCode": "<string>"
      },
      "mainAdress": [
        {
          "number": "<string>",
          "streetName": "<string>"
        }
      ],
      "mainProperty": {
        "localType": "LOCAL_TYPE_UNKNOWN",
        "mainRoomsCount": {
          "max": 123,
          "min": 123
        },
        "surface": {
          "max": 123,
          "min": 123
        },
        "type": "PROPERTY_TYPE_UNKNOWN"
      },
      "meta": {
        "anomalies": [
          "ANOMALY_UNKNOWN"
        ],
        "hasAnomaly": true,
        "mutationDate": {
          "max": "2023-11-07T05:31:56Z",
          "min": "2023-11-07T05:31:56Z"
        },
        "mutationId": "<string>"
      },
      "parcels": [
        {
          "id": "<string>",
          "landDetail": [
            {
              "nature": [
                {
                  "specialType": "<string>",
                  "type": "NATURE_OF_LAND_UNKNOWN"
                }
              ],
              "surface": {
                "max": 123,
                "min": 123
              }
            }
          ],
          "locals": [
            "LOCAL_TYPE_UNKNOWN"
          ],
          "location": {
            "address": {
              "number": "<string>",
              "streetName": "<string>"
            },
            "city": "<string>",
            "cityCoordinate": {
              "h3Indices": {
                "h3Index1": "<string>",
                "h3Index10": "<string>",
                "h3Index11": "<string>",
                "h3Index12": "<string>",
                "h3Index2": "<string>",
                "h3Index3": "<string>",
                "h3Index4": "<string>",
                "h3Index5": "<string>",
                "h3Index6": "<string>",
                "h3Index7": "<string>",
                "h3Index8": "<string>",
                "h3Index9": "<string>"
              },
              "location": {
                "geoBoundingBox": {
                  "bottomRight": {
                    "lat": 123,
                    "lon": 123
                  },
                  "topLeft": {
                    "lat": 123,
                    "lon": 123
                  }
                },
                "geoDistance": {
                  "distanceKm": 123,
                  "pin": {
                    "lat": 123,
                    "lon": 123
                  }
                },
                "geoShape": {
                  "coordinates": [
                    {
                      "lat": 123,
                      "lon": 123
                    }
                  ],
                  "relation": "UNKNOWN_SPATIAL_RELATION",
                  "type": "UNKNOWN_GEO_SHAPE_TYPE"
                },
                "preregisteredShape": {
                  "id": "<string>",
                  "index": "UNKNOWN_GEO_INDEX"
                }
              }
            },
            "department": "<string>",
            "inseeCode": "<string>",
            "irisCode": "<string>",
            "locationCoordinate": {
              "h3Indices": {
                "h3Index1": "<string>",
                "h3Index10": "<string>",
                "h3Index11": "<string>",
                "h3Index12": "<string>",
                "h3Index2": "<string>",
                "h3Index3": "<string>",
                "h3Index4": "<string>",
                "h3Index5": "<string>",
                "h3Index6": "<string>",
                "h3Index7": "<string>",
                "h3Index8": "<string>",
                "h3Index9": "<string>"
              },
              "location": {
                "geoBoundingBox": {
                  "bottomRight": {
                    "lat": 123,
                    "lon": 123
                  },
                  "topLeft": {
                    "lat": 123,
                    "lon": 123
                  }
                },
                "geoDistance": {
                  "distanceKm": 123,
                  "pin": {
                    "lat": 123,
                    "lon": 123
                  }
                },
                "geoShape": {
                  "coordinates": [
                    {
                      "lat": 123,
                      "lon": 123
                    }
                  ],
                  "relation": "UNKNOWN_SPATIAL_RELATION",
                  "type": "UNKNOWN_GEO_SHAPE_TYPE"
                },
                "preregisteredShape": {
                  "id": "<string>",
                  "index": "UNKNOWN_GEO_INDEX"
                }
              }
            },
            "postalCode": "<string>"
          },
          "lotCount": {
            "max": 123,
            "min": 123
          },
          "lots": [
            {
              "number": {
                "max": 123,
                "min": 123
              },
              "surface": {
                "max": 123,
                "min": 123
              }
            }
          ],
          "propertyDetail": [
            {
              "localType": "LOCAL_TYPE_UNKNOWN",
              "mainRoomsCount": {
                "max": 123,
                "min": 123
              },
              "surface": {
                "max": 123,
                "min": 123
              },
              "type": "PROPERTY_TYPE_UNKNOWN"
            }
          ]
        }
      ],
      "price": [
        {
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          },
          "value": {
            "max": 123,
            "min": 123
          },
          "valuePerArea": {
            "max": 123,
            "min": 123
          },
          "valuePerAreaCarrez": {
            "max": 123,
            "min": 123
          }
        }
      ],
      "properties": [
        {
          "localType": "LOCAL_TYPE_UNKNOWN",
          "mainRoomsCount": {
            "max": 123,
            "min": 123
          },
          "surface": {
            "max": 123,
            "min": 123
          },
          "type": "PROPERTY_TYPE_UNKNOWN"
        }
      ],
      "totalSurface": 123,
      "type": [
        "MUTATION_NATURE_UNKNOWN"
      ]
    }
  }
}'
{
  "apiVersion": "<string>",
  "context": "<string>",
  "data": [
    {
      "analysis": {
        "advancedKpiValue": {
          "avg": 123,
          "count": 123,
          "max": 123,
          "min": 123,
          "stdDeviation": 123,
          "stdDeviationBounds": {
            "lower": 123,
            "lowerPopulation": 123,
            "lowerSampling": 123,
            "upper": 123,
            "upperPopulation": 123,
            "upperSampling": 123
          },
          "stdDeviationPopulation": 123,
          "stdDeviationSampling": 123,
          "sum": 123,
          "sumOfSquares": 123,
          "variance": 123,
          "variancePopulation": 123,
          "varianceSampling": 123
        },
        "boxplotValue": {
          "lower": 123,
          "max": 123,
          "min": 123,
          "q1": 123,
          "q2": 123,
          "q3": 123,
          "upper": 123
        },
        "countValue": 123,
        "percentilesValues": {
          "percentiles": {}
        },
        "summaryValue": {
          "avg": 123,
          "count": 123,
          "max": 123,
          "min": 123,
          "sum": 123
        }
      },
      "name": "<string>"
    }
  ],
  "internalDelay": 123,
  "kind": "<string>"
}

Authorizations

x-api-key
string
headerrequired

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

Body

application/json
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
options
object
query
object

Response

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