Skip to main content
Properties General Analytics for search filters
curl --request POST \
  --url https://api.fluximmo.io/v2/protected/analytics/property/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": {
    "filterProperty": {
      "land": {
        "surface": {
          "max": 123,
          "min": 123
        }
      },
      "location": [],
      "meta": {
        "firstSeenAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        },
        "isTotallyOffline": true,
        "lastPublishedAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        },
        "lastSeenAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        },
        "lastUpdatedAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        }
      },
      "price": {
        "latest": {
          "value": {
            "max": 123,
            "min": 123
          },
          "valuePerArea": {
            "max": 123,
            "min": 123
          }
        }
      },
      "type": [
        "CLASS_HOUSE"
      ],
      "offer": [],
      "habitation": {
        "bedroomCount": {
          "max": 123,
          "min": 123
        },
        "roomCount": {
          "max": 123,
          "min": 123
        },
        "characteristics": {
          "hasBalcony": true,
          "hasCellar": true,
          "hasGarage": true,
          "hasLift": true,
          "hasParking": true,
          "hasPool": true,
          "hasTerrace": true
        },
        "climate": {
          "epcClimate": [],
          "epcEnergy": []
        },
        "surface": {
          "total": {
            "max": 123,
            "min": 123
          }
        },
        "features": {
          "furniture": [],
          "propertyFloor": {
            "max": 123,
            "min": 123
          },
          "propertyTotalFloor": {
            "max": 123,
            "min": 123
          }
        },
        "propertyCondition": [
          {
            "constructionYear": 123,
            "generalConditions": []
          }
        ]
      }
    },
    "fullTexts": [
      "<string>"
    ],
    "keywords": [
      "<string>"
    ]
  },
  "studiedData": "PRICE_PER_AREA_ANALYZED_TYPE",
  "type": "SUMMARY_ANALYSIS_TYPE"
}
'
import requests

url = "https://api.fluximmo.io/v2/protected/analytics/property/search"

payload = {
    "query": {
        "filterProperty": {
            "land": { "surface": {
                    "max": 123,
                    "min": 123
                } },
            "location": [],
            "meta": {
                "firstSeenAt": {
                    "max": "2022-10-21T11:31:33.593Z",
                    "min": "2022-10-21T11:31:33.593Z"
                },
                "isTotallyOffline": True,
                "lastPublishedAt": {
                    "max": "2022-10-21T11:31:33.593Z",
                    "min": "2022-10-21T11:31:33.593Z"
                },
                "lastSeenAt": {
                    "max": "2022-10-21T11:31:33.593Z",
                    "min": "2022-10-21T11:31:33.593Z"
                },
                "lastUpdatedAt": {
                    "max": "2022-10-21T11:31:33.593Z",
                    "min": "2022-10-21T11:31:33.593Z"
                }
            },
            "price": { "latest": {
                    "value": {
                        "max": 123,
                        "min": 123
                    },
                    "valuePerArea": {
                        "max": 123,
                        "min": 123
                    }
                } },
            "type": ["CLASS_HOUSE"],
            "offer": [],
            "habitation": {
                "bedroomCount": {
                    "max": 123,
                    "min": 123
                },
                "roomCount": {
                    "max": 123,
                    "min": 123
                },
                "characteristics": {
                    "hasBalcony": True,
                    "hasCellar": True,
                    "hasGarage": True,
                    "hasLift": True,
                    "hasParking": True,
                    "hasPool": True,
                    "hasTerrace": True
                },
                "climate": {
                    "epcClimate": [],
                    "epcEnergy": []
                },
                "surface": { "total": {
                        "max": 123,
                        "min": 123
                    } },
                "features": {
                    "furniture": [],
                    "propertyFloor": {
                        "max": 123,
                        "min": 123
                    },
                    "propertyTotalFloor": {
                        "max": 123,
                        "min": 123
                    }
                },
                "propertyCondition": [
                    {
                        "constructionYear": 123,
                        "generalConditions": []
                    }
                ]
            }
        },
        "fullTexts": ["<string>"],
        "keywords": ["<string>"]
    },
    "studiedData": "PRICE_PER_AREA_ANALYZED_TYPE",
    "type": "SUMMARY_ANALYSIS_TYPE"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: {
      filterProperty: {
        land: {surface: {max: 123, min: 123}},
        location: [],
        meta: {
          firstSeenAt: {max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'},
          isTotallyOffline: true,
          lastPublishedAt: {max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'},
          lastSeenAt: {max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'},
          lastUpdatedAt: {max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'}
        },
        price: {latest: {value: {max: 123, min: 123}, valuePerArea: {max: 123, min: 123}}},
        type: ['CLASS_HOUSE'],
        offer: [],
        habitation: {
          bedroomCount: {max: 123, min: 123},
          roomCount: {max: 123, min: 123},
          characteristics: {
            hasBalcony: true,
            hasCellar: true,
            hasGarage: true,
            hasLift: true,
            hasParking: true,
            hasPool: true,
            hasTerrace: true
          },
          climate: {epcClimate: [], epcEnergy: []},
          surface: {total: {max: 123, min: 123}},
          features: {
            furniture: [],
            propertyFloor: {max: 123, min: 123},
            propertyTotalFloor: {max: 123, min: 123}
          },
          propertyCondition: [{constructionYear: 123, generalConditions: []}]
        }
      },
      fullTexts: ['<string>'],
      keywords: ['<string>']
    },
    studiedData: 'PRICE_PER_AREA_ANALYZED_TYPE',
    type: 'SUMMARY_ANALYSIS_TYPE'
  })
};

fetch('https://api.fluximmo.io/v2/protected/analytics/property/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluximmo.io/v2/protected/analytics/property/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => [
        'filterProperty' => [
                'land' => [
                                'surface' => [
                                                                'max' => 123,
                                                                'min' => 123
                                ]
                ],
                'location' => [
                                
                ],
                'meta' => [
                                'firstSeenAt' => [
                                                                'max' => '2022-10-21T11:31:33.593Z',
                                                                'min' => '2022-10-21T11:31:33.593Z'
                                ],
                                'isTotallyOffline' => true,
                                'lastPublishedAt' => [
                                                                'max' => '2022-10-21T11:31:33.593Z',
                                                                'min' => '2022-10-21T11:31:33.593Z'
                                ],
                                'lastSeenAt' => [
                                                                'max' => '2022-10-21T11:31:33.593Z',
                                                                'min' => '2022-10-21T11:31:33.593Z'
                                ],
                                'lastUpdatedAt' => [
                                                                'max' => '2022-10-21T11:31:33.593Z',
                                                                'min' => '2022-10-21T11:31:33.593Z'
                                ]
                ],
                'price' => [
                                'latest' => [
                                                                'value' => [
                                                                                                                                'max' => 123,
                                                                                                                                'min' => 123
                                                                ],
                                                                'valuePerArea' => [
                                                                                                                                'max' => 123,
                                                                                                                                'min' => 123
                                                                ]
                                ]
                ],
                'type' => [
                                'CLASS_HOUSE'
                ],
                'offer' => [
                                
                ],
                'habitation' => [
                                'bedroomCount' => [
                                                                'max' => 123,
                                                                'min' => 123
                                ],
                                'roomCount' => [
                                                                'max' => 123,
                                                                'min' => 123
                                ],
                                'characteristics' => [
                                                                'hasBalcony' => true,
                                                                'hasCellar' => true,
                                                                'hasGarage' => true,
                                                                'hasLift' => true,
                                                                'hasParking' => true,
                                                                'hasPool' => true,
                                                                'hasTerrace' => true
                                ],
                                'climate' => [
                                                                'epcClimate' => [
                                                                                                                                
                                                                ],
                                                                'epcEnergy' => [
                                                                                                                                
                                                                ]
                                ],
                                'surface' => [
                                                                'total' => [
                                                                                                                                'max' => 123,
                                                                                                                                'min' => 123
                                                                ]
                                ],
                                'features' => [
                                                                'furniture' => [
                                                                                                                                
                                                                ],
                                                                'propertyFloor' => [
                                                                                                                                'max' => 123,
                                                                                                                                'min' => 123
                                                                ],
                                                                'propertyTotalFloor' => [
                                                                                                                                'max' => 123,
                                                                                                                                'min' => 123
                                                                ]
                                ],
                                'propertyCondition' => [
                                                                [
                                                                                                                                'constructionYear' => 123,
                                                                                                                                'generalConditions' => [
                                                                                                                                                                                                                                                                
                                                                                                                                ]
                                                                ]
                                ]
                ]
        ],
        'fullTexts' => [
                '<string>'
        ],
        'keywords' => [
                '<string>'
        ]
    ],
    'studiedData' => 'PRICE_PER_AREA_ANALYZED_TYPE',
    'type' => 'SUMMARY_ANALYSIS_TYPE'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluximmo.io/v2/protected/analytics/property/search"

	payload := strings.NewReader("{\n  \"query\": {\n    \"filterProperty\": {\n      \"land\": {\n        \"surface\": {\n          \"max\": 123,\n          \"min\": 123\n        }\n      },\n      \"location\": [],\n      \"meta\": {\n        \"firstSeenAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        },\n        \"isTotallyOffline\": true,\n        \"lastPublishedAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        },\n        \"lastSeenAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        },\n        \"lastUpdatedAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        }\n      },\n      \"price\": {\n        \"latest\": {\n          \"value\": {\n            \"max\": 123,\n            \"min\": 123\n          },\n          \"valuePerArea\": {\n            \"max\": 123,\n            \"min\": 123\n          }\n        }\n      },\n      \"type\": [\n        \"CLASS_HOUSE\"\n      ],\n      \"offer\": [],\n      \"habitation\": {\n        \"bedroomCount\": {\n          \"max\": 123,\n          \"min\": 123\n        },\n        \"roomCount\": {\n          \"max\": 123,\n          \"min\": 123\n        },\n        \"characteristics\": {\n          \"hasBalcony\": true,\n          \"hasCellar\": true,\n          \"hasGarage\": true,\n          \"hasLift\": true,\n          \"hasParking\": true,\n          \"hasPool\": true,\n          \"hasTerrace\": true\n        },\n        \"climate\": {\n          \"epcClimate\": [],\n          \"epcEnergy\": []\n        },\n        \"surface\": {\n          \"total\": {\n            \"max\": 123,\n            \"min\": 123\n          }\n        },\n        \"features\": {\n          \"furniture\": [],\n          \"propertyFloor\": {\n            \"max\": 123,\n            \"min\": 123\n          },\n          \"propertyTotalFloor\": {\n            \"max\": 123,\n            \"min\": 123\n          }\n        },\n        \"propertyCondition\": [\n          {\n            \"constructionYear\": 123,\n            \"generalConditions\": []\n          }\n        ]\n      }\n    },\n    \"fullTexts\": [\n      \"<string>\"\n    ],\n    \"keywords\": [\n      \"<string>\"\n    ]\n  },\n  \"studiedData\": \"PRICE_PER_AREA_ANALYZED_TYPE\",\n  \"type\": \"SUMMARY_ANALYSIS_TYPE\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.fluximmo.io/v2/protected/analytics/property/search")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": {\n    \"filterProperty\": {\n      \"land\": {\n        \"surface\": {\n          \"max\": 123,\n          \"min\": 123\n        }\n      },\n      \"location\": [],\n      \"meta\": {\n        \"firstSeenAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        },\n        \"isTotallyOffline\": true,\n        \"lastPublishedAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        },\n        \"lastSeenAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        },\n        \"lastUpdatedAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        }\n      },\n      \"price\": {\n        \"latest\": {\n          \"value\": {\n            \"max\": 123,\n            \"min\": 123\n          },\n          \"valuePerArea\": {\n            \"max\": 123,\n            \"min\": 123\n          }\n        }\n      },\n      \"type\": [\n        \"CLASS_HOUSE\"\n      ],\n      \"offer\": [],\n      \"habitation\": {\n        \"bedroomCount\": {\n          \"max\": 123,\n          \"min\": 123\n        },\n        \"roomCount\": {\n          \"max\": 123,\n          \"min\": 123\n        },\n        \"characteristics\": {\n          \"hasBalcony\": true,\n          \"hasCellar\": true,\n          \"hasGarage\": true,\n          \"hasLift\": true,\n          \"hasParking\": true,\n          \"hasPool\": true,\n          \"hasTerrace\": true\n        },\n        \"climate\": {\n          \"epcClimate\": [],\n          \"epcEnergy\": []\n        },\n        \"surface\": {\n          \"total\": {\n            \"max\": 123,\n            \"min\": 123\n          }\n        },\n        \"features\": {\n          \"furniture\": [],\n          \"propertyFloor\": {\n            \"max\": 123,\n            \"min\": 123\n          },\n          \"propertyTotalFloor\": {\n            \"max\": 123,\n            \"min\": 123\n          }\n        },\n        \"propertyCondition\": [\n          {\n            \"constructionYear\": 123,\n            \"generalConditions\": []\n          }\n        ]\n      }\n    },\n    \"fullTexts\": [\n      \"<string>\"\n    ],\n    \"keywords\": [\n      \"<string>\"\n    ]\n  },\n  \"studiedData\": \"PRICE_PER_AREA_ANALYZED_TYPE\",\n  \"type\": \"SUMMARY_ANALYSIS_TYPE\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.fluximmo.io/v2/protected/analytics/property/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": {\n    \"filterProperty\": {\n      \"land\": {\n        \"surface\": {\n          \"max\": 123,\n          \"min\": 123\n        }\n      },\n      \"location\": [],\n      \"meta\": {\n        \"firstSeenAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        },\n        \"isTotallyOffline\": true,\n        \"lastPublishedAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        },\n        \"lastSeenAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        },\n        \"lastUpdatedAt\": {\n          \"max\": \"2022-10-21T11:31:33.593Z\",\n          \"min\": \"2022-10-21T11:31:33.593Z\"\n        }\n      },\n      \"price\": {\n        \"latest\": {\n          \"value\": {\n            \"max\": 123,\n            \"min\": 123\n          },\n          \"valuePerArea\": {\n            \"max\": 123,\n            \"min\": 123\n          }\n        }\n      },\n      \"type\": [\n        \"CLASS_HOUSE\"\n      ],\n      \"offer\": [],\n      \"habitation\": {\n        \"bedroomCount\": {\n          \"max\": 123,\n          \"min\": 123\n        },\n        \"roomCount\": {\n          \"max\": 123,\n          \"min\": 123\n        },\n        \"characteristics\": {\n          \"hasBalcony\": true,\n          \"hasCellar\": true,\n          \"hasGarage\": true,\n          \"hasLift\": true,\n          \"hasParking\": true,\n          \"hasPool\": true,\n          \"hasTerrace\": true\n        },\n        \"climate\": {\n          \"epcClimate\": [],\n          \"epcEnergy\": []\n        },\n        \"surface\": {\n          \"total\": {\n            \"max\": 123,\n            \"min\": 123\n          }\n        },\n        \"features\": {\n          \"furniture\": [],\n          \"propertyFloor\": {\n            \"max\": 123,\n            \"min\": 123\n          },\n          \"propertyTotalFloor\": {\n            \"max\": 123,\n            \"min\": 123\n          }\n        },\n        \"propertyCondition\": [\n          {\n            \"constructionYear\": 123,\n            \"generalConditions\": []\n          }\n        ]\n      }\n    },\n    \"fullTexts\": [\n      \"<string>\"\n    ],\n    \"keywords\": [\n      \"<string>\"\n    ]\n  },\n  \"studiedData\": \"PRICE_PER_AREA_ANALYZED_TYPE\",\n  \"type\": \"SUMMARY_ANALYSIS_TYPE\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "percentilesValues": {
      "percentiles": {
        "1.0": 199.01825941147465,
        "25.0": 873.0233360295258,
        "5.0": 320.3792919192797,
        "50.0": 1749.9910946795994,
        "75.0": 3184.9963201136397,
        "95.0": 11208.899561561651,
        "99.0": 48335.94583529406
      }
    },
    "boxplotValue": {
      "lower": 123,
      "max": 123,
      "min": 123,
      "q1": 123,
      "q2": 123,
      "q3": 123,
      "upper": 123
    },
    "advancedKpiValue": {
      "avg": 123,
      "count": 123,
      "max": 123,
      "min": 123,
      "stdDeviation": 123,
      "stdDeviationBounds": {
        "lower": 123,
        "lowerPopulation": 123,
        "lowerSampling": 123,
        "upper": 123,
        "upperPopulation": 123,
        "upperSampling": 123
      },
      "stdDeviationPopulation": 123,
      "stdDeviationSampling": 123,
      "sum": 123,
      "sumOfSquares": 123,
      "variance": 123,
      "variancePopulation": 123,
      "varianceSampling": 123
    },
    "summaryValue": {
      "avg": 123,
      "count": 123,
      "max": 123,
      "min": 123,
      "sum": 123
    },
    "countValue": 123
  }
}
{
  "error": {
    "message": "<string>",
    "code": 123
  }
}
{
  "error": {
    "message": "<string>",
    "code": 123
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
query
object
required
studiedData
enum<string>
required
Available options:
PRICE_ANALYZED_TYPE,
HABITATION_SURFACE_ANALYZED_TYPE,
LAND_SURFACE_ANALYZED_TYPE,
PRICE_PER_AREA_ANALYZED_TYPE
Example:

"PRICE_PER_AREA_ANALYZED_TYPE"

type
enum<string>
required
Available options:
SUMMARY_ANALYSIS_TYPE,
ADVANCED_ANALYSIS_TYPE,
BOX_PLOT_ANALYSIS_TYPE,
PERCENTILES_ANALYSIS_TYPE
Example:

"SUMMARY_ANALYSIS_TYPE"

Response

data
object

Analytics data for the given context