SearchAdByURL - Retrieve an ad by a given url link.
SearchAdByURL - Retrieve an ad by a given url link.
POST
/
v2
/
ad
/
url
/
_search
x-api-key
string
*
x-api-key
Required
string
API Key used to be authentified to these APIs. Please contact Fluximmo to get one
object
*
url
string
url
string
excludedFields
array
excludedFields
array
includedFields
array
includedFields
array
Authorizations
x-api-key
string
headerrequiredAPI Key used to be authentified to these APIs. Please contact Fluximmo to get one
Body
application/json
url
string
excludedFields
string[]
includedFields
string[]
Response
200 - application/json
apiVersion
string
context
string
data
object
Representation of a self-contained ad. This is not a user-friendly representation
data.legacyId
string
data.flxId
string
data.firstSeenAt
string
data.firstPublishedAt
string
data.lastModifiedAt
string
data.lastSeenAt
string
data.offlineAt
string
data.title
string
data.description
string
data.tags
string[]
data.medias
object
data.medias.virtualVisitExternalUrl
string[]
data.medias.images
object[]
data.medias.images.imageId
string
data.medias.images.url
string
data.medias.images.s3Path
string
data.medias.images.gaussianHash
string
data.medias.images.perceptualHash
string
data.medias.images.meanHash
string
data.medias.images.tags
string[]
data.medias.images.caption
string
data.medias.images.room
enum<string>
default: ROOM_UNKNOWNAvailable options:
ROOM_UNKNOWN, ROOM_BLUEPRINT, ROOM_BATHROOM, ROOM_BEDROOM, ROOM_LIVINGROOM_DININGROOM, ROOM_GARAGE, ROOM_HALLWAY, ROOM_LAUNDRY_ROOM, ROOM_OFFICE, ROOM_EXTERIOR data.isUrgent
boolean
data.offer
object
data.offer.type
enum<string>
default: OFFER_UNKNOWNAvailable options:
OFFER_UNKNOWN, OFFER_BUY, OFFER_RENT, OFFER_BUSINESS_TAKE_OVER, OFFER_LEASE_BACK, OFFER_LIFE_ANNUITY_SALE, OFFER_HOLIDAYS data.offer.renting
object
data.offer.renting.isSubLease
boolean
data.offer.renting.isShortTerm
boolean
data.offer.renting.isLongTerm
boolean
data.offer.renting.isColocation
boolean
data.offer.isCurrentlyOccupied
boolean
data.type
enum<string>
default: CLASS_UNKNOWNAvailable options:
CLASS_UNKNOWN, CLASS_HOUSE, CLASS_FLAT, CLASS_PROGRAM, CLASS_SHOP, CLASS_PREMISES, CLASS_OFFICE, CLASS_LAND, CLASS_BUILDING, CLASS_PARKING data.process
enum<string>
default: PROCESS_UNKNOWNAvailable options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED data.currentPrice
object
data.currentPrice.value
number
data.currentPrice.valuePerArea
number
data.currentPrice.source
object
data.currentPrice.source.website
string
data.currentPrice.source.url
string
data.currentPrice.source.flxId
string
data.estimatedPrice
object
data.estimatedPrice.value
number
data.estimatedPrice.valuePerArea
number
data.estimatedPrice.source
object
data.estimatedPrice.source.website
string
data.estimatedPrice.source.url
string
data.estimatedPrice.source.flxId
string
data.warrantyDeposit
number
data.charges
object
data.charges.yearlyRentalFees
number
data.charges.yearlyCondoniumFees
number
data.charges.yearlyHeatingFees
number
data.charges.yearlyElectricityFees
number
data.charges.yearlyHousingTax
number
data.charges.yearlyLivingTax
number
data.charges.monthlyRentSupplement
number
data.isAuction
boolean
data.scope
enum<string>
default: PRICING_ONE_OFFAvailable options:
PRICING_ONE_OFF, PRICING_MENSUAL data.currency
enum<string>
default: CURRENCY_EURAvailable options:
CURRENCY_EUR, CURRENCY_USD data.habitation
object
data.habitation.type
enum<string>[]
Available options:
PROPERTY_TYPE_UNKNOWN, PROPERTY_TYPE_STUDIO, PROPERTY_TYPE_T1, PROPERTY_TYPE_T1_T2, PROPERTY_TYPE_T2, PROPERTY_TYPE_T2_T3, PROPERTY_TYPE_T3, PROPERTY_TYPE_T3_4, PROPERTY_TYPE_T4, PROPERTY_TYPE_T4_5, PROPERTY_TYPE_T5_MORE, PROPERTY_TYPE_LOFT, PROPERTY_TYPE_DUPLEX, PROPERTY_TYPE_INDIVIDUAL, PROPERTY_TYPE_TRADITIONAL, PROPERTY_TYPE_CONTEMPORARY, PROPERTY_TYPE_BOURGEOIS, PROPERTY_TYPE_VILLA, PROPERTY_TYPE_MANOR, PROPERTY_TYPE_CASTLE, PROPERTY_TYPE_FARM, PROPERTY_TYPE_MAS, PROPERTY_TYPE_BASTIDE, PROPERTY_TYPE_CHALET, PROPERTY_TYPE_ANCIENT, PROPERTY_TYPE_HERITAGE_LISTED, PROPERTY_TYPE_BUNGALOW, PROPERTY_TYPE_STUDETTE data.habitation.roomCount
integer
data.habitation.bedroomCount
integer
data.habitation.bathroomCount
integer
data.habitation.wcCount
integer
data.habitation.roomsDetails
object[]
data.habitation.roomsDetails.roomType
enum<string>
default: ROOM_TYPE_UNKNOWNAvailable options:
ROOM_TYPE_UNKNOWN, ROOM_TYPE_MASTER_BEDROOM, ROOM_TYPE_BEDROOM, ROOM_TYPE_KITCHEN, ROOM_TYPE_LIVING_ROOM, ROOM_TYPE_OFFICE data.habitation.roomsDetails.area
number
data.habitation.roomsDetails.floor
integer
data.habitation.roomsDetails.contextInfo
string[]
data.habitation.heatTypes
enum<string>[]
Available options:
HEAT_TYPE_UNKNOWN, HEAT_TYPE_INDIVIDUAL, HEAT_TYPE_SHARED, HEAT_TYPE_MIXED, HEAT_TYPE_CITY, HEAT_TYPE_CISTERN data.habitation.heatTypeDetails
enum<string>[]
Available options:
HEAT_DETAIL_UNKNOWN, HEAT_DETAIL_FLOOR, HEAT_DETAIL_CEILING, HEAT_DETAIL_FIREPLACE, HEAT_DETAIL_INSERT, HEAT_DETAIL_AIR_CON, HEAT_DETAIL_RADIANTS_TUBES, HEAT_DETAIL_RADIATOR, HEAT_DETAIL_SHEATHS, HEAT_DETAIL_CONVECTOR data.habitation.heatings
enum<string>[]
Available options:
HEATING_UNKNOWN, HEATING_FUEL_OIL, HEATING_ELECTRICAL, HEATING_GAS, HEATING_BIOMASS, HEATING_SOLAR, HEATING_GEOTHERMAL, HEATING_WOOD, HEATING_HEAT_PUMP, HEATING_PELLET, HEATING_CANADIAN_WELL, HEATING_COAL data.habitation.kitchenEquipped
enum<string>
default: KITCHEN_UNKNOWN_EQUIPPEDAvailable options:
KITCHEN_UNKNOWN_EQUIPPED, KITCHEN_NON_EQUIPPED, KITCHEN_PARTIALLY_EQUIPPED, KITCHEN_FULLY_EQUIPPED, KITCHEN_FURNISHED, KITCHEN_NAKED, KITCHEN_EQUIPPED_FURNISHED data.habitation.features
object
data.habitation.features.propertyTotalFloor
integer
data.habitation.features.propertyFloor
integer
data.habitation.features.viewTypes
enum<string>[]
Available options:
VIEW_TYPE_UNKNOWN, VIEW_TYPE_GLIMPSE, VIEW_TYPE_PANORAMIC, VIEW_TYPE_CLEAR, VIEW_TYPE_EXCEPTIONAL, VIEW_TYPE_DOMINANT data.habitation.features.exposure
enum<string>
default: EXPOSURE_UNKNOWNAvailable options:
EXPOSURE_UNKNOWN, EXPOSURE_NORTH, EXPOSURE_NORTH_EAST, EXPOSURE_EAST, EXPOSURE_SOUTH_EAST, EXPOSURE_SOUTH, EXPOSURE_SOUTH_WEST, EXPOSURE_WEST, EXPOSURE_NORTH_WEST data.habitation.features.furniture
enum<string>
default: UNKNOWN_FURNITUREAvailable options:
UNKNOWN_FURNITURE, UNFURNISHED, PARTIALLY_FURNISHED, FULLY_FURNISHED data.habitation.features.constructionMaterials
enum<string>[]
Available options:
MATERIAL_UNKNOWN, MATERIAL_WOODEN, MATERIAL_STEEL, MATERIAL_STONE, MATERIAL_PVC, MATERIAL_CONCRETE, MATERIAL_ALUMINIUM, MATERIAL_HALF_TIMBERED, MATERIAL_MARBLE, MATERIAL_BRICK, MATERIAL_CINDER_BLOCK, MATERIAL_PREFABRICATED, MATERIAL_ADOBE, MATERIAL_COATING data.habitation.features.viewOns
enum<string>[]
Available options:
VIEW_ON_UNKNOWN, VIEW_ON_SEA, VIEW_ON_HILLS, VIEW_ON_RIVERS, VIEW_ON_CITY, VIEW_ON_PARK, VIEW_ON_VERDURE, VIEW_ON_STREET, VIEW_ON_COURTYARD, VIEW_ON_COUNTRYSIDE, VIEW_ON_MOUNTAIN, VIEW_ON_GARDEN_TERRACE, VIEW_ON_LAKE, VIEW_ON_SKI_SLOPES, VIEW_ON_PORT, VIEW_ON_POI, VIEW_ON_SKY, VIEW_ON_WATER, VIEW_ON_VINEYARD, VIEW_ON_ROOF data.habitation.features.glazingTypes
enum<string>[]
Available options:
GLAZING_TYPE_UNKNOWN, GLAZING_TYPE_SIMPLE, GLAZING_TYPE_DOUBLE, GLAZING_TYPE_TRIPLE data.habitation.features.hasThroughExposure
boolean
data.habitation.characteristics
object
data.habitation.characteristics.hasLift
boolean
data.habitation.characteristics.hasCellar
boolean
data.habitation.characteristics.hasBalcony
boolean
data.habitation.characteristics.hasTerrace
boolean
data.habitation.characteristics.hasGarden
boolean
data.habitation.characteristics.hasFireplace
boolean
data.habitation.characteristics.hasGrenier
boolean
data.habitation.characteristics.hasPool
boolean
data.habitation.characteristics.hasParking
boolean
data.habitation.characteristics.hasGarage
boolean
data.habitation.characteristics.hasLand
boolean
data.habitation.characteristics.hasConcierge
boolean
data.habitation.characteristics.hasDigicode
boolean
data.habitation.characteristics.hasInterphone
boolean
data.habitation.characteristics.hasAlarm
boolean
data.habitation.characteristics.hasVisAVis
boolean
data.habitation.characteristics.isPeaceful
boolean
data.habitation.characteristics.hasMezzanine
boolean
data.habitation.characteristics.hasJacuzzi
boolean
data.habitation.climate
object
data.habitation.climate.epcEnergy
enum<string>
default: ENERGY_CLASSIFICATION_UNKNOWNAvailable options:
ENERGY_CLASSIFICATION_UNKNOWN, ENERGY_CLASSIFICATION_G, ENERGY_CLASSIFICATION_F, ENERGY_CLASSIFICATION_E, ENERGY_CLASSIFICATION_D, ENERGY_CLASSIFICATION_C, ENERGY_CLASSIFICATION_B, ENERGY_CLASSIFICATION_A, ENERGY_CLASSIFICATION_NC data.habitation.climate.epcClimate
enum<string>
default: GREENHOUSE_CLASSIFICATION_UNKNOWNAvailable options:
GREENHOUSE_CLASSIFICATION_UNKNOWN, GREENHOUSE_CLASSIFICATION_G, GREENHOUSE_CLASSIFICATION_F, GREENHOUSE_CLASSIFICATION_E, GREENHOUSE_CLASSIFICATION_D, GREENHOUSE_CLASSIFICATION_C, GREENHOUSE_CLASSIFICATION_B, GREENHOUSE_CLASSIFICATION_A, GREENHOUSE_CLASSIFICATION_NC data.habitation.climate.epcEnergyScore
number
data.habitation.climate.epcClimateScore
number
data.habitation.climate.epcClimateDate
string
data.habitation.climate.epcEnergyDate
string
data.habitation.propertyCondition
object
data.habitation.propertyCondition.interiorCondition
enum<string>
default: INTERIOR_CONDITION_UNKNOWNAvailable options:
INTERIOR_CONDITION_UNKNOWN, INTERIOR_CONDITION_EXCELLENT, INTERIOR_CONDITION_TO_REFRESH, INTERIOR_CONDITION_SMALL_WORKS_TO_BE_PLANNED, INTERIOR_CONDITION_MAJOR_WORKS_TO_BE_PALLNED, INTERIOR_CONDITION_BRAND_NEW, INTERIOR_CONDITION_GOOD_CONDITION, INTERIOR_CONDITION_TO_BE_RENOVATED data.habitation.propertyCondition.constructionYear
integer
data.habitation.propertyCondition.generalConditions
enum<string>[]
Available options:
GENERAL_CONDITION_UNKNOWN, GENERAL_CONDITION_TO_BE_RENOVATED, GENERAL_CONDITION_BRAND_NEW, GENERAL_CONDITION_RENOVATED, GENERAL_CONDITION_TO_BE_REFRESHED, GENERAL_CONDITION_GOOD, GENERAL_CONDITION_EXCELLENT, GENERAL_CONDITION_DECREPIT, GENERAL_CONDITION_TO_BE_BUILT data.habitation.propertyCondition.renovationYear
integer
data.habitation.surface
object
data.habitation.surface.total
integer
data.habitation.surface.livingSpace
integer
data.habitation.surface.floorSpace
integer
data.habitation.surface.livingRoom
integer
data.habitation.surface.kitchen
integer
data.habitation.surface.groundFloor
integer
data.habitation.surface.balconies
integer
data.habitation.surface.terraces
integer
data.habitation.surface.gardens
integer
data.parking
object
data.parking.type
enum<string>
default: PARKING_UNKNOWNAvailable options:
PARKING_UNKNOWN, PARKING_GARAGE, PARKING_PARKING data.parking.count
integer
data.parking.numberOfCars
integer
data.parking.surface
integer
data.land
object
data.land.type
enum<string>
default: LAND_UNKNOWNAvailable options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST data.land.hasBuildingPermit
boolean
data.land.canConstruct
boolean
data.land.surfaceConstructable
integer
data.land.surface
integer
data.land.isServiced
boolean
data.land.hasWater
boolean
data.land.hasElectricity
boolean
data.land.hasTelecom
boolean
data.source
object
data.source.website
string
data.source.url
string
data.source.flxId
string
data.location
object
data.location.address
object
data.location.address.number
string
data.location.address.streetName
string
data.location.postalCode
string
data.location.inseeCode
string
data.location.irisCode
string
data.location.department
string
data.location.city
string
data.location.locationCoordinate
object
data.location.locationCoordinate.location
number[]
data.location.locationCoordinate.h3Indices
object
Hierarchical Geobased data-representation. This create a grid of the world with a certain level of details depending on the actual picked index. Please see more here: https://h3geo.org/docs/core-library/restable
data.location.locationCoordinate.h3Indices.h3Index1
string
data.location.locationCoordinate.h3Indices.h3Index2
string
data.location.locationCoordinate.h3Indices.h3Index3
string
data.location.locationCoordinate.h3Indices.h3Index4
string
data.location.locationCoordinate.h3Indices.h3Index5
string
data.location.locationCoordinate.h3Indices.h3Index6
string
data.location.locationCoordinate.h3Indices.h3Index7
string
data.location.locationCoordinate.h3Indices.h3Index8
string
data.location.locationCoordinate.h3Indices.h3Index9
string
data.location.locationCoordinate.h3Indices.h3Index10
string
data.location.locationCoordinate.h3Indices.h3Index11
string
data.location.locationCoordinate.h3Indices.h3Index12
string
data.location.cityCoordinate
object
data.location.cityCoordinate.location
number[]
data.location.cityCoordinate.h3Indices
object
Hierarchical Geobased data-representation. This create a grid of the world with a certain level of details depending on the actual picked index. Please see more here: https://h3geo.org/docs/core-library/restable
data.location.cityCoordinate.h3Indices.h3Index1
string
data.location.cityCoordinate.h3Indices.h3Index2
string
data.location.cityCoordinate.h3Indices.h3Index3
string
data.location.cityCoordinate.h3Indices.h3Index4
string
data.location.cityCoordinate.h3Indices.h3Index5
string
data.location.cityCoordinate.h3Indices.h3Index6
string
data.location.cityCoordinate.h3Indices.h3Index7
string
data.location.cityCoordinate.h3Indices.h3Index8
string
data.location.cityCoordinate.h3Indices.h3Index9
string
data.location.cityCoordinate.h3Indices.h3Index10
string
data.location.cityCoordinate.h3Indices.h3Index11
string
data.location.cityCoordinate.h3Indices.h3Index12
string
data.isCityCenter
boolean
data.hasAnomaly
boolean
data.anomalies
enum<string>[]
Available options:
UNKNOWN_ANOMALY, NO_EXACT_LOCATION_ANOMALY, NO_PARKING_COUNT_ANOMALY, NO_DESCRIPTION_ANOMALY, NO_MEDIAS_ANOMALY, NO_PICTURE_ANOMALY, TOO_SHORT_DESCRIPTION_ANOMALY, TOO_SHORT_TITLE_ANOMALY, LOW_PRICE_ANOMALY, HIGH_PRICE_ANOMALY, INCOHERENT_LOCATION_ANOMALY, INCOHERENT_LAND_VALUES_ANOMALY, INCOHERENT_HABITATION_VALUES_ANOMALY, TOO_SMALL_ROOM_ANOMALY, SURFACE_IS_NONE, ROOM_COUNT_IS_NONE, BEDROOM_COUNT_IS_NONE, PRICE_INCOHERENT, TITLE_TOO_SHORT, DESCRIPTION_TOO_SHORT, PRICE_IS_NONE, POSTAL_CODE_IS_NONE, INSEE_CODE_IS_NONE, CITY_IS_NONE, OFFER_TYPE_IS_NONE, TYPE_IS_NONE data.isPro
boolean
data.seller
object
data.seller.type
enum<string>
default: SELLER_TYPE_UNKNOWNAvailable options:
SELLER_TYPE_UNKNOWN, SELLER_TYPE_AGENCY, SELLER_TYPE_NETWORK data.seller.flxId
string
data.seller.name
string
data.seller.siren
string
data.contactInCharge
object
data.contactInCharge.firstName
string
data.contactInCharge.lastName
string
data.contactInCharge.phoneNumber
string
data.contactInCharge.email
string
data.contactInCharge.pseudonym
string
data.isKnownProperty
boolean
data.mainPropertyAdFlxId
string
data.propertyFlxId
string
data.isOnline
boolean
data.websiteRefs
string[]
data.isExclusive
boolean
internalDelay
integer
Was this page helpful?