Skip to main content
GET
/
documents
/
properties
curl --location -g --request GET 'https://api.notif.immo/documents/properties?includedDepartments[]=departments/77&fromDate=2020-01-10&propertyTypes[]=1&transactionType=0&withCoherentPrice=true&budgetMin=1800000&budgetMax=1900000' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api_key>'

{
  "hydra:member": [
    {
      "@context": "/contexts/PropertyDocument",
      "@id": "/documents/properties/a2fe8869-bbd8-4d92-ad22-5ca5511a5bc7",
      "@type": "PropertyDocument",
      "adverts": [
        {
          "condominiumFees": 1200,
          "constructionYear": 1982,
          "contact": {
            "agency": "Agence Immo 2000",
            "email": "contact@agenceimmo2000.fr",
            "fax": "0120304050",
            "name": "Olivie Olivier",
            "phone": "0120304050",
            "reference": "B42042"
          },
          "createdAt": "2023-05-23T23:48:47+02:00",
          "description": "Bel appartement « coup de coeur » 2 pieces Sans perte d’espace, lumineux, poutres, parquet massif, belle hauteur sous plafonds, entièrement refait à neuf avec fenêtres double vitrage, volets roulants, porte blindée, cuisine entièrement équipée, salle d’eau avec fenêtre, idéalement situé...",
          "elevator": true,
          "energy": {
            "category": "C",
            "value": 117
          },
          "events": [
            {
              "createdAt": "2023-05-23T23:48:47+02:00",
              "fieldName": "price",
              "fieldNewValue": "950",
              "fieldOldValue": "995",
              "percentVariation": -4.52
            }
          ],
          "features": [
            "Grand balcon",
            "Bâtiment de 5 étages",
            "Lumineux",
            "Coin cuisine"
          ],
          "feesPercentage": 10,
          "feesResponsibility": 0,
          "floor": 6,
          "floorQuantity": 6,
          "furnished": true,
          "greenHouseGas": {
            "category": "D",
            "value": 32
          },
          "inventoryPrice": 350,
          "landSurface": 300,
          "lastCrawledAt": "2023-05-23T23:48:47+02:00",
          "lotCount": 12,
          "pictures": [
            "https://pictures.notif.immo/properties/2021/05/10/10/a20cbdc44632c63f89aad2e6d9d049.jpg",
            "https://pictures.notif.immo/properties/2021/05/10/10/b0935cb714d501c668b66997d7f16a.jpg",
            "https://pictures.notif.immo/properties/2021/05/10/10/7e1ea590d4b827e9a8a762e7f378fb.jpg"
          ],
          "picturesRemote": [
            "https://www.century21.fr/imagesBien/s3/202/3427/c21_202_3427_1185_1_45D57CD0-7D18-4FA0-B463-060789202625.jpg",
            "https://www.century21.fr/imagesBien/s3/202/3427/c21_202_3427_1185_1_39192DB9-A503-4FD7-AEDB-3DEFFE35E42E.jpg",
            "https://www.century21.fr/imagesBien/s3/202/3427/c21_202_3427_1185_1_FDDEC9E3-8A85-4BE5-83B8-12005A2D4078.jpg"
          ],
          "price": 950,
          "priceExcludingFees": 1800000,
          "publisher": {
            "category": "Portails",
            "name": "Century21",
            "type": 1
          },
          "rentalCharges": 75,
          "rentalPledge": 1000,
          "renterFees": 60,
          "surface": 30,
          "title": "Appartement 2 pieces",
          "updatedAt": "2023-05-23T23:48:47+02:00",
          "url": "https://www.century21.fr/trouver_logement/detail/2424196788/",
          "uuid": "21f2a17b-dae3-4ea4-976f-e521cebfe609",
          "virtualTour": "https://my.matterport.com/show/?m=9GnMTmZgY44"
        }
      ],
      "bedroom": 2,
      "city": {
        "cityParentId": 0,
        "country": {
          "code": "250",
          "id": 2,
          "name": "France"
        },
        "department": {
          "code": "75",
          "id": 77,
          "name": "Paris"
        },
        "groupedCityNames": [
          "string"
        ],
        "groupedCityZipcodes": [
          "string"
        ],
        "hasGroupedByName": false,
        "hasGroupedByZipcode": false,
        "id": 30950,
        "insee": "75116",
        "locations": {
          "lat": 48.8530933,
          "lon": 2.2487626
        },
        "name": "Paris 18e",
        "open": true,
        "originalName": "Paris 18e",
        "region": {
          "code": "11",
          "id": 7,
          "name": "Île-de-France"
        },
        "zipcode": "75018"
      },
      "createdAt": "2023-05-23T23:48:47+02:00",
      "description": "Bel appartement « coup de coeur » 2 pieces Sans perte d’espace, lumineux, poutres, parquet massif, belle hauteur sous plafonds, entièrement refait à neuf avec fenêtres double vitrage, volets roulants, porte blindée, cuisine entièrement équipée, salle d’eau avec fenêtre, idéalement situé...",
      "elevator": true,
      "expired": true,
      "expiredAt": "2023-05-23T23:48:47+02:00",
      "floor": 6,
      "furnished": true,
      "landSurface": 300,
      "lastCrawledAdvert": "21f2a17b-dae3-4ea4-976f-e521cebfe609",
      "lastCrawledAt": "2023-05-23T23:48:47+02:00",
      "locations": {
        "lat": 48.8530933,
        "lon": 2.2487626
      },
      "pictures": [
        "https://pictures.notif.immo/properties/2021/05/10/10/a20cbdc44632c63f89aad2e6d9d049.jpg",
        "https://pictures.notif.immo/properties/2021/05/10/10/b0935cb714d501c668b66997d7f16a.jpg",
        "https://pictures.notif.immo/properties/2021/05/10/10/7e1ea590d4b827e9a8a762e7f378fb.jpg"
      ],
      "price": 950,
      "pricePerMeter": 31.66,
      "property": "/properties/a2fe8869-bbd8-4d92-ad22-5ca5511a5bc7",
      "propertyType": 0,
      "publisherTypes": [
        1
      ],
      "room": 3,
      "stations": [
        {
          "id": 33,
          "lines": [
            {
              "color": "#128B5B",
              "id": 20,
              "name": "Ligne 12",
              "number": "12",
              "routeName": "Front Populaire ↔ Mairie d’Issy"
            }
          ],
          "name": "Jules Joffrin"
        },
        {
          "id": 191,
          "lines": [
            {
              "color": "#B94D9A",
              "id": 11,
              "name": "Ligne 4",
              "number": "4",
              "routeName": "Porte de Clignancourt ↔ Mairie de Montrouge"
            },
            {
              "color": "#128B5B",
              "id": 20,
              "name": "Ligne 12",
              "number": "12",
              "routeName": "Front Populaire ↔ Mairie d’Issy"
            }
          ],
          "name": "Marcadet-Poissonniers"
        }
      ],
      "surface": 30,
      "title": "Appartement 2 pieces",
      "transactionType": 1,
      "updatedAt": "2023-05-23T23:48:47+02:00",
      "uuid": "38cb65b9-2965-4bd0-bc9b-2b8a8be7c457"
    }
  ],
  "hydra:totalItems": 0,
  "hydra:view": {
    "@id": "string",
    "@type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "string",
    "hydra:template": "string",
    "hydra:variableRepresentation": "string",
    "hydra:mapping": [
      {
        "@type": "string",
        "variable": "string",
        "property": "string",
        "required": true
      }
    ]
  }
}

​
Query parameters

​
bedroomMax
number
Maximum number of bedrooms in the property.
​
bedroomMin
number
Minimum number of bedrooms in the property.
​
budgetMax
number
Maximum budget for the property.
​
budgetMin
number
Minimum budget for the property.
​
condominiumFeesMax
number
Maximum condominium fees for the property.
​
condominiumFeesMin
number
Minimum condominium fees for the property.
​
constructionYearMax
number
Maximum construction year of the property.
​
constructionYearMin
number
Minimum construction year of the property.
​
energyCategories
array
The energy efficiency categories of the property.
​
energyValueMax
number
Maximum energy value of the property.
​
energyValueMin
number
Minimum energy value of the property.
​
eventPriceVariationFromCreatedAt
date
Date from which an event of type price is created — inclusive.
​
eventPriceVariationMax
number
Maximum percent variation of an event of type price.
​
eventPriceVariationMin
number
Minimum percent variation of an event of type price.
​
eventPriceVariationToCreatedAt
date
Date before which an event of type price is created — inclusive.
​
eventSurfaceVariationFromCreatedAt
date
Date from which an event of type surface is created — inclusive.
​
eventSurfaceVariationMax
number
Maximum percent variation of an event of type surface.
​
eventSurfaceVariationMin
number
Minimum percent variation of an event of type surface.
​
eventSurfaceVariationToCreatedAt
date
Date before which an event of type surface is created — inclusive.
​
excludedCities
array
Cities to be excluded.
​
excludedInseeCodes
array
Insee codes to be excluded.
​
excludedProperties
array
Properties to be excluded.
​
excludedSites
array
Sources sites to be excluded.
​
excludedZipcodes
array
Zipcodes to be excluded.
​
expired
boolean
default:"null"
Whether to show properties that are expired. A property is considered expired when all its adverts are expired. Can be true, false or null. Default is null which returns all properties no matter if they’re expired or not.
​
expressions
array
Full text matching including/excluding words & phrases in the title or the description of the property. Example: expressions[0][0][word]=travaux&expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=false&expressions[0][1][word]=lumineux&expressions[0][1][options][includes]=true&expressions[0][1][options][strict]=false which will search for properties that contain both the keywords lumineux and travaux.
​
feesPercentageMax
number
Maximum percentage of fees.
​
feesPercentageMin
number
Minimum percentage of fees.
​
feesResponsibility
number
Responsibility for fees. 0 for seller, 1 for buyer.
​
floorQuantityMax
number
Maximum number of floors in the property.
​
floorQuantityMin
number
Minimum number of floors in the property.
​
fromDate
date
Date from which the property is created — inclusive.
​
fromExpiredAt
date
Date from which the advert is expired — inclusive.
​
fromUpdatedAt
date
Date from which the property is updated — inclusive.
​
furnished
boolean
Filter for furnished properties.
​
geoAccuracy
number
Filters properties by geographic accuracy level. “1” (HOUSE NUMBER - precise location at house number level), “2” (NEIGHBORHOOD - broader location within a neighborhood).
​
geoShapes
array
Filters properties within specified geographic areas. Example: geoShapes=geoShapes[0][0][0]=6.063201&geoShapes[0][0][1]=44.549092&geoShapes[0][1][0]=6.063201&geoShapes[0][1][1]=44.543009&geoShapes[0][2][0]=6.073453&geoShapes[0][2][1]=44.543293&geoShapes[0][3][0]=6.073453&geoShapes[0][3][1]=44.549092&geoShapes[0][4][0]=6.063201&geoShapes[0][4][1]=44.549092.
​
greenHouseGasCategories
array
Green house gas performance letter array of the property.
​
greenHouseGasValueMax
number
Maximum value of green house gas of the property.
​
greenHouseGasValueMin
number
Minimum value of green house gas of the property.
​
includedCities
array
Located in given cities. Example: includedCities[]=/cities/30953&includedCities[]=/cities/30952. Use locations to get the desired city ids.
​
includedDepartments
array
Located in given departments. Example: includedDepartments[]=/departments/77. Use locations to get the desired department ids.
​
includedInseeCodes
array
Located in given insee codes. Example: includedInseeCodes[]=75117&includedInseeCodes[]=75118
​
includedSites
array
Sources sites to be included.
​
includedZipcodes
array
Located in given zipcodes. Example: includedZipcodes[]=75017&includedZipcodes[]=75018
​
inventoryPriceMax
number
Lower than or equal to given inventory price. Example: inventoryPriceMax=500
​
inventoryPriceMin
number
Greater than or equal to given inventory price. Example: inventoryPriceMin=250
​
itemsPerPage
number
default:"10"
The number of items per page. Max is 30.
​
landSurfaceMax
number
Maximum land surface.
​
landSurfaceMin
number
Minimum land surface.
​
lat
number
Latitude. Will work if latitude exists in the property. Example: lat=48.864716
​
lon
number
Longitude. Will work if latitude exists in the property. Example: lon=2.349014
​
lotCountMax
number
Lower than or equal to given lot count. Example: lotCountMax=12
​
lotCountMin
number
Greater than or equal to given lot count. Example: lotCountMin=4
​
order[createdAt]
string
default:"desc"
Order properties by creation date. Can be asc or desc.
​
order[pricePerMeter]
string
default:"desc"
Order properties by price per meter. Can be asc or desc.
​
order[price]
string
Order properties by price. Can be asc or desc.
​
order[surface]
string
Order properties by surface. Can be asc or desc.
​
order[updatedAt]
string
Order properties by update date. Can be asc or desc.
​
page
integer
default:"1"
The collection page number.
​
priceExcludingFeesMax
number
Lower than or equal to given price excluding fees. Example: priceExcludingFeesMax=427500
​
priceExcludingFeesMin
number
Greater than or equal to given price excluding fees. Example: priceExcludingFeesMin=405000
​
pricePerMeterMax
number
Lower than or equal to given price per meter. Example: pricePerMeterMax=11500
​
pricePerMeterMin
number
Greater than or equal to given price per meter. Example: pricePerMeterMin=9500
​
propertyTypes
array
Type of property. Apartment 0, House 1, Building 2, Parking 3, Office 4, Land 5, Shop 6. Example: propertyTypes[]=0&propertyTypes[]=1
​
publisherTypes
array
Type of publisher. Individual 0, Professional 1. Example: publisherTypes[]=0&publisherTypes[]=1
​
radius
integer
Distance expressed in kilometers. Will work if latitude & longitude parameters are also set. Example: radius=20
​
rentalChargesMax
number
Lower than or equal to given rental charges amount. Example: rentalChargesMax=100
​
rentalChargesMin
number
Greater than or equal to given rental charges amount. Example: rentalChargesMin=50
​
rentalPledgeMax
number
Lower than or equal to given rental pledge amount. Example: rentalPledgeMax=800
​
rentalPledgeMin
number
Greater than or equal to given rental pledge amount. Example: rentalPledgeMin=500
​
renterFeesMax
number
Lower than or equal to given renter fees. Example: renterFeesMax=80
​
renterFeesMin
number
Greater than or equal to given renter fees. Example: renterFeesMin=50
​
roomMax
number
Maximum rooms of the property. Example: roomMax=6
​
roomMin
number
Minimum rooms of the property. Example: roomMin=3
​
sortMode
string
default:"property"
Whether to sort results by properties or by adverts.If property is chosen, fromDate and toDate parameters will be overridden so that the results will be sorted by the createdAt of each property.If advert is chosen: fromDate and toDate parameters will be overridden so that the results will be sorted by createdAt of each advert.Example: sortMode=propertyPlease check our glossary for more information about the distinction between adverts and properties.
​
surfaceMax
number
Lower than or equal to given surface. Example: surfaceMax=84
​
surfaceMin
number
Greater than or equal to given surface. Example: surfaceMin=42
​
toDate
date
Date until which the property is created — inclusive. Example: toDate=2021-05-07 12:42:42
​
toExpiredAt
date
Date from which the advert is expired — inclusive. Example: toExpiredAt=2021-05-07 12:42:42
​
toUpdatedAt
date
Date until which the property is updated — inclusive. Example: toUpdatedAt=2021-05-07 12:42:42
​
transactionType
integer
Type of transaction. Sell 0, Rent 1. Example: transactionType=0
​
withCoherentPrice
boolean
default:"true"
Filter properties with coherent price. Example: withCoherentPrice=true
​
withLocation
boolean
Having a latitude and longitude. Example: withLocation=true
​
withVirtualTour
boolean
Having a virtual tour video link. Example: withVirtualTour=true
curl --location -g --request GET 'https://api.notif.immo/documents/properties?includedDepartments[]=departments/77&fromDate=2020-01-10&propertyTypes[]=1&transactionType=0&withCoherentPrice=true&budgetMin=1800000&budgetMax=1900000' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api_key>'

{
  "hydra:member": [
    {
      "@context": "/contexts/PropertyDocument",
      "@id": "/documents/properties/a2fe8869-bbd8-4d92-ad22-5ca5511a5bc7",
      "@type": "PropertyDocument",
      "adverts": [
        {
          "condominiumFees": 1200,
          "constructionYear": 1982,
          "contact": {
            "agency": "Agence Immo 2000",
            "email": "contact@agenceimmo2000.fr",
            "fax": "0120304050",
            "name": "Olivie Olivier",
            "phone": "0120304050",
            "reference": "B42042"
          },
          "createdAt": "2023-05-23T23:48:47+02:00",
          "description": "Bel appartement « coup de coeur » 2 pieces Sans perte d’espace, lumineux, poutres, parquet massif, belle hauteur sous plafonds, entièrement refait à neuf avec fenêtres double vitrage, volets roulants, porte blindée, cuisine entièrement équipée, salle d’eau avec fenêtre, idéalement situé...",
          "elevator": true,
          "energy": {
            "category": "C",
            "value": 117
          },
          "events": [
            {
              "createdAt": "2023-05-23T23:48:47+02:00",
              "fieldName": "price",
              "fieldNewValue": "950",
              "fieldOldValue": "995",
              "percentVariation": -4.52
            }
          ],
          "features": [
            "Grand balcon",
            "Bâtiment de 5 étages",
            "Lumineux",
            "Coin cuisine"
          ],
          "feesPercentage": 10,
          "feesResponsibility": 0,
          "floor": 6,
          "floorQuantity": 6,
          "furnished": true,
          "greenHouseGas": {
            "category": "D",
            "value": 32
          },
          "inventoryPrice": 350,
          "landSurface": 300,
          "lastCrawledAt": "2023-05-23T23:48:47+02:00",
          "lotCount": 12,
          "pictures": [
            "https://pictures.notif.immo/properties/2021/05/10/10/a20cbdc44632c63f89aad2e6d9d049.jpg",
            "https://pictures.notif.immo/properties/2021/05/10/10/b0935cb714d501c668b66997d7f16a.jpg",
            "https://pictures.notif.immo/properties/2021/05/10/10/7e1ea590d4b827e9a8a762e7f378fb.jpg"
          ],
          "picturesRemote": [
            "https://www.century21.fr/imagesBien/s3/202/3427/c21_202_3427_1185_1_45D57CD0-7D18-4FA0-B463-060789202625.jpg",
            "https://www.century21.fr/imagesBien/s3/202/3427/c21_202_3427_1185_1_39192DB9-A503-4FD7-AEDB-3DEFFE35E42E.jpg",
            "https://www.century21.fr/imagesBien/s3/202/3427/c21_202_3427_1185_1_FDDEC9E3-8A85-4BE5-83B8-12005A2D4078.jpg"
          ],
          "price": 950,
          "priceExcludingFees": 1800000,
          "publisher": {
            "category": "Portails",
            "name": "Century21",
            "type": 1
          },
          "rentalCharges": 75,
          "rentalPledge": 1000,
          "renterFees": 60,
          "surface": 30,
          "title": "Appartement 2 pieces",
          "updatedAt": "2023-05-23T23:48:47+02:00",
          "url": "https://www.century21.fr/trouver_logement/detail/2424196788/",
          "uuid": "21f2a17b-dae3-4ea4-976f-e521cebfe609",
          "virtualTour": "https://my.matterport.com/show/?m=9GnMTmZgY44"
        }
      ],
      "bedroom": 2,
      "city": {
        "cityParentId": 0,
        "country": {
          "code": "250",
          "id": 2,
          "name": "France"
        },
        "department": {
          "code": "75",
          "id": 77,
          "name": "Paris"
        },
        "groupedCityNames": [
          "string"
        ],
        "groupedCityZipcodes": [
          "string"
        ],
        "hasGroupedByName": false,
        "hasGroupedByZipcode": false,
        "id": 30950,
        "insee": "75116",
        "locations": {
          "lat": 48.8530933,
          "lon": 2.2487626
        },
        "name": "Paris 18e",
        "open": true,
        "originalName": "Paris 18e",
        "region": {
          "code": "11",
          "id": 7,
          "name": "Île-de-France"
        },
        "zipcode": "75018"
      },
      "createdAt": "2023-05-23T23:48:47+02:00",
      "description": "Bel appartement « coup de coeur » 2 pieces Sans perte d’espace, lumineux, poutres, parquet massif, belle hauteur sous plafonds, entièrement refait à neuf avec fenêtres double vitrage, volets roulants, porte blindée, cuisine entièrement équipée, salle d’eau avec fenêtre, idéalement situé...",
      "elevator": true,
      "expired": true,
      "expiredAt": "2023-05-23T23:48:47+02:00",
      "floor": 6,
      "furnished": true,
      "landSurface": 300,
      "lastCrawledAdvert": "21f2a17b-dae3-4ea4-976f-e521cebfe609",
      "lastCrawledAt": "2023-05-23T23:48:47+02:00",
      "locations": {
        "lat": 48.8530933,
        "lon": 2.2487626
      },
      "pictures": [
        "https://pictures.notif.immo/properties/2021/05/10/10/a20cbdc44632c63f89aad2e6d9d049.jpg",
        "https://pictures.notif.immo/properties/2021/05/10/10/b0935cb714d501c668b66997d7f16a.jpg",
        "https://pictures.notif.immo/properties/2021/05/10/10/7e1ea590d4b827e9a8a762e7f378fb.jpg"
      ],
      "price": 950,
      "pricePerMeter": 31.66,
      "property": "/properties/a2fe8869-bbd8-4d92-ad22-5ca5511a5bc7",
      "propertyType": 0,
      "publisherTypes": [
        1
      ],
      "room": 3,
      "stations": [
        {
          "id": 33,
          "lines": [
            {
              "color": "#128B5B",
              "id": 20,
              "name": "Ligne 12",
              "number": "12",
              "routeName": "Front Populaire ↔ Mairie d’Issy"
            }
          ],
          "name": "Jules Joffrin"
        },
        {
          "id": 191,
          "lines": [
            {
              "color": "#B94D9A",
              "id": 11,
              "name": "Ligne 4",
              "number": "4",
              "routeName": "Porte de Clignancourt ↔ Mairie de Montrouge"
            },
            {
              "color": "#128B5B",
              "id": 20,
              "name": "Ligne 12",
              "number": "12",
              "routeName": "Front Populaire ↔ Mairie d’Issy"
            }
          ],
          "name": "Marcadet-Poissonniers"
        }
      ],
      "surface": 30,
      "title": "Appartement 2 pieces",
      "transactionType": 1,
      "updatedAt": "2023-05-23T23:48:47+02:00",
      "uuid": "38cb65b9-2965-4bd0-bc9b-2b8a8be7c457"
    }
  ],
  "hydra:totalItems": 0,
  "hydra:view": {
    "@id": "string",
    "@type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "string",
    "hydra:template": "string",
    "hydra:variableRepresentation": "string",
    "hydra:mapping": [
      {
        "@type": "string",
        "variable": "string",
        "property": "string",
        "required": true
      }
    ]
  }
}