-
Notifications
You must be signed in to change notification settings - Fork 1
Property feed
The property feed should contain an array of properties, matching our specification.
- If new properties are found in the feed, they'll be created in our database and activated.
- If existing properties change their attributes, they'll be updated in our database.
- If properties are no longer present in the feed, they will be deactivated in our database.
To see a full example of what we need, have a look at the feed samples in the samples directory of this wikis repository.
Notice: As of this writing, Lokalebasen only offers a property section on the Danish site.
Below is an explanation of the attributes.
A unique and never changing key that identifies the property, typically a uuid or a database auto-incrementing id. We need it to reliably tell properties apart.
The type of property and should be one of the following:
| kind | description |
|---|---|
| housing | Known as "boligudlejning" or "boligejendomme" on our site - basically an apartment building |
| office | A building primarily used for offices |
| warehouse | A building primarily used for storage / industry |
| store | A building primarily used for retail |
| lot | A vacant piece of land intended for construction of buildings |
The title for the presentation of the property. E.g. "Brand new office complex with a spectacular ocean view"
The full description of the property. You may use HTML if you do it gracefully, but otherwise plain text with appropriate newlines will do just fine. We'll run it through a markdown processor either way to produce paragraph tags.
The full street address, e.g. "Lærkevej 54, 2. th"
The postal code for the property. E.g. "5700".
The district/city name for the postal code, e.g. "Svendborg"
The floor area specified in square meters.
The listed sales price for the property, specified in the currency used for the sales section.
The annual costs associated with operating the property (taxes, maintenance, administration, e.g.). There is no universal definition of what expenses this number should include.
The annual rental income from tenants occupying the property. This attribute is only mandatory and relevant for properties in the investment category.
Deposits and prepaid rents owed to current tenants. This attribute is only mandatory and relevant for properties in the investment category.
The primary contact for the property. If a client orders information about the property, these contact details will be shared with the client and an e-mail will be sent to the contact with information about the client.
The contact object is described on this wiki page.
A list of urls with photos of the property. Psync will download an encounted image only once, so if you edit an existing photo, Psync won't sync the changes unless you change the url of that image as well, in which case it will remove the old version and add the new version. The order of the urls control the display order on our website, so if you have a particular good photo, put it first and we will use it as the thumbnail whenever we display the property!
Don't worry about scaling, just provide us a sufficiently high resolution image url and we'll handle the rest. We support both JPEG, GIF and PNG images.
Same thing as with photos, except we won't display them anywhere other than the floor plan tab on the property page.
A url where we can download the prospectus. Like with images, we won't reload a prospectus once we've already downloaded it, but if you change the url, Psync will delete the old prospectus and download the new one. The resource MUST be a pdf-file.
A list of facilities, features or distinguishing qualities that the location offers. While you can add anything you want from up-to-date list of already approved facilities here: https://www.lokalebasen.dk/lease/api/facilities
Please constrain yourself to less than 10 facilities. While you can add more, it might make your location page appear clunky.
Read more about coordinates here.
You should set this to false for properties under construction. Defaults to true.
The construction year of the property.
The size of the lot on which the property resides. Specified in square meters.
The energy rating of the property, it must be one of the following values: ["A", "B", "C", "D", "E", "F", "G"]
A url to the property on your own website. Depending your plan with Lokalebasen, the link may be included on the description page for your property on our website.
The return rate - only relevant for investment properties. For a 5% return rate, the value should be 0.05. If you omit the return_rate, we'll compute it based on the rental income, deposits and the price.
If you don't have them, don't set them to empty strings or zero.
Send us the URL of a JSON feed containing a list of your properties matching this specification, and we'll set up the rest!