POST
/
v2
/
dvf
/
_search
curl --request POST \
  --url https://api.f6o.co/v2/dvf/_search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key : <api-key>' \
  --data '{
  "search": {
    "filters": {
      "flxId": "<string>",
      "meta": {
        "mutationId": "<string>",
        "mutationDate": {
          "min": "2023-11-07T05:31:56Z",
          "max": "2023-11-07T05:31:56Z"
        },
        "anomalies": [
          "ANOMALY_UNKNOWN"
        ],
        "hasAnomaly": true
      },
      "totalSurface": 123,
      "group": "LOCAL_GROUP_UNKNOWN",
      "mainProperty": {
        "type": "PROPERTY_TYPE_UNKNOWN",
        "surface": {
          "min": 123,
          "max": 123
        },
        "mainRoomsCount": {
          "min": 123,
          "max": 123
        },
        "localType": "LOCAL_TYPE_UNKNOWN"
      },
      "parcels": [
        {
          "id": "<string>",
          "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>"
              }
            }
          },
          "landDetail": [
            {
              "surface": {
                "min": 123,
                "max": 123
              },
              "nature": [
                {
                  "type": "NATURE_OF_LAND_UNKNOWN",
                  "specialType": "<string>"
                }
              ]
            }
          ],
          "locals": [
            "LOCAL_TYPE_UNKNOWN"
          ],
          "propertyDetail": [
            {
              "type": "PROPERTY_TYPE_UNKNOWN",
              "surface": {
                "min": 123,
                "max": 123
              },
              "mainRoomsCount": {
                "min": 123,
                "max": 123
              },
              "localType": "LOCAL_TYPE_UNKNOWN"
            }
          ],
          "lots": [
            {
              "number": {
                "min": 123,
                "max": 123
              },
              "surface": {
                "min": 123,
                "max": 123
              }
            }
          ],
          "lotCount": {
            "min": 123,
            "max": 123
          }
        }
      ],
      "properties": [
        {
          "type": "PROPERTY_TYPE_UNKNOWN",
          "surface": {
            "min": 123,
            "max": 123
          },
          "mainRoomsCount": {
            "min": 123,
            "max": 123
          },
          "localType": "LOCAL_TYPE_UNKNOWN"
        }
      ],
      "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>"
          }
        }
      },
      "type": [
        "MUTATION_NATURE_UNKNOWN"
      ],
      "price": [
        {
          "value": {
            "min": 123,
            "max": 123
          },
          "valuePerArea": {
            "min": 123,
            "max": 123
          },
          "valuePerAreaCarrez": {
            "min": 123,
            "max": 123
          },
          "source": {
            "website": "<string>",
            "url": "<string>",
            "flxId": "<string>"
          }
        }
      ],
      "inflatedPrice": [
        {
          "value": {
            "min": 123,
            "max": 123
          },
          "valuePerArea": {
            "min": 123,
            "max": 123
          },
          "valuePerAreaCarrez": {
            "min": 123,
            "max": 123
          },
          "source": {
            "website": "<string>",
            "url": "<string>",
            "flxId": "<string>"
          }
        }
      ],
      "mainAdress": [
        {
          "number": "<string>",
          "streetName": "<string>"
        }
      ]
    }
  },
  "searchAfter": [
    "<string>"
  ],
  "sortBy": "RELEVANCE",
  "orderBy": "ASC",
  "size": 123,
  "excludedFields": [
    "<string>"
  ],
  "includedFields": [
    "<string>"
  ]
}'
{
  "apiVersion": "<string>",
  "context": "<string>",
  "data": [
    {
      "flxId": "<string>",
      "meta": {
        "mutationId": "<string>",
        "mutationDate": "2023-11-07T05:31:56Z",
        "anomalies": [
          "ANOMALY_UNKNOWN"
        ],
        "hasAnomaly": true
      },
      "group": "LOCAL_GROUP_UNKNOWN",
      "totalLandSurface": 123,
      "totalPropertySurface": 123,
      "totalRoomCount": 123,
      "mainProperty": {
        "type": "PROPERTY_TYPE_UNKNOWN",
        "surface": 123,
        "mainRoomsCount": 123,
        "localType": "LOCAL_TYPE_UNKNOWN"
      },
      "parcels": [
        {
          "id": "<string>",
          "location": {
            "address": {
              "number": "<string>",
              "streetName": "<string>"
            },
            "postalCode": "<string>",
            "inseeCode": "<string>",
            "irisCode": "<string>",
            "department": "<string>",
            "city": "<string>",
            "locationCoordinate": {
              "location": [
                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": [
                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>"
              }
            }
          },
          "landDetail": {
            "totalSurface": 123,
            "nature": [
              {
                "surface": 123,
                "type": "NATURE_OF_LAND_UNKNOWN",
                "specialType": "<string>"
              }
            ]
          },
          "propertyDetail": [
            {
              "type": "PROPERTY_TYPE_UNKNOWN",
              "surface": 123,
              "mainRoomsCount": 123,
              "localType": "LOCAL_TYPE_UNKNOWN"
            }
          ],
          "lots": [
            {
              "number": 123,
              "surface": 123
            }
          ],
          "lotCount": 123
        }
      ],
      "properties": [
        {
          "type": "PROPERTY_TYPE_UNKNOWN",
          "surface": 123,
          "mainRoomsCount": 123,
          "localType": "LOCAL_TYPE_UNKNOWN"
        }
      ],
      "location": [
        {
          "address": {
            "number": "<string>",
            "streetName": "<string>"
          },
          "postalCode": "<string>",
          "inseeCode": "<string>",
          "irisCode": "<string>",
          "department": "<string>",
          "city": "<string>",
          "locationCoordinate": {
            "location": [
              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": [
              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>"
            }
          }
        }
      ],
      "type": "MUTATION_NATURE_UNKNOWN",
      "price": {
        "value": 123,
        "valuePerArea": 123,
        "valuePerAreaCarrez": 123,
        "source": {
          "website": "<string>",
          "url": "<string>",
          "flxId": "<string>"
        }
      },
      "inflatedPrice": {
        "value": 123,
        "valuePerArea": 123,
        "valuePerAreaCarrez": 123,
        "source": {
          "website": "<string>",
          "url": "<string>",
          "flxId": "<string>"
        }
      },
      "mainAdress": {
        "number": "<string>",
        "streetName": "<string>"
      }
    }
  ],
  "searchAfter": [
    "<string>"
  ],
  "internalDelay": 123
}

Authorizations

x-api-key
string
headerrequired

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

Body

application/json
search
object
searchAfter
string[]
sortBy
enum<string>
default: RELEVANCE
Available options:
RELEVANCE,
SURFACE,
PRICE,
LAND_SURFACE,
MUTATED_AT,
PRICE_PER_AREA
orderBy
enum<string>
default: ASC
Available options:
ASC,
DESC
size
integer
excludedFields
string[]
includedFields
string[]

Response

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