POST
/
v2
/
ad
/
search
curl --request POST \
  --url https://api.f6o.co/v2/ad/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "excludedFields": [
    "<string>"
  ],
  "includedFields": [
    "<string>"
  ],
  "orderBy": "ASC",
  "search": {
    "filterAd": {
      "anomalies": [
        "<string>"
      ],
      "charges": {
        "monthlyRentSupplement": 123,
        "yearlyCondoniumFees": 123,
        "yearlyElectricityFees": 123,
        "yearlyHeatingFees": 123,
        "yearlyHousingTax": 123,
        "yearlyLivingTax": 123,
        "yearlyRentalFees": 123
      },
      "contactInCharge": {
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "pseudonym": "<string>"
      },
      "currency": [
        "CURRENCY_EUR"
      ],
      "currentPrice": {
        "source": {
          "flxId": "<string>",
          "url": "<string>",
          "website": "<string>"
        },
        "value": {
          "max": 123,
          "min": 123
        },
        "valuePerArea": {
          "max": 123,
          "min": 123
        }
      },
      "estimatedPrice": {
        "source": {
          "flxId": "<string>",
          "url": "<string>",
          "website": "<string>"
        },
        "value": {
          "max": 123,
          "min": 123
        },
        "valuePerArea": {
          "max": 123,
          "min": 123
        }
      },
      "firstPublishedAt": [
        {
          "max": "2023-11-07T05:31:56Z",
          "min": "2023-11-07T05:31:56Z"
        }
      ],
      "firstSeenAt": [
        {
          "max": "2023-11-07T05:31:56Z",
          "min": "2023-11-07T05:31:56Z"
        }
      ],
      "habitation": {
        "bathroomCount": {
          "max": 123,
          "min": 123
        },
        "bedroomCount": {
          "max": 123,
          "min": 123
        },
        "characteristics": {
          "hasAlarm": true,
          "hasBalcony": true,
          "hasCellar": true,
          "hasConcierge": true,
          "hasDigicode": true,
          "hasFireplace": true,
          "hasGarage": true,
          "hasGarden": true,
          "hasGrenier": true,
          "hasInterphone": true,
          "hasJacuzzi": true,
          "hasLand": true,
          "hasLift": true,
          "hasMezzanine": true,
          "hasParking": true,
          "hasPool": true,
          "hasTerrace": true,
          "hasVisAVis": true,
          "isPeaceful": true
        },
        "climate": {
          "epcClimate": [
            "GREENHOUSE_CLASSIFICATION_UNKNOWN"
          ],
          "epcClimateDate": {
            "max": "2023-11-07T05:31:56Z",
            "min": "2023-11-07T05:31:56Z"
          },
          "epcClimateScore": {
            "max": 123,
            "min": 123
          },
          "epcEnergy": [
            "ENERGY_CLASSIFICATION_UNKNOWN"
          ],
          "epcEnergyDate": {
            "max": "2023-11-07T05:31:56Z",
            "min": "2023-11-07T05:31:56Z"
          },
          "epcEnergyScore": {
            "max": 123,
            "min": 123
          }
        },
        "features": {
          "constructionMaterials": [
            "MATERIAL_UNKNOWN"
          ],
          "exposure": [
            "EXPOSURE_UNKNOWN"
          ],
          "furniture": [
            "UNKNOWN_FURNITURE"
          ],
          "glazingTypes": [
            "GLAZING_TYPE_UNKNOWN"
          ],
          "hasThroughExposure": true,
          "propertyFloor": {
            "max": 123,
            "min": 123
          },
          "propertyTotalFloor": {
            "max": 123,
            "min": 123
          },
          "viewOns": [
            "VIEW_ON_UNKNOWN"
          ],
          "viewTypes": [
            "VIEW_TYPE_UNKNOWN"
          ]
        },
        "heatTypeDetails": [
          "HEAT_DETAIL_UNKNOWN"
        ],
        "heatTypes": [
          "HEAT_TYPE_UNKNOWN"
        ],
        "heatings": [
          "HEATING_UNKNOWN"
        ],
        "kitchenEquipped": [
          "KITCHEN_UNKNOWN_EQUIPPED"
        ],
        "propertyCondition": [
          {
            "constructionYear": 123,
            "generalConditions": [
              "GENERAL_CONDITION_UNKNOWN"
            ],
            "interiorCondition": "INTERIOR_CONDITION_UNKNOWN",
            "renovationYear": 123
          }
        ],
        "roomCount": {
          "max": 123,
          "min": 123
        },
        "roomsDetails": [
          {
            "area": 123,
            "contextInfo": [
              "<string>"
            ],
            "floor": 123,
            "roomType": "ROOM_TYPE_UNKNOWN"
          }
        ],
        "surface": {
          "balconies": {
            "max": 123,
            "min": 123
          },
          "floorSpace": {
            "max": 123,
            "min": 123
          },
          "gardens": {
            "max": 123,
            "min": 123
          },
          "groundFloor": {
            "max": 123,
            "min": 123
          },
          "kitchen": {
            "max": 123,
            "min": 123
          },
          "livingSpace": {
            "max": 123,
            "min": 123
          },
          "livingroom": {
            "max": 123,
            "min": 123
          },
          "terraces": {
            "max": 123,
            "min": 123
          },
          "total": {
            "max": 123,
            "min": 123
          }
        },
        "type": "PROPERTY_TYPE_UNKNOWN",
        "wcCount": {
          "max": 123,
          "min": 123
        }
      },
      "hasAnomaly": true,
      "isAuction": true,
      "isKnownProperty": true,
      "isOnline": true,
      "isPro": true,
      "isUrgent": true,
      "land": {
        "canConstruct": true,
        "haveBuildingPermit": true,
        "haveElectricity": true,
        "haveTelecom": true,
        "haveWater": true,
        "isServiced": true,
        "surface": {
          "max": 123,
          "min": 123
        },
        "surfaceConstructable": {
          "max": 123,
          "min": 123
        },
        "type": [
          "LAND_UNKNOWN"
        ]
      },
      "lastModifiedAt": [
        {
          "max": "2023-11-07T05:31:56Z",
          "min": "2023-11-07T05:31:56Z"
        }
      ],
      "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>"
      },
      "mainPropertyAdFlxId": [
        "<string>"
      ],
      "offer": [
        {
          "isCurrentlyOccupied": true,
          "renting": {
            "isColocation": true,
            "isLongTerm": true,
            "isShortTerm": true,
            "isSubLease": true
          },
          "type": "OFFER_UNKNOWN"
        }
      ],
      "parking": {
        "count": {
          "max": 123,
          "min": 123
        },
        "numberOfCars": {
          "max": 123,
          "min": 123
        },
        "surface": {
          "max": 123,
          "min": 123
        },
        "type": [
          "PARKING_UNKNOWN"
        ]
      },
      "process": [
        "PROCESS_UNKNOWN"
      ],
      "propertyFlxId": [
        "<string>"
      ],
      "scope": [
        "PRICING_ONE_OFF"
      ],
      "seller": [
        {
          "flxId": "<string>",
          "name": "<string>",
          "siren": "<string>",
          "type": "SELLER_TYPE_UNKNOWN"
        }
      ],
      "source": {
        "flxId": "<string>",
        "url": "<string>",
        "website": "<string>"
      },
      "tags": [
        "<string>"
      ],
      "type": [
        "CLASS_UNKNOWN"
      ],
      "warrantyDeposit": {
        "max": 123,
        "min": 123
      }
    },
    "fullTexts": [
      "<string>"
    ],
    "keywords": [
      "<string>"
    ]
  },
  "searchAfter": [
    "<string>"
  ],
  "size": 123,
  "sortBy": "RELEVANCE"
}'
{
  "apiVersion": "<string>",
  "context": "<string>",
  "count": 123,
  "data": {
    "results": {
      "deleted": "<string>",
      "id": "<string>",
      "items": [
        {
          "anomalies": [
            "UNKNOWN_ANOMALY"
          ],
          "charges": {
            "monthlyRentSupplement": 123,
            "yearlyCondoniumFees": 123,
            "yearlyElectricityFees": 123,
            "yearlyHeatingFees": 123,
            "yearlyHousingTax": 123,
            "yearlyLivingTax": 123,
            "yearlyRentalFees": 123
          },
          "contactInCharge": {
            "email": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "phoneNumber": "<string>",
            "pseudonym": "<string>"
          },
          "currency": "CURRENCY_EUR",
          "currentPrice": {
            "source": {
              "flxId": "<string>",
              "url": "<string>",
              "website": "<string>"
            },
            "value": 123,
            "valuePerArea": 123
          },
          "description": "<string>",
          "estimatedPrice": {
            "source": {
              "flxId": "<string>",
              "url": "<string>",
              "website": "<string>"
            },
            "value": 123,
            "valuePerArea": 123
          },
          "firstPublishedAt": "2023-11-07T05:31:56Z",
          "firstSeenAt": "2023-11-07T05:31:56Z",
          "flxId": "<string>",
          "habitation": {
            "bathroomCount": 123,
            "bedroomCount": 123,
            "characteristics": {
              "hasAlarm": true,
              "hasBalcony": true,
              "hasCellar": true,
              "hasConcierge": true,
              "hasDigicode": true,
              "hasFireplace": true,
              "hasGarage": true,
              "hasGarden": true,
              "hasGrenier": true,
              "hasInterphone": true,
              "hasJacuzzi": true,
              "hasLand": true,
              "hasLift": true,
              "hasMezzanine": true,
              "hasParking": true,
              "hasPool": true,
              "hasTerrace": true,
              "hasVisAVis": true,
              "isPeaceful": true
            },
            "climate": {
              "epcClimate": "GREENHOUSE_CLASSIFICATION_UNKNOWN",
              "epcClimateDate": "2023-11-07T05:31:56Z",
              "epcClimateScore": 123,
              "epcEnergy": "ENERGY_CLASSIFICATION_UNKNOWN",
              "epcEnergyDate": "2023-11-07T05:31:56Z",
              "epcEnergyScore": 123
            },
            "features": {
              "constructionMaterials": [
                "MATERIAL_UNKNOWN"
              ],
              "exposure": "EXPOSURE_UNKNOWN",
              "furniture": "UNKNOWN_FURNITURE",
              "glazingTypes": [
                "GLAZING_TYPE_UNKNOWN"
              ],
              "hasThroughExposure": true,
              "propertyFloor": 123,
              "propertyTotalFloor": 123,
              "viewOns": [
                "VIEW_ON_UNKNOWN"
              ],
              "viewTypes": [
                "VIEW_TYPE_UNKNOWN"
              ]
            },
            "heatTypeDetails": [
              "HEAT_DETAIL_UNKNOWN"
            ],
            "heatTypes": [
              "HEAT_TYPE_UNKNOWN"
            ],
            "heatings": [
              "HEATING_UNKNOWN"
            ],
            "kitchenEquipped": "KITCHEN_UNKNOWN_EQUIPPED",
            "propertyCondition": {
              "constructionYear": 123,
              "generalConditions": [
                "GENERAL_CONDITION_UNKNOWN"
              ],
              "interiorCondition": "INTERIOR_CONDITION_UNKNOWN",
              "renovationYear": 123
            },
            "roomCount": 123,
            "roomsDetails": [
              {
                "area": 123,
                "contextInfo": [
                  "<string>"
                ],
                "floor": 123,
                "roomType": "ROOM_TYPE_UNKNOWN"
              }
            ],
            "surface": {
              "balconies": 123,
              "floorSpace": 123,
              "gardens": 123,
              "groundFloor": 123,
              "kitchen": 123,
              "livingRoom": 123,
              "livingSpace": 123,
              "terraces": 123,
              "total": 123
            },
            "type": [
              "PROPERTY_TYPE_UNKNOWN"
            ],
            "wcCount": 123
          },
          "hasAnomaly": true,
          "isAuction": true,
          "isCityCenter": true,
          "isKnownProperty": true,
          "isOnline": true,
          "isPro": true,
          "isUrgent": true,
          "land": {
            "canConstruct": true,
            "hasBuildingPermit": true,
            "hasElectricity": true,
            "hasTelecom": true,
            "hasWater": true,
            "isServiced": true,
            "surface": 123,
            "surfaceConstructable": 123,
            "type": "LAND_UNKNOWN"
          },
          "lastModifiedAt": "2023-11-07T05:31:56Z",
          "lastSeenAt": "2023-11-07T05:31:56Z",
          "legacyId": "<string>",
          "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": [
                123
              ]
            },
            "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": [
                123
              ]
            },
            "postalCode": "<string>"
          },
          "mainPropertyAdFlxId": "<string>",
          "medias": {
            "images": [
              {
                "caption": "<string>",
                "gaussianHash": "<string>",
                "imageId": "<string>",
                "meanHash": "<string>",
                "perceptualHash": "<string>",
                "room": "ROOM_UNKNOWN",
                "s3Path": "<string>",
                "tags": [
                  "<string>"
                ],
                "url": "<string>"
              }
            ],
            "virtualVisitExternalUrl": [
              "<string>"
            ]
          },
          "offer": {
            "isCurrentlyOccupied": true,
            "renting": {
              "isColocation": true,
              "isLongTerm": true,
              "isShortTerm": true,
              "isSubLease": true
            },
            "type": "OFFER_UNKNOWN"
          },
          "parking": {
            "count": 123,
            "numberOfCars": 123,
            "surface": 123,
            "type": "PARKING_UNKNOWN"
          },
          "process": "PROCESS_UNKNOWN",
          "propertyFlxId": "<string>",
          "scope": "PRICING_ONE_OFF",
          "seller": {
            "flxId": "<string>",
            "name": "<string>",
            "siren": "<string>",
            "type": "SELLER_TYPE_UNKNOWN"
          },
          "source": {
            "flxId": "<string>",
            "url": "<string>",
            "website": "<string>"
          },
          "tags": [
            "<string>"
          ],
          "title": "<string>",
          "type": "CLASS_UNKNOWN",
          "warrantyDeposit": 123,
          "websiteRefs": [
            "<string>"
          ]
        }
      ],
      "kind": "<string>",
      "lang": "<string>",
      "updated": "<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
excludedFields
string[]
includedFields
string[]
orderBy
enum<string>
default: ASC
Available options:
ASC,
DESC
search
object
searchAfter
string[]
size
integer
sortBy
enum<string>
default: RELEVANCE
Available options:
RELEVANCE,
PRICE,
FIRST_SEEN_AT,
LAST_UPDATED_AT,
LAST_SEEN_AT

Response

200 - application/json
apiVersion
string
context
string
count
integer
data
object