PUT
/
v2
/
protected
/
properties
/
search
/
alerts
/
many
const request = require('request');

const options = {
  method: 'PUT',
  url: 'https://api.fluximmo.io/v2/protected/properties/search/alerts/many',
  headers: {'content-type': 'application/json', 'x_api_key': 'REPLACE_KEY_VALUE'},
  body: {
    alerts: [
      {
        search_query: {
          filterProperty: {
            adverts: [
              {
                firstSeenAt: {max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'},
                flxId: ['string'],
                isOnline: true,
                lastSeenAt: {max: '2022-10-21T11:31:33.593Z', min: '2022-10-21T11:31:33.593Z'},
                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'}
                },
                price: {
                  currency: 'EUR',
                  initial: {
                    source: {flxId: 'string', url: 'string', website: 'string'},
                    value: {max: 0, min: 0},
                    valuePerArea: {max: 0, min: 0}
                  },
                  isAuction: true,
                  latest: {
                    source: {flxId: 'string', url: 'string', website: 'string'},
                    value: {max: 0, min: 0},
                    valuePerArea: {max: 0, min: 0}
                  },
                  scope: 'PRICING_ONE_OFF',
                  warrantyDeposit: {max: 0, min: 0},
                  variation: [{sinceLastModified: {max: 0, min: 0}, sincePublished: {max: 0, min: 0}}]
                },
                source: {flxId: 'string', url: 'string', website: 'string'},
                isPro: true,
                seller: [
                  {flxId: 'string', name: 'string', siren: 'string', type: 'SELLER_TYPE_UNKNOWN'}
                ],
                hasAnomaly: true,
                isExclusive: true
              }
            ],
            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}
            },
            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
            },
            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'
              }
            ],
            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'}
            },
            parking: {
              count: {max: 0, min: 0},
              numberOfCars: {max: 0, min: 0},
              surface: {max: 0, min: 0},
              type: 'PARKING_UNKNOWN'
            },
            price: {
              currency: 'EUR',
              initial: {
                source: {flxId: 'string', url: 'string', website: 'string'},
                value: {max: 0, min: 0},
                valuePerArea: {max: 0, min: 0}
              },
              isAuction: true,
              latest: {
                source: {flxId: 'string', url: 'string', website: 'string'},
                value: {max: 0, min: 0},
                valuePerArea: {max: 0, min: 0}
              },
              scope: 'PRICING_ONE_OFF',
              warrantyDeposit: {max: 0, min: 0},
              variation: [{sinceLastModified: {max: 0, min: 0}, sincePublished: {max: 0, min: 0}}]
            },
            process: 'PROCESS_UNKNOWN',
            tags: ['string'],
            type: 'CLASS_UNKNOWN',
            hasAnomaly: true,
            offer: [
              {
                isCurrentlyOccupied: true,
                renting: {isColocation: true, isLongTerm: true, isShortTerm: true, isSubLease: true},
                type: 'OFFER_UNKNOWN'
              }
            ]
          },
          fullTexts: ['string'],
          keywords: ['string']
        },
        webhook_url: 'string',
        search_name: 'string',
        match: ['ALERT_MATCH_UNKNOWN'],
        context: {metadata: {}}
      }
    ]
  },
  json: true
};

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

  console.log(body);
});
{
  "data": {
    "alerts": [
      {
        "failed": {
          "code": 123,
          "message": "<string>"
        },
        "success": "<string>"
      }
    ]
  }
}

Authorizations

x-api-key
string
headerrequired

Body

application/json
alerts
object[]

List of property alerts to be created

Response

200 - application/json
data
object
required