Get all your Advert alerts

Authorizations

x-api-key

string

headerrequired

Response

200 - application/json

data

object[]

data.data

object

required

data.data.search_query

object

required

data.data.search_query.filterAd

object

required

data.data.search_query.filterAd.currentPrice

object

data.data.search_query.filterAd.habitation

object

data.data.search_query.filterAd.habitation.bathroomCount

object

data.data.search_query.filterAd.habitation.bedroomCount

object

data.data.search_query.filterAd.habitation.characteristics

object

data.data.search_query.filterAd.habitation.climate

object

data.data.search_query.filterAd.habitation.climate.epcClimate

enum<string>[]

The classification value of the greenhouse gas emission classification - GES

Available 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.data.search_query.filterAd.habitation.climate.epcClimateScore

object

The value of the greenhouse gas emission classification - GES in kgCO2/m²/year

data.data.search_query.filterAd.habitation.climate.epcEnergy

enum<string>[]

The classification value of the energy classification - DPE

Available 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.data.search_query.filterAd.habitation.climate.epcEnergyScore

object

The value of the energy classification - DPE in kWhEP/m²/year

data.data.search_query.filterAd.habitation.climate.epcClimateDate

object

data.data.search_query.filterAd.habitation.climate.epcEnergyDate

object

data.data.search_query.filterAd.habitation.features

object

data.data.search_query.filterAd.habitation.features.exposure

enum<string>[]

Available options:

EXPOSURE_UNKNOWN,

EXPOSURE_NORTH,

EXPOSURE_NORTH_EAST,

EXPOSURE_EAST,

EXPOSURE_SOUTH_EAST,

EXPOSURE_SOUTH,

EXPOSURE_SOUTH_WEST,

EXPOSURE_WEST,

EXPOSURE_NORTH_WEST

data.data.search_query.filterAd.habitation.features.furniture

enum<string>[]

Available options:

UNKNOWN_FURNITURE,

UNFURNISHED,

PARTIALLY_FURNISHED,

FULLY_FURNISHED

data.data.search_query.filterAd.habitation.features.propertyFloor

object

data.data.search_query.filterAd.habitation.features.propertyTotalFloor

object

data.data.search_query.filterAd.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.data.search_query.filterAd.habitation.features.glazingTypes

enum<string>[]

Available options:

GLAZING_TYPE_UNKNOWN,

GLAZING_TYPE_SIMPLE,

GLAZING_TYPE_DOUBLE,

GLAZING_TYPE_TRIPLE

data.data.search_query.filterAd.habitation.features.hasThroughExposure

boolean

data.data.search_query.filterAd.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.data.search_query.filterAd.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.data.search_query.filterAd.habitation.heatTypes

enum<string>[]

Available options:

HEAT_TYPE_UNKNOWN,

HEAT_TYPE_INDIVIDUAL,

HEAT_TYPE_SHARED,

HEAT_TYPE_MIX,

HEAT_TYPE_CITY,

HEAT_TYPE_CISTERN

data.data.search_query.filterAd.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_REVERSIBLE_AIR_CON,

HEAT_DETAIL_RADIANTS_TUBES,

HEAT_DETAIL_RADIATOR,

HEAT_DETAIL_SHEAHS,

HEAT_DETAIL_CONVECTOR

data.data.search_query.filterAd.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.data.search_query.filterAd.habitation.propertyCondition

object[]

data.data.search_query.filterAd.habitation.roomCount

object

data.data.search_query.filterAd.habitation.surface

object

data.data.search_query.filterAd.habitation.surface.balconies

object

The surface of the balconies in m² - we rarely have this information

data.data.search_query.filterAd.habitation.surface.floorSpace

object

The surface of the total floors in m² - we rarely have this information

data.data.search_query.filterAd.habitation.surface.gardens

object

The surface of the gardens in m² - we rarely have this information

data.data.search_query.filterAd.habitation.surface.groundFloor

object

The surface of the ground floor in m² - we rarely have this information

data.data.search_query.filterAd.habitation.surface.kitchen

object

The surface of the kitchen in m² - we rarely have this information

data.data.search_query.filterAd.habitation.surface.livingSpace

object

The surface of the living space in m² - we rarely have this information

data.data.search_query.filterAd.habitation.surface.livingroom

object

The surface of the living room in m² - we rarely have this information

data.data.search_query.filterAd.habitation.surface.terraces

object

The surface of the terraces in m² - we rarely have this information

data.data.search_query.filterAd.habitation.surface.total

object

The total habitable surface of the property in m²

data.data.search_query.filterAd.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_OTHER_APARTMENT_TYPE,

PROPERTY_TYPE_INDIVIDUAL,

PROPERTY_TYPE_ONE_SIDE_TERRACED,

PROPERTY_TYPE_TWO_SIDE_TERRACED,

PROPERTY_TYPE_SINGLE_STOREY,

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

data.data.search_query.filterAd.habitation.wcCount

object

data.data.search_query.filterAd.hasAnomaly

boolean

An anomaly or incoherence have been detected

data.data.search_query.filterAd.isAuction

boolean

data.data.search_query.filterAd.isUrgent

boolean

data.data.search_query.filterAd.land

object

data.data.search_query.filterAd.lastModifiedAt

object[]

data.data.search_query.filterAd.offer

object[]

data.data.search_query.filterAd.parking

object

data.data.search_query.filterAd.process

enum<string>[]

Available options:

PROCESS_UNKNOWN,

PROCESS_AVAILABLE_ON_MARKET,

PROCESS_UNDER_COMPROMISE,

PROCESS_RENTED_SOLD,

PROCESS_REMOVED,

PROCESS_RESERVED,

PROCESS_ARCHIVED

data.data.search_query.filterAd.scope

enum<string>[]

Available options:

PRICING_ONE_OFF,

PRICING_MENSUAL

data.data.search_query.filterAd.tags

string[]

data.data.search_query.filterAd.type

enum<string>[]

Available options:

CLASS_UNKNOWN,

CLASS_HOUSE,

CLASS_FLAT,

CLASS_PROGRAM,

CLASS_SHOP,

CLASS_PREMISES,

CLASS_OFFICE,

CLASS_LAND,

CLASS_BUILDING,

CLASS_PARKING

data.data.search_query.filterAd.warrantyDeposit

object

data.data.search_query.filterAd.firstSeenAt

object[]

data.data.search_query.filterAd.location

object

data.data.search_query.filterAd.location.city

string

data.data.search_query.filterAd.location.cityCoordinate

object

data.data.search_query.filterAd.location.department

string

data.data.search_query.filterAd.location.inseeCode

string

data.data.search_query.filterAd.location.irisCode

string

data.data.search_query.filterAd.location.locationCoordinate

object

data.data.search_query.filterAd.location.postalCode

string

data.data.search_query.filterAd.source

object

data.data.search_query.filterAd.currency

enum<string>[]

Available options:

CURRENCY_EUR,

CURRENCY_USD

data.data.search_query.filterAd.mainPropertyAdFlxId

string[]

data.data.search_query.filterAd.propertyFlxId

string[]

data.data.search_query.filterAd.isPro

boolean

data.data.search_query.filterAd.seller

object[]

data.data.search_query.filterAd.isOnline

boolean

data.data.search_query.filterAd.isExclusive

boolean

data.data.search_query.fullTexts

string[]

required

Search terms for full text search. We'll search in title, description, and keywords for terms similar to these (typically, we'll use a fuzzy search).

data.data.search_query.keywords

string[]

required

Search terms for keyword search. We'll search in title, description, and keywords for exact matches to these terms (typically, we'll use a term search).

data.data.webhook_url

string

data.data.search_name

string

data.data.context

object

data.data.match

enum<string>[]

Available options:

ALERT_MATCH_UNKNOWN,

ALERT_MATCH_CREATED,

ALERT_MATCH_ADVERT_EVENT

data.data.activated

boolean

required

data.data.alert_id

string

required

System

Properties

DVF

Adverts

Models

Authorizations

Response