Documentation

Book a call

Contact us

Real-estate data API - Fluximmo V2 (2.1.0)

Search and alerts

Analytics

My Account

Count - Count the number of properties matching the given query.

Matches geopoint values within a given distance of a geopoint (pin).

GeoDistance

Shape which has already been stored inside fluximmo services. This is particularly useful for when you have a pre-defined list of shapes and you want to reference the list using a logical name (for example Ile-de-France) rather than having to provide coordinates each time.

PreregisteredShape

Use a geo_bounding_box filter to match geo_point values that intersect a bounding box. To define the box, provide geopoint values for two opposite corners.

GeoBoundingBox

The latitude in degrees. It must be in the range [-90.0, +90.0].

The longitude in degrees. It must be in the range [-180.0, +180.0].

- SURFACE_IS_NONE: DEPRECATED ANOMALIES WILL NOT APPEARS AFTER JANUARY 2024

Filter documents indexed using. The behaviour of the GeoShape query depends on the type and relation defined. This have the same specs as the GeoJson RFC 7946 (read more here: https://geojson.org/)

GeoShape

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

H3Index

Property and ad info

`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: README.md _snippets api-analytics-reference api-city-reference api-dvf-reference api-experimental-reference api-geography-reference api-v2-reference authentification.mdx doc essentials favicon.png gen_swagger_analytics.sh gen_swagger_api_v2.sh gen_swagger_city.sh gen_swagger_dvf.sh gen_swagger_geography.sh gen_swagger_maps.sh images introduction.mdx logs.txt mint.json swagger-analytics.json swagger-api-v2.json swagger-city.json swagger-dvf.json swagger-geography.json swagger-maps.json If no scheme is provided, `https` is assumed. README.md _snippets api-analytics-reference api-city-reference api-dvf-reference api-experimental-reference api-geography-reference api-v2-reference authentification.mdx doc essentials favicon.png gen_swagger_analytics.sh gen_swagger_api_v2.sh gen_swagger_city.sh gen_swagger_dvf.sh gen_swagger_geography.sh gen_swagger_maps.sh images introduction.mdx logs.txt mint.json swagger-analytics.json swagger-api-v2.json swagger-city.json swagger-dvf.json swagger-geography.json swagger-maps.json An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. README.md _snippets api-analytics-reference api-city-reference api-dvf-reference api-experimental-reference api-geography-reference api-v2-reference authentification.mdx doc essentials favicon.png gen_swagger_analytics.sh gen_swagger_api_v2.sh gen_swagger_city.sh gen_swagger_dvf.sh gen_swagger_geography.sh gen_swagger_maps.sh images introduction.mdx logs.txt mint.json swagger-analytics.json swagger-api-v2.json swagger-city.json swagger-dvf.json swagger-geography.json swagger-maps.json Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

ApiKeyAuth

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

Real estate data to power workflows, business applications and decision-making

Introduction

To get started using the Fluximmo API, you'll need to get an API-KEY

Authentification

Real-estate market can be conceptualized in different ways. We offer two different conceptualization depending on your needs: Properties & Adverts.

Properties & Adverts

Webhooks are a lightweight solution for delivering real-time notifications and data updates, eliminating the need for a comprehensive API.

Webhooks

Our BaaS philosophy centers on furnishing you with a complete suite of tools and APIs designed to fulfill your unique requirements solely through our services.

BaaS Engines

GeneralAnalytics - Retrieve advanced statistics of historical immo's market.

GetLivePricesStatistics - Obtain city's live prices statistics.

GetMarketPrice - Obtain city's market prices.

Non exhaustive list of real-estate ad platforms - New platform can be added on specific request


Get the list of real-estate platforms

Get your credit consumption for a given date range

Get your credit consumption

Estimate the price of a property based on market data

Estimate the price of a property

Get a sample of properties

Sample of an alert webhook body for Properties

Sample Properties webhook body

Get a property by it's flx_id (flx_id is the id of the property in the database)

Get a property by it's flx_id

Get a list of properties by their flx_id (flx_id is the id of the property in the database)

Retreive properties by their flx_ids

Retrieve a property by one of it's advert flxId

Retrieve a property by advert flxId

Retrieve a property by one of it's advert URL

Retrieve a property by url

Search properties with filters and fulltexts search terms

Search properties

RaisePropertyIssue - Raise an issue for a given property

Create a new alert on a Property search. The alert will be saved in the database and will be triggered when a new property is found.

Create a new alert for this Property search

Get the search criteria of a Property alert by its id (alertId)

Get the search criteria of a Propertyalert

Deactivate a Property search alert by its id (alertId)

Deactivate a Property search alert

Update the search criteria of a Property alert by its id (alertId) and return the new alertId

Update the search criteria of a Property alert

Get the search criteria of all your Property alerts

Get all your Property alerts

Activate a Property search alert by its id (alertId)

Activate a Property search alert

Get history of the properties matched to a saved search by its flxId. The history is composed of all the properties that have been match for this saved search.

Get history of match properties by its saved search flxId

Get a sample of ads

Sample of an alert webhook body for Adverts

Sample advert webhook body

RaiseADIssue - Raise an issue for a given ad

Get adverts by their flx_id (flx_id is the id of the adverts in the database)

Get adverts byt their flx_id

Retrieve advert by url

Create a new alert on a Advert search. The alert will be saved in the database and will be triggered when a new Advert is found.

Create a new Advert alert for this search

Get the search criteria of an Advert alert by its id (alertId)

Get the search criteria of an Advert alert

Deactivate a search Advert alert by its id (alertId)

Deactivate a search Advert alert

Update the search criteria of an Advert alert by its id (alertId) and return the new alertId

Properties

Market Stat

Count - Count the number of properties matching the given query.

Authorizations

Body

Response