GetPropertiesByIds - Retrieve a list of property based on their ids, useful to get content of a given property without using search. - Real-estate data API

POST

property

_many

curl --request POST \
  --url https://api.f6o.co/v2/property/_many \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "ids": [
    "<string>"
  ],
  "excludedFields": [
    "<string>"
  ],
  "includedFields": [
    "<string>"
  ]
}'

{
  "apiVersion": "<string>",
  "context": "<string>",
  "data": {},
  "internalDelay": 123
}

Authorizations

x-api-key

string

header

required

API Key used to be authentified to these APIs. Please contact Fluximmo to get one

Body

application/json

ids

string[]

excludedFields

string[]

includedFields

string[]

Response

200

application/json

A successful response.

apiVersion

string

context

string

data

object

data.{key}

object

data.{key}.property

object

data.{key}.property.firstKnownAdFlxId

string

data.{key}.property.flxId

string

data.{key}.property.indexTimestamp

string

data.{key}.property.firstKnownAdLegacyId

string

data.{key}.property.meta

object

data.{key}.property.title

string

data.{key}.property.description

string

data.{key}.property.tags

string[]

data.{key}.property.medias

object

data.{key}.property.isUrgent

boolean

data.{key}.property.offer

object

data.{key}.property.type

enum<string>

default:CLASS_UNKNOWN

Available options:

CLASS_UNKNOWN,

CLASS_HOUSE,

CLASS_FLAT,

CLASS_PROGRAM,

CLASS_SHOP,

CLASS_PREMISES,

CLASS_OFFICE,

CLASS_LAND,

CLASS_BUILDING,

CLASS_PARKING

data.{key}.property.process

enum<string>

default:PROCESS_UNKNOWN

Available options:

PROCESS_UNKNOWN,

PROCESS_AVAILABLE_ON_MARKET,

PROCESS_UNDER_COMPROMISE,

PROCESS_RENTED_SOLD,

PROCESS_REMOVED,

PROCESS_RESERVED,

PROCESS_ARCHIVED

data.{key}.property.price

object

data.{key}.property.habitation

object

data.{key}.property.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_INDIVIDUAL,

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,

PROPERTY_TYPE_STUDETTE

data.{key}.property.habitation.roomCount

integer

data.{key}.property.habitation.bedroomCount

integer

data.{key}.property.habitation.bathroomCount

integer

data.{key}.property.habitation.wcCount

integer

data.{key}.property.habitation.roomsDetails

object[]

data.{key}.property.habitation.heatTypes

enum<string>[]

Available options:

HEAT_TYPE_UNKNOWN,

HEAT_TYPE_INDIVIDUAL,

HEAT_TYPE_SHARED,

HEAT_TYPE_MIXED,

HEAT_TYPE_CITY,

HEAT_TYPE_CISTERN

data.{key}.property.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_RADIANTS_TUBES,

HEAT_DETAIL_RADIATOR,

HEAT_DETAIL_SHEATHS,

HEAT_DETAIL_CONVECTOR

data.{key}.property.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.{key}.property.habitation.kitchenEquipped

enum<string>

default:KITCHEN_UNKNOWN_EQUIPPED

Available options:

KITCHEN_UNKNOWN_EQUIPPED,

KITCHEN_NON_EQUIPPED,

KITCHEN_PARTIALLY_EQUIPPED,

KITCHEN_FULLY_EQUIPPED,

KITCHEN_FURNISHED,

KITCHEN_NAKED,

KITCHEN_EQUIPPED_FURNISHED

data.{key}.property.habitation.features

object

data.{key}.property.habitation.characteristics

object

data.{key}.property.habitation.climate

object

data.{key}.property.habitation.propertyCondition

object

data.{key}.property.habitation.surface

object

data.{key}.property.parking

object

data.{key}.property.land

object

data.{key}.property.location

object

data.{key}.property.history

object[]

data.{key}.property.adverts

object[]

data.{key}.property.isCityCenter

boolean

data.{key}.property.hasAnomaly

boolean

data.{key}.property.anomalies

enum<string>[]

Available options:

UNKNOWN_ANOMALY,

NO_EXACT_LOCATION_ANOMALY,

NO_PARKING_COUNT_ANOMALY,

NO_DESCRIPTION_ANOMALY,

NO_MEDIAS_ANOMALY,

NO_PICTURE_ANOMALY,

TOO_SHORT_DESCRIPTION_ANOMALY,

TOO_SHORT_TITLE_ANOMALY,

LOW_PRICE_ANOMALY,

HIGH_PRICE_ANOMALY,

INCOHERENT_LOCATION_ANOMALY,

INCOHERENT_LAND_VALUES_ANOMALY,

INCOHERENT_HABITATION_VALUES_ANOMALY,

TOO_SMALL_ROOM_ANOMALY,

SURFACE_IS_NONE,

ROOM_COUNT_IS_NONE,

BEDROOM_COUNT_IS_NONE,

PRICE_INCOHERENT,

TITLE_TOO_SHORT,

DESCRIPTION_TOO_SHORT,

PRICE_IS_NONE,

POSTAL_CODE_IS_NONE,

INSEE_CODE_IS_NONE,

CITY_IS_NONE,

OFFER_TYPE_IS_NONE,

TYPE_IS_NONE

data.{key}.property.estimatedPrice

object

data.{key}.property.imagesLength

integer

data.{key}.property.advertsLength

integer

data.{key}.property.historyLength

integer

data.{key}.property.websiteRefs

string[]

data.{key}.found

boolean

internalDelay

integer

Was this page helpful?

curl --request POST \
  --url https://api.f6o.co/v2/property/_many \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "ids": [
    "<string>"
  ],
  "excludedFields": [
    "<string>"
  ],
  "includedFields": [
    "<string>"
  ]
}'

{
  "apiVersion": "<string>",
  "context": "<string>",
  "data": {},
  "internalDelay": 123
}

Geocoding Gouv BANO

Authorizations

Body

Response