GET
/
indicators
/
price_per_meter
curl --location -g --request GET 'https://api.stream.estate/indicators/price_per_meter?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": [
    {
    "average": 7532.48,
    "average_min": 6250.75,
    "average_max": 8814.21,
    "median": 7601.50,
    "series": {
        "2023-01": 7450.60,
        "2023-02": 7520.00,
        "2023-03": 7605.30,
        "2023-04": 7680.40,
        "2023-05": 7750.50,
        "2023-06": 7820.60,
        "2023-07": 7890.70,
        "2023-08": 7960.80,
        "2023-09": 8030.90,
        "2023-10": 8101.00,
        "2023-11": 8171.10,
        "2023-12": 8241.20
    }
}
  ],
  "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

aggregationInterval
string
default:"month"
Date histogram granularity for time series. Can be month or year.
bedroomMax
integer
The maximum number of bedrooms in the property.
bedroomMin
integer
The minimum number of bedrooms in the property.
budgetMax
integer
The maximum budget for the property.
budgetMin
integer
The minimum budget for the property.
condominiumFeesMax
integer
The maximum condominium fees for the property.
condominiumFeesMin
integer
The minimum condominium fees for the property.
constructionYearMax
integer
The maximum construction year of the property.
constructionYearMin
integer
The minimum construction year of the property.
energyCategories
array
The energy efficiency categories of the property.
energyValueMax
integer
The maximum energy value of the property.
energyValueMin
integer
The minimum energy value of the property.
eventPriceVariationFromCreatedAt
date
The date from which an event of type price is created (inclusive).
eventPriceVariationMax
number
The maximum variation of an event of type price. Expressed in percent.
eventPriceVariationMin
number
The minimum variation of an event of type price. Expressed in percent.
eventPriceVariationToCreatedAt
date
The date before which an event of type price is created (inclusive).
eventSurfaceVariationFromCreatedAt
date
The date from which an event of type surface is created (inclusive).
eventSurfaceVariationMax
number
The maximum variation of an event of type surface. Expressed in percent.
eventSurfaceVariationMin
number
The minimum variation of an event of type surface. Expressed in percent.
eventSurfaceVariationToCreatedAt
date
The 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.
excludedZipcodes
array
Zipcodes to be excluded.
expired
boolean
Filter for expired properties.
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
The maximum percentage of fees.
feesPercentageMin
number
The minimum percentage of fees.
feesResponsibility
integer
Responsibility for fees (0 for seller, 1 for purchaser).
floorQuantityMax
integer
The maximum number of floors in the property.
floorQuantityMin
integer
The minimum number of floors in the property.
fromDate
date
The date from which the property is created (inclusive).
fromUpdatedAt
date
The date from which the property is updated (inclusive).
furnished
boolean
Filter for furnished properties.
greenHouseGasCategories
array
Green house gas performance letter array of the property.
greenHouseGasValueMax
integer
The maximum value of green house gas of the property.
greenHouseGasValueMin
integer
The minimum value of green house gas of the property.
includedCities
array
Located in given cities. Example: includedCities[]=/cities/30953&includedCities[]=/cities/30952
includedDepartments
array
Located in given departments. Example: includedDepartments[]=includedDepartments[]=/departments/77
includedInseeCodes
array
Located in given insee codes. Example: includedInseeCodes[]=75117&includedInseeCodes[]=75118
includedZipcodes
array
Located in given zipcodes. Example: includedZipcodes[]=75017&includedZipcodes[]=75018
inventoryPriceMax
number
Lower than or equal to inventoryPriceMax. Example: inventoryPriceMax=500
inventoryPriceMin
number
Greater than or equal to inventoryPriceMin. Example: inventoryPriceMin=250
itemsPerPage
integer
default:"30"
The number of items per page. Max is 30.
lat
number
Latitude. Used if radius & lat/lon are set. Example: lat=48.864716
lon
number
Longitude. Used if radius & lat/lon are given. Example: lon=2.349014
lotCountMax
integer
Lower than or equal to lotCountMax. Example: lotCountMax=12
lotCountMin
integer
Greater than or equal to lotCountMin. Example: lotCountMin=4
order[createdAt]
integer
default:"desc"
Order properties by creation date.
order[updatedAt]
integer
Order properties by update date.
page
integer
default:"1"
The collection page number.
priceExcludingFeesMax
number
Lower than or equal to priceExcludingFeesMax. Example: priceExcludingFeesMax=427500
priceExcludingFeesMin
number
Greater than or equal to priceExcludingFeesMin. Example: priceExcludingFeesMin=405000
pricePerMeterMax
integer
Lower than or equal to pricePerMeterMax. Example: pricePerMeterMax=11500
pricePerMeterMin
integer
Greater than or equal to pricePerMeterMin. Example: pricePerMeterMin=9500
propertyTypes
array
0: FLAT, 1: HOUSE, 2: BUILDING, 3: PARKING, 4: OFFICE, 5: LAND, 6: SHOP
publisherTypes
array
0 : INDIVIDUAL, 1 : PROFESSIONAL
radius
integer
Distance expressed in kilometers. Used if lat & lon are set. Example: radius=20
rentalChargesMax
number
Lower than or equal to rentalChargesMax. Example: rentalChargesMax=100
rentalChargesMin
number
Greater than or equal to rentalChargesMin. Example: rentalChargesMin=50
rentalPledgeMax
number
Lower than or equal to rentalPledgeMax. Example: rentalPledgeMax=800
rentalPledgeMin
number
Greater than or equal to rentalPledgeMin. Example: rentalPledgeMin=500
renterFeesMax
number
Lower than or equal to renterFeesMax. Example: renterFeesMax=80
renterFeesMin
number
Greater than or equal to renterFeesMin. Example: renterFeesMin=50
roomMax
integer
Having maximum x rooms. Example: roomMax=6
roomMin
integer
Having minimum x rooms. Example: roomMin=3
sortMode
string
default:"property"
Property: fromDate/toDate criteria will be applied to property root object. Items will be sorted by property createdAt dates. Advert: fromDate/toDate criteria will be applied to adverts nested objects. Items will be sorted by advert createdAt dates. Example: sortMode=property
surfaceMax
integer
Lower than or equal to surfaceMax. Example: surfaceMax=84
surfaceMin
integer
Greater than or equal to surfaceMin. Example: surfaceMin=42
toDate
date
To datetime (inclusive). Example: toDate=2021-05-07 12:42:42
toUpdatedAt
date
Since datetime (inclusive). Example: toUpdatedAt=2021-05-07 12:42:42
transactionType
integer
0 : SELL, 1 : RENT
withCoherentPrice
boolean
default:"true"
Filter properties with coherent price. Example: withCoherentPrice=true
withVirtualTour
boolean
Having a virtual tour video link. Example: withVirtualTour=true
curl --location -g --request GET 'https://api.stream.estate/indicators/price_per_meter?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": [
    {
    "average": 7532.48,
    "average_min": 6250.75,
    "average_max": 8814.21,
    "median": 7601.50,
    "series": {
        "2023-01": 7450.60,
        "2023-02": 7520.00,
        "2023-03": 7605.30,
        "2023-04": 7680.40,
        "2023-05": 7750.50,
        "2023-06": 7820.60,
        "2023-07": 7890.70,
        "2023-08": 7960.80,
        "2023-09": 8030.90,
        "2023-10": 8101.00,
        "2023-11": 8171.10,
        "2023-12": 8241.20
    }
}
  ],
  "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
      }
    ]
  }
}