POST
/
v2
/
protected
/
adverts
/
search
const request = require('request');

const options = {
  method: 'POST',
  url: 'https://api.fluximmo.io/v2/protected/adverts/search',
  headers: {'content-type': 'application/json', 'x_api_key': 'REPLACE_KEY_VALUE'},
  body: {
    orderBy: 'ASC',
    search: {
      filterAd: {
        currentPrice: {value: {max: 0, min: 0}, valuePerArea: {max: 0, min: 0}},
        habitation: {
          bathroomCount: {max: 0, min: 0},
          bedroomCount: {max: 0, min: 0},
          characteristics: {
            hasAlarm: true,
            hasBalcony: true,
            hasCellar: true,
            hasConcierge: true,
            hasDigicode: true,
            hasFireplace: true,
            hasGarage: true,
            hasGarden: true,
            hasGrenier: true,
            hasInterphone: true,
            hasJacuzzi: true,
            hasLand: true,
            hasLift: true,
            hasMezzanine: true,
            hasParking: true,
            hasPool: true,
            hasTerrace: true,
            hasVisAVis: true,
            isPeaceful: true
          },
          climate: {
            epcClimate: 'GREENHOUSE_CLASSIFICATION_UNKNOWN',
            epcClimateScore: {max: 0, min: 0},
            epcEnergy: 'ENERGY_CLASSIFICATION_UNKNOWN',
            epcEnergyScore: {max: 0, min: 0},
            epcClimateDate: {max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'},
            epcEnergyDate: {max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'}
          },
          features: {
            exposure: 'EXPOSURE_UNKNOWN',
            furniture: 'UNKNOWN_FURNITURE',
            propertyFloor: {max: 0, min: 0},
            propertyTotalFloor: {max: 0, min: 0},
            constructionMaterials: 'MATERIAL_UNKNOWN',
            glazingTypes: 'GLAZING_TYPE_UNKNOWN',
            hasThroughExposure: true,
            viewOns: 'VIEW_ON_UNKNOWN',
            viewTypes: 'VIEW_TYPE_UNKNOWN'
          },
          heatTypes: 'HEAT_TYPE_UNKNOWN',
          heatTypeDetails: 'HEAT_DETAIL_UNKNOWN',
          heatings: 'HEATING_UNKNOWN',
          propertyCondition: [
            {
              constructionYear: 0,
              interiorCondition: 'INTERIOR_CONDITION_UNKNOWN',
              renovationYear: 0,
              generalConditions: 'GENERAL_CONDITION_UNKNOWN'
            }
          ],
          roomCount: {max: 0, min: 0},
          surface: {
            balconies: {max: 0, min: 0},
            floorSpace: {max: 0, min: 0},
            gardens: {max: 0, min: 0},
            groundFloor: {max: 0, min: 0},
            kitchen: {max: 0, min: 0},
            livingSpace: {max: 0, min: 0},
            livingroom: {max: 0, min: 0},
            terraces: {max: 0, min: 0},
            total: {max: 0, min: 0}
          },
          type: 'PROPERTY_TYPE_UNKNOWN',
          wcCount: {max: 0, min: 0}
        },
        hasAnomaly: true,
        isAuction: true,
        isUrgent: true,
        land: {
          canConstruct: true,
          isServiced: true,
          surface: {max: 0, min: 0},
          surfaceConstructable: {max: 0, min: 0},
          type: 'LAND_UNKNOWN',
          haveBuildingPermit: true,
          haveElectricity: true,
          haveTelecom: true,
          haveWater: true
        },
        lastModifiedAt: [{max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'}],
        offer: [
          {
            isCurrentlyOccupied: true,
            renting: {isColocation: true, isLongTerm: true, isShortTerm: true, isSubLease: true},
            type: 'OFFER_UNKNOWN'
          }
        ],
        parking: {
          count: {max: 0, min: 0},
          numberOfCars: {max: 0, min: 0},
          surface: {max: 0, min: 0},
          type: 'PARKING_UNKNOWN'
        },
        process: 'PROCESS_UNKNOWN',
        scope: 'PRICING_ONE_OFF',
        tags: ['string'],
        type: 'CLASS_UNKNOWN',
        warrantyDeposit: {max: 0, min: 0},
        firstSeenAt: [{max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'}],
        location: {
          city: 'string',
          cityCoordinate: {
            location: {
              geoBoundingBox: {bottomRight: {lat: 0, lon: 0}, topLeft: {lat: 0, lon: 0}},
              geoDistance: {distanceKm: 0, pin: {lat: 0, lon: 0}},
              geoInseeCodeDistance: {distanceKm: 0, inseeCode: 'string'}
            }
          },
          department: 'string',
          inseeCode: 'string',
          irisCode: 'string',
          locationCoordinate: {
            location: {
              geoBoundingBox: {bottomRight: {lat: 0, lon: 0}, topLeft: {lat: 0, lon: 0}},
              geoDistance: {distanceKm: 0, pin: {lat: 0, lon: 0}},
              geoInseeCodeDistance: {distanceKm: 0, inseeCode: 'string'}
            }
          },
          postalCode: 'string'
        },
        source: {flxId: 'string', url: 'string', website: 'string'},
        currency: 'EUR',
        mainPropertyAdFlxId: ['string'],
        propertyFlxId: ['string'],
        isPro: true,
        seller: [
          {flxId: 'string', name: 'string', siren: 'string', type: 'SELLER_TYPE_UNKNOWN'}
        ],
        isOnline: true,
        isExclusive: true
      },
      fullTexts: ['string'],
      keywords: ['string']
    },
    searchAfterHash: 'string',
    size: 0,
    sortBy: 'FIRST_SEEN_AT'
  },
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
{
  "data": {
    "count": 123,
    "items": [
      {
        "currency": "CURRENCY_EUR",
        "currentPrice": {
          "value": 123,
          "valuePerArea": 123
        },
        "description": "<string>",
        "firstSeenAt": "2022-10-21T11:31:33.593Z",
        "flxId": "<string>",
        "habitation": {
          "bathroomCount": 123,
          "bedroomCount": 123,
          "characteristics": {
            "hasAlarm": true,
            "hasBalcony": true,
            "hasCellar": true,
            "hasConcierge": true,
            "hasDigicode": true,
            "hasFireplace": true,
            "hasGarage": true,
            "hasGarden": true,
            "hasGrenier": true,
            "hasInterphone": true,
            "hasJacuzzi": true,
            "hasLand": true,
            "hasLift": true,
            "hasMezzanine": true,
            "hasParking": true,
            "hasPool": true,
            "hasTerrace": true,
            "hasVisAVis": true,
            "isPeaceful": true
          },
          "climate": {
            "epcClimate": "GREENHOUSE_CLASSIFICATION_UNKNOWN",
            "epcClimateDate": "2022-10-21T11:31:33.593Z",
            "epcClimateScore": 123,
            "epcEnergy": "ENERGY_CLASSIFICATION_UNKNOWN",
            "epcEnergyDate": "2022-10-21T11:31:33.593Z",
            "epcEnergyScore": 123
          },
          "features": {
            "constructionMaterials": "MATERIAL_UNKNOWN",
            "exposure": "EXPOSURE_UNKNOWN",
            "furniture": "UNKNOWN_FURNITURE",
            "hasThroughExposure": true,
            "propertyFloor": 123,
            "propertyTotalFloor": 123,
            "viewOns": "VIEW_ON_UNKNOWN",
            "viewTypes": "VIEW_TYPE_UNKNOWN"
          },
          "heatTypeDetails": [
            "HEAT_DETAIL_UNKNOWN"
          ],
          "heatTypes": [
            "HEAT_TYPE_UNKNOWN"
          ],
          "heatings": [
            "HEATING_UNKNOWN"
          ],
          "propertyCondition": {
            "constructionYear": 123,
            "generalConditions": "GENERAL_CONDITION_UNKNOWN",
            "interiorCondition": "INTERIOR_CONDITION_UNKNOWN",
            "renovationYear": 123
          },
          "roomCount": 123,
          "surface": {
            "balconies": 123,
            "floorSpace": 123,
            "gardens": 123,
            "groundFloor": 123,
            "kitchen": 123,
            "livingRoom": 123,
            "livingSpace": 123,
            "terraces": 123,
            "total": 123
          },
          "type": "PROPERTY_TYPE_UNKNOWN",
          "wcCount": 123
        },
        "hasAnomaly": true,
        "isAuction": true,
        "isExclusive": true,
        "isOnline": true,
        "isPro": true,
        "isUrgent": true,
        "land": {
          "canConstruct": true,
          "hasBuildingPermit": true,
          "hasElectricity": true,
          "hasTelecom": true,
          "hasWater": true,
          "isServiced": true,
          "surface": 123,
          "surfaceConstructable": 123,
          "type": "LAND_UNKNOWN"
        },
        "lastModifiedAt": "2022-10-21T11:31:33.593Z",
        "lastSeenAt": "2023-11-07T05:31:56Z",
        "location": {
          "city": "<string>",
          "cityCoordinate": {
            "location": [
              123
            ]
          },
          "department": "<string>",
          "inseeCode": "<string>",
          "irisCode": "<string>",
          "locationCoordinate": {
            "location": [
              123
            ]
          },
          "postalCode": "<string>"
        },
        "mainPropertyAdFlxId": "<string>",
        "medias": {
          "images": [
            {
              "url": "<string>"
            }
          ],
          "virtualVisitExternalUrl": [
            "<string>"
          ]
        },
        "offer": {
          "isCurrentlyOccupied": true,
          "renting": {
            "isColocation": true,
            "isLongTerm": true,
            "isShortTerm": true,
            "isSubLease": true
          },
          "type": "OFFER_UNKNOWN"
        },
        "parking": {
          "count": 123,
          "numberOfCars": 123,
          "surface": 123,
          "type": "PARKING_UNKNOWN"
        },
        "propertyFlxId": "<string>",
        "scope": "PRICING_ONE_OFF",
        "seller": {
          "flxId": "<string>",
          "name": "<string>",
          "siren": "<string>",
          "type": "SELLER_TYPE_UNKNOWN"
        },
        "source": {
          "flxId": "<string>",
          "url": "<string>",
          "website": "<string>"
        },
        "tags": [
          "<string>"
        ],
        "title": "<string>",
        "type": "CLASS_UNKNOWN",
        "warrantyDeposit": 123
      }
    ],
    "searchAfterHash": "<string>"
  }
}

Authorizations

x-api-key
string
headerrequired

Body

application/json
orderBy
enum<string>
required
Available options:
ASC,
DESC
search
object
required
searchAfterHash
string

The searchAfterHash parameter allows you to retrieve the next page of results by using the searchAfterHash value returned in the response from the previous page. This method eliminates the complexities of traditional pagination methods and ensures accurate results, regardless of insertions or deletions in the dataset.

size
number
required
sortBy
enum<string>
required
Available options:
FIRST_SEEN_AT,
PRICE,
LAST_UPDATED_AT,
LAST_SEEN_AT

Response

200 - application/json
data
object
required