Import specificatie BOG

Details of the JSON specification used by woonpleinlimburg.nl to import property details from other systems into woonpleinlimburg.nl.

This page details the specification of an JSON feed to send property information to woonpleinlimburg.nl

Your JSON feed will contain all the property information for one woonpleinlimburg.nl advertiser account. We match the feed URL you give us to an advertiser account once we validate and approve the feed.

Each feed URL can only contain property information for a single woonpleinlimburg account or estate agent. If you are creating feeds for multiple estate agents, each one will need to be available on a unique URL.

We cannot accept a feed URL that requires any manual intervention (such as clicking on a ‘confirm’ button) because our property feed process is completely automatic.

Your property feed must be an absolute feed of all your property information – not an incremental one. Each time we process a feed, we evaluate it against every property for that account in the woonpleinlimburg database. Your feed must contain ALL the properties that you want ADDED or UPDATED. It should not contain any properties that you want to DELETE.

When a property is ADDED to your database, there will be a new property record for it in your feed. It will be INSERTED to our database and we will process and store all associated images

If a property is UPDATED in your database, the "updated" tag in your feed should also change. When we see a change in the "updated" tag, the property will be UPDATED in our database and we will process all associated images. Please note, if the date does not change, we will not update the property, and if the date is invalid or does not conform to this specification, the JSON feed will be updated weekly rather than daily.

If a property is DELETED from your database, there will be no property record for it in your feed. We DELETE properties and any associated images from our database when there is no matching property record in your feed.

In order to correctly insert, update or delete, we must consistently identify each property as a unique entity in your feed. We do this using the "id" tag which must consistently and uniquely identify each one of your properties.

Table of Contents

Field name
Type
Values
Description

General fields

id
string
example: "ABC1234"

REQUIRED unique object id

created
date time
example: "2020-02-16 22:15:17"

REQUIRED created date

updated
date time
example: "2020-08-27 15:21:30"

REQUIRED updated date

registration_type

string
"For sale", "For rent" or "For sale For rent"

REQUIRED indicates if object category is for sale, for rent, or both

sale
boolean
"true" or "false"

REQUIRED indicates if object category is sales

rent

boolean
"true" or "false"

REQUIRED indicates if object category is rental

status

string
"available", "under_offer", "sold", "rented", "reservation_sold", "reservation_rented", "under_option", "auctioned", "withdrawn" or "soon"

REQUIRED indicates the availability status of the object:

AvailableBeschikbaar
Under offerOnder bod
SoldVerkocht
RentedVerhuurd
Sold under reservationVerkocht onder voorbehoud
Rented under reservationVerhuurd onder voorbehoud
Under optionOnder optie
ActionedGeveild/verkocht bij inschrijving
WithdrawnIngetrokken
Available soonBinnenkort beschikbaar
featured
boolean
"yes" or "no"

indicates if object is featured or not

archived
boolean
"true" or "false"

indicates if object is archived or not (active or not)

confidential

boolean
"true" or "false"

indicates if object is confidential or not (vertrouwelijk).

This could be used for publication limitations.

own_interest

boolean
"true" or "false"

indicates if object is on the market for own interest or not (eigen belang, van makelaar(dij)).

This could be used for publication features.

Open house

open_house

boolean

"true" or "false"

indicates if there is an open house (Open huis)

open_house_dates

array

example:

"open_house_dates": [
{
"date": "30-09-2020",
"text": "text here open house"
},
{
"date": "07-11-2020",
"text": "text here open house"
}
],

indicates if there is an open house date active (could be multiple) in an array, tags indication within "open_house_dates" could be present:

"date"
"text"

date

date

example: "30-09-2020"

indicates the date of the open house in DD-MM-YYYY format (Datum open huis)

text

string

example:
"some text here"

additional text to define the open house date

Commercial manager

commercial_manager
string
example: "John Smith"
name of responsible real estate agent
commercial_manager_email
string
example: "j.smith@mail.com"
email of responsible real estate agent
commercial_manager_avatar
string
example: "https://domain.com/img.jpg"
profile image of the responsible agent

Address & location

address

string

example: "Neringpassage 170, Lelystad Nederland"

REQUIRED full address of the object

street

string

example: "Neringpassage"

REQUIRED streetname of the object

house_number

string

example: "170"

REQUIRED house number of the object

house_number_addition

string

example: "b"

REQUIRED house number addition of the object

street_address

string

example: "Neringpassage 170"

REQUIRED street and house number of the object

zip

string

example: "8224 BS"

REQUIRED zipcode of the object

city

string

example: "Lelystad"

REQUIRED city where the object is located in

country

string

example: "Nederland"

REQUIRED country where the object is located

latitude

string

example: "52.5087125200"

REQUIRED latitude of the address

longitude

string

example: "54.764266700"

REQUIRED longitude of the address

neighborhood

string

example: "central park"

neighborhood name where the object is located

NeighborhoodWijk
locations

multi

"business_park", "office_park", "shopping_area", "neighborhood_shopping_center", "furniture_boulevard", "residential_area", "rural_area", "other"

location area of the object

Business parkBedrijventerrein 
Office parkKantorenpark
Shopping area city centerWinkelgebied stadscentrum 
Neighborhood shopping centerWijkwinkelcentrum 
Furniture BoulevardMeubelboulevard
In residential areaIn woonwijk
Rural areaLandelijk gebied
OtherOverig

location_features

multi

"station_location", "in_port_area", "to_waterway", "shopping_mall", "peripheral_retail" "large_scale_retail",

indicated the object location feature(s) (Liggingskenmerk)

Station locationStationslocatie
In port areaIn havengebied
To waterwayAan vaarwater
In indoor shopping mallIn overdekt winkelcentrum
Peripheral retail establishment (size of products: car, boats, caravans, etc.)Perifere detailhandelsvestiging (grootte van de producten: auto, boten, caravans etc) 
Large-scale retail establishment (larger than 1500 m2)Grootschalige detailhandelsvestiging (groter dan 1500 m2) 

publish_address

boolean
"true" or "false"

indicates if object address may be published on websites or apps

Land registries

land_registries

array

example:

"land_registries": [
{
"municipality": "Vlissingen",
"municipality_code": "1033",
"section": "A",
"plot_number": "5032"
},
{
"municipality": "Vlissingen",
"municipality_code": "1033",
"section": "A",
"plot_number": "5298"
}
],

Land registries

Land registriesKadastrale gegevens
municipality

string

example: "Lelystad"

municipality of the land

MunicipalityGemeente
municipality_code

string

example: "LLS00"

municipality code of the land

Municipality codeGemeente code
section

string

example: "A1"

section of the land

SectionSectie
plot_number

string

example: "321E"

plot number of the land

Plot numberPerceelnummer

Financial

price

integer

example: "350000"

REQUIRED indicates the sales price in euro of the object

PricePrijs

price_type_sale

string

"asking_price", "purchase_price", "price_on_request" or "negotiable_price"

indicates the sales price type of the object

Asking priceVraagprijs
Purchase priceKoopprijs
Price on requestPrijs op aanvraag
Price negotiablePrijs n.o.t.k.

price_vat

boolean
"true" or "false"

REQUIRED indicated the price incl. or excl. VAT (BTW belast)

acceptance_date

date

example: "31-12-2020"

indicates the acceptance date

Acceptance dateDatum aanvaarding

condition

string

"kk" or "von"

REQUIRED indicates the sales price condition in euro of the object

acceptance

string

"in_consultation",
"by_date" or
"directly"

indicates the sales price specification

Tax chargedBTW belast
Exclusive building interestExclusief bouwrente
Tax includedInclusief BTW

rental_price

integer

example: "1750"

REQUIRED indicates the rental price in euro of the object

Rental priceHuurprijs

price_type_rent

string

"Rental price",
"Price on request" or
"negotiable_price"

indicates the rental price type of the object

Rental priceHuurprijs
Price on requestPrijs op aanvraag
Price negotiablePrijs n.o.t.k.

rental_condition

string

"monthly",
"yearly" or
"yearly_per_meter"

REQUIRED indicates the rental price condition in euro of the object

MonthlyPer maand
YearlyJaarlijks
Per m2 / per yearPer m2 / per jaar

service_costs

integer

example: "60"

indicates the monthly service costs in euro of the object

Service costsServicekosten

service_costs_period

string

"monthly", "yearly" or "yearly_per_meter"

indicates the service costs period in euro of the object

per monthper maand
per yearper jaar
Per m2 / per yearper m2 / per jaar

service_costs_vat

boolean
"true" or "false"

indicates if there the service costs are VAT included (BTW belast)

Business object categories

category
string

"office",
"retail",
"space",
"land",
"area",
"chr",
"other",
"leisure",
"investment" or
"public"

REQUIRED indicates main category type of the business object:

Office spaceKantoorruimte 
Retail spaceWinkelruimte 
Business spaceBedrijfsruimte 
Building landBouwgrond
Paved outdoor areaVerhard buitenterrein 
CHRHoreca
OtherOverige 
LeisureLeisure
InvestmentBelegging
Public real estateMaatschappelijk vastgoed 

functions

 

multi

"Kantoorruimte",
"Winkelruimte",
"Bedrijfsruimte",
"Bouwgrond",
"Verhard buitenterrein",
"Horeca",
"Overige",
"Leisure",
"Belegging",
"Maatschappelijk vastgoed"

OPTIONAL if category has additional  "functions" which could be more than 1 of each possible option.

Office spaceKantoorruimte
Retail spaceWinkelruimte
Business spaceBedrijfsruimte
Building landBouwgrond
Paved outdoor areaVerhard buitenterrein
CHRHoreca
OtherOverige
LeisureLeisure
InvestmentBelegging
Public real estateMaatschappelijk vastgoed

Category: CHR

chr

array

example:
"chr": {
"size": 10,
"sales_floor_area": 10,
"located_on_floor": [
"2",
"3",
"5",
"8",
"10",
"1"
],
"regions": [
"drenthe",
"flevoland",
"friesland",
"groningen",
],
"sector": [
"beverage",
"hotel"
],
"for_takeover": true,
"vat_charged": true,
"price": 40000,
"staff": true,
"beverage": [
"bistro",
"cafe",
"disco",
"hall_center"
],
"hotel_rooms": 12,
"hotel": [
"luxury_hotel",
"congress_hotel"
]
},

Note: if "chr" is present it could include the following tags within "chr" (Horeca):

"size"
"sales_floor_area"
"located_on_floor"
"regions"
"sector"
"for_takeover"
"vat_charged"
"price"
"staff"
"beverage"
"hotel_rooms""hotel"

array "chr"

size

integer

example: "100"

within "chr" the  "size" indicates the size (surface) of chr in m2

SizeOppervlakte

array "chr"

sales_floor_area

integer

example: "60"

within "chr" the  "sales_floor_area" indicates the sales floor area (surface) of chr in m2

Sales floor areaVerkoop vloeroppervlakte 

array "chr"

located_on_floor

array

multiple possible values, from "-2" up to "30"

example:
"located_on_floor": [
"2",
"3",
"5",
"8",
"10",
"1"
],

within "chr" the  "located_on_floor" indicates the floors which on chr is located

Located on floorGelegen op verdieping 

array "chr"

regions

multi

"drenthe",
"flevoland",
"friesland",
"gelderland",
"groningen",
"limburg",
"noord_brabant",
"noord_holland",
"overijssel",
"utrecht",
"zeeland",
"zuid_holland",
"amsterdam",
"den_haag",
"rotterdam",
"utrecht_stad",
"hollands_utrechtsemeren",
"ijsselmeerkust",
"noordzeebadplaatsen",
"utrechtse_heuvelrug",
"veluwe_en_veluwerand",
"waddeneilanden"

within "chr" the  "regions" indicates the regions where chr is active

DrentheDrenthe
FlevolandFlevoland
FrieslandFriesland
GelderlandGelderland
GroningenGroningen
LimburgLimburg
Noord-BrabantNoord-Brabant
Noord-HollandNoord-Holland
OverijsselOverijssel
UtrechtUtrecht
ZeelandZeeland
Zuid-HollandZuid-Holland
AmsterdamAmsterdam
Den HaagDen Haag
RotterdamRotterdam
Utrecht (stad)Utrecht (stad)
Hollands-UtrechtsemerenHollands-Utrechtsemeren
IjsselmeerkustIjsselmeerkust
NoordzeebadplaatsenNoordzeebadplaatsen
Utrechtse Heuvelrug ‘t GooiUtrechtse Heuvelrug ‘t Gooi
Veluwe en VeluwerandVeluwe en Veluwerand
WaddeneilandenWaddeneilanden

array "chr"

for_takeover

boolean

"true" or "false"

within "chr" the  "for_takeover" indicates if chr is for takeover or not (Ter overname)

array "chr"

vat_charged

boolean

"true" or "false"

within "chr" the  "vat_charged" indicates if chr takeover is VAT charged or not (BTW belast)

array "chr"

price

integer

example: "25000"

within "chr" the  "price" indicates the price of the  takeover in euro (Prijs overname)

array "chr"

staff

boolean

"true" or "false"

within "chr" the  "staff" indicates if the takeover within chr includes the staff

array "chr"

sector

multi

"beverage",
"fast_food",
"restaurant",
"hotel"

within "chr" the  "sector" indicates the type of sector(s) where chr belongs to

Beverage sectorDrankensector 
Fast food sectorFastfoodsector 
Restaurant sectorRestaurantsector 
Hotel sectorHotelsector

array "chr"

beverage

multi

"cafe",
"bistro",
"disco",
"hall_center"

within "chr" the  "sector" indicates the "beverage" sector (Drankensector)

CafeCafé
BistroEetcafé
DiscoDiscotheek
(café) Hall center (café) Zalencentrum 

array "chr"

fast_food

multi

"snack_bar",
"cafeteria",
"lunchroom",
"ice_cream"

within "chr" the  "sector" indicates the "fast_food" sector (Fastfoodsector)

Snack bar (mainly counter sale)Snackbar (vnl. toonbankverkoop) 
Cafeteria, restariaCafetaria, restaria
Lunchroom, sandwich shopLunchroom, broodjeszaak 
Ice cream parlorIjssalon 

array "chr"

hotel

multi

"hotel",
"luxury_hotel",
"congress_hotel",
"garni"

within "chr" the  "sector" indicates the "hotel" sector (Hotelsector)

Hotel (café-restaurant)Hotel (-café-restaurant) 
Luxury hotelLuxe hotel 
Congress hotelCongreshotel 
Hotel garniHotel-garni 

array "chr"

hotel_rooms

integer

example: "50"

within "chr" the  "sector" indicates the "hotel" sector, if "hotel" is present within the "sector", the "hotel_rooms" indicates the number of the hotel rooms.

Number of hotel roomsAantal hotelkamers 

array "chr"

restaurant

multi

"bistro",
"cafe",
"luxury",
"roadside",
"chinese_indian",
"pancake_house",
"party_center",
"congress_hall_center"

within "chr" the  "sector" indicates the "restaurant" sector (Restaurantsector)

Bistro, petit restaurantBistro, petit-restaurant 
Cafe RestaurantCafé-restaurant
Luxury restaurantLuxe restaurant
Roadside restaurantWegrestaurant 
Chinese Indian restaurantChinees-Indisch restaurant 
Pancake house / creperiePannenkoekenhuis/creperie 
Restaurant party centerRestaurant-partycentrum 
Congress hall centerCongres-zalencentrum 

chr_sector_categories

multi

"cafeteria",
"cafe_restaurant",
"hull_catering_space",
"day_exploitation",
"bistro",
"hotel",
"lunchroom",
"restaurant",
"road_restaurant",
"halls_party_center",
"investment"

if main "category" is  "chr" it could contain additional "chr_sector_categories"

CafeteriaCafeteria
Cafe RestaurantCafé-restaurant
Hull catering spaceCasco-horecaruimte
Day exploitationDagexploitatie
BistroEetcafé
HotelHotel
LunchroomLunchroom
RestaurantRestaurant
Road restaurantWegrestaurant
Hall party centerZalen/partycentrum
InvestmentBelegging

Category: Office

office

array

example:

"office": {
"size": 250,
"in_units_from": 25,
"deepenings": 5
},

Note: if "office" is present it could include the following tags within "office" (Kantoorruimte):

"size"
"in_units_from"
"deepenings"

array "office"

size

integer

example: "250"

within "office" the  "size" indicates the size (surface) of the office surface in m2

SizeOppervlakte

array "office"

in_units_from

integer

example: "25"

within "office" the  "in_units_from" indicates the size (surface) of the units surface in m2

In units fromIn units vanaf

array "office"

deepenings

integer

example: "5"

within "office" the  "deepenings" indicates number of deepenings of the office

DeepeningsVerdiepingen 

Category: Business space

space

array

example:

"space": {
"size": 250,
"in_units_from": 25
},

Note: if "space" is present it could include the following tags within the business "space" (Bedrijfsruimte):

"size"
"in_units_from"

array "space"

size

integer

example: "250"

within business "space" the  "size" indicates the size (surface) of the business space surface in m2

SizeOppervlakte

array "space"

in_units_from

integer

example: "25"

within "space" the  "in_units_from" indicates the size (surface) of the units surface in m2

In units fromIn units vanaf

Category: Retail

Category: Leisure

leisure

array

example:

"leisure": {
"type": "camping",
"features": [
"camp",
"electricity",
"sewerage",
"catering",
"toilets",
"swimming_pool",
"front_desk"
]
},

Note: if "leisure" is present it could include the following tags within the "leisure" (Leisure):

"type"
"features"

type

string

"camping",
"bungalow_park",
"day_recreation",
"wellness" or
"other"

Note: if "leisure" is present it could include the following tags within the "type" (Leisure type):

CampingCamping
Bungalow parkBungalowpark
Day recreationDagrecreatie
WellnessWellness
OtherOverig

features

multi

"camp",
"electricity",
"sewerage",
"catering",
"toilets",
"swimming_pool",
"front_desk"

Note: if "leisure" is present it could include the following tags within the "features" (Voorzieningen):

Camp shopKampwinkel 
ElectricityElectra
SewerageRiolering
Catering presentHoreca aanwezig 
Toilet buildingsToiletgebouwen 
Swimming poolZwembad 
Front deskReceptie 

Category: Investment

investment

array

example:

"investment": {
"type": "office_space"
},

Note: if "investment" is present it could include the following tags within the business "investment" (Belegging):

"size"
"in_units_from"

type

string

"office_space",
"retail_space",
"business_space",
"paved_outdoor_area",
"chr",
"leisure",
"public_real_estate",
"living_space",
"building_land",
"agricultural_business" or
"other"

Note: if "investment" is present it could include the following tags within the "type" (Type belegging):

Office spaceKantoorruimte 
Retail spaceWinkelruimte 
Business spaceBedrijfsruimte 
Paved outdoor areaVerhardbuitenterrein 
CHRHoreca
LeisureLeisure
Public real estateMaatschappelijkvastgoed 
Living spaceWoonruimte
Building landGrond
Agricultural businessAgrarischbedrijf
OtherOverig

Category: Retail

Category: Land

land

array

example:

"land": {
"building_possibilities": "business",
"volume": 3000,
"volume_unit": "m2"
},

Note: if "land" is present it could include the following tags within the business "land" (Belegging):

"building_possibilities"
"volume"
"volume_unit"

type

string

"business",
"office",
"chr",
"other" or
"retail"

Note: if "land" is present it could include the following tags within the "building_possibilities" (Bebouwingsmogelijkheid ):

Business spaceBedrijfsruimte 
Office spaceKantoorruimte 
CHRHoreca 
OtherOverige 
Retail spaceWinkelruimte 

volume

integer

example: "3000"

Note: if "land" is present it could include the following tag "volume" (Bouwvolume):

Built volumeBouwvolume 

volume_unit

string

"m2" or
"percent"

Note: if "land" is present it could include the following tag "volume_unit" to describe the type of "volume" (Bouwvolume)

Category: Public Real Estate

public

array

example:

"public": {
"types": [
"healthcare",
"sport",
"healthcare",
"sport",
"cultural",
"religious",
"educational"
]
},

Note: if "public" is present it could include the following tags within the "public" real estate (Maatschappelijk vastgoed):

"types"

types

multi

"healthcare",
"sport",
"cultural",
"religious",
"educational"

Possible options of public real estate "types" (Type instelling):

Healthcare institutionZorg instelling
Sport institutionSport instelling
Cultural InstitutionCulturele instelling
Religious InstitutionReligieuze Instelling
Educational institutionOnderwijs instelling

Category: Other

other

array

example:

"other": {
"type": "garage",
"size": 80,
"deepenings": 1
},

Note: if "other" is present it could include the following tags within the "other" business estate (Overige):

"type"
"size"
"deepenings"

array "other"

type

string

"garage" or
"space"

within "other" the  "type" tag indicates the type of business estate

Garage boxGaragebox 
Practice spacePraktijkruimte 

array "other"

size

integer

example: "80"

within "other" the  "size" indicates the size (surface) of the surface in m2

SizeOppervlakte

array "other"

deepenings

integer

example: "1"

within "other" the  "deepenings" indicates number of deepenings

DeepeningsVerdiepingen 

Residential object

Note: if a residential object is present within the business object we included the following tags;

object_situation

string
"available" or "possible"

REQUIRED if residential object is present

Living space availableWoonruimte aanwezig
Living space possibleWoonruimte mogelijk

object_situation

 

string
"indoor", "extension" or "detached"

REQUIRED if residential object is present

IndoorInpandig
ExtensionAanbouw
DetachedVrijstaand

object_id

string

example: "123456"

REQUIRED if residential object is present, indicates unique object ID of the residential object.

Could be used to connect or redirect the residential object to the business object.

Construction

new_construction

boolean

"true" or "false"

REQUIRED indicates if object is a new construction

New constructionNieuwbouw
build_year
integer
example: "1997"

indicates the build year of the object in YYYY

Build yearBouwjaar
build_period
string

"- 1906",
"1906 – 1930",
"1931 – 1944",
"1945 – 1959",
"1960 – 1970",
"1971 – 1980",
"1981 – 1990",
"1991 – 2000",
"2001 – 2010" or
"2011 -"

indicates the build period of the object if the build year is unknown

Build periodBouwperiode

Parking

Descriptions

description_nl

string

example:
"description_nl": "Op een mooie, rustige locatie in de geliefde wijk ‘Paauwenburg’ ligt deze ruime twee-onder-één kapwoning.\n\nEerste verdieping: Overloop met laminaatvloer, een nette betegelde badkamer met een ligbad, een douchecabine, een toilet en een wastafelmeubel.",

REQUIRED main description of the object (in Dutch)

description_en

string

example:
"description_en": "Some text here",

main description of the object (in English)

main_description

array

example:
"main_description": {
"en": "",
"ru": "",
"es": "",
"nl": ""
},

main_description of the object (multilingual, in array: en, nl, es, ru)

Same field as description_nl or description_en but in array with additional languages.

short_description

array

example:
"short_description": {
"en": "",
"nl": "",
"ru": "",
"es": ""
},

short description of the object (multilingual, in array: en, nl, ru, es)

leaflet_text

array

example:
"leaflet": {
"en": "",
"nl": "",
"ru": "",
"es": ""
},

leaflet text of the object (multilingual, in array: en, nl, ru, es)

titles

array

example:
"titles": {
"en": "House for sale Aalbersestraat 16 4384 HL Vlissingen ",
"nl": "Woonhuis te koop Aalbersestraat 16 4384 HL Vlissingen "
},

Auto generated titles of the object (multilingual, in array: en, nl)

Could be used as a title or to generate a page url of the object and as title for SEO purposes.

meta_descriptions

array

example:
"meta_descriptions": {
"en": "Description here",
"nl": "Omschrijving hier"
},

Auto-generated meta description of the object (multilingual, in array: en, nl)

Could be used as description for SEO purposes.

meta_keywords

array

example:
"meta_keywords": {
"en": "keyword1, keyword2",
"nl": "zoekwoord1, zoekwoord2"
},

Auto-generated meta keywords of the object (multilingual, in array: en, nl)

Could be used as keywords for SEO purposes.

usps

array

example:
"usps": {
"usp_one": {
"en": "",
"nl": "",
"ru": "",
"es": ""
},
"usp_two": {
"en": "",
"nl": "",
"ru": "",
"es": ""
},
"usp_three": {
"en": "",
"nl": "",
"ru": "",
"es": ""
}
},

3 USP’s of the object (multilingual, in array: en, nl, ru, es)

Custom descriptions (SEO purposes)

custom_titles

array

example:
"custom_titles": {
"en": "House for sale Aalbersestraat 16",
"ru": "Dom Prodazha Aalbersestraat 16",
"es": "Casa en venta  Aalbersestraat 16",
"nl": "Huis te koop Aalbersestraat 16"
},

custom titles of the object (multilingual, in array: en, nl, es, ru)

Could be used as a title or to generate a page url of the object and as title for SEO purposes.

custom_urls

array

example:
"custom_urls": {
"en": "house-for-sale-aalbersestraat-16-4384-hl-vlissingen",
"ru": "house-for-sale-aalbersestraat-16-4384-hl-vlissingen",
"es": "casa-en-venta-aalbersestraat-16-4384-hl-vlissingen",
"nl": "woonhuis-te-koop-aalbersestraat-16-4384-hl-vlissingen"
},

custom urls of the object (multilingual, in array: en, nl, es, ru)

Could be used as a custom page url of the object.

custom_descriptions

array

example:
"custom_descriptions": {
"en": "",
"ru": "",
"es": "",
"nl": ""
},

custom meta descriptions of the object (multilingual, in array: en, nl, es, ru)

Could be used as custom modified meta descriptions for SEO purposes.

custom_keywords

array

example:
"custom_keywords": {
"en": "house, for sale, aalbersestraat 16",
"ru": "dom, prodazha, aalbersestraat 16",
"es": "casa, en venta, aalbersestraat 16",
"nl": "huis, te koop, aalbersestraat 16"
},

custom keywords of the object (multilingual, in array: en, nl, es, ru)

Could be used as custom modified keywords for SEO purposes.

Media

image

string

example: "https://domain.com/object/main-image.jpg"

absolute url of the main image of the object

images

array

example:
"images": [
{
"id": 274928,
"sort": 1,
"url": "https://domain.com/object/392372598.jpg"
},
{
"id": 274929,
"sort": 2,
"url": "https://domain.com/object/2781512586.jpg"
},
{
"id": 274930,
"sort": 3,
"url": "https://domain.com/object/3412723251.jpg"
},
{
"id": 274931,
"sort": 4,
"url": "https://domain.com/object/3445401687.jpg"
}
]

images of the object in array with "id", "sort" sort order and "url" as the absolute image url

plans

array

example:
"plans": [
{
"id": 11038,
"sort": 200,
"url": "https://domain.com/object/3602172565.jpg",
"title": "Floor plan"
},
{
"id": 11039,
"sort": 201,
"url": "https://domain.com/object/215058354.jpg",
"title": "Floor plan"
},
{
"id": 11040,
"sort": 202,
"url": "https://domain.com/object/3841480935.jpg",
"title": "Floor plan"
}
]

floor plans of the object in array with "id", "sort" sort order "url" as the absolute floor plan (image; jpg / png) url and (optional) "title"

external_plans

string

example: "https://m2makelaars.floorplanner.com/aalbersestraat-16-te-vlissingen/embed/"

absolute url of the external floor plan of the object (this might be a tour or a interactive floor plan)

external_panoramas

string

example: "https://www.virtuelepioniers.nl/clients/m2makelaars/vlissingen_aalbersestraat_16/"

absolute url of the external panorama / virtual tour of the object (this might be a tour or a interactive floor plan)

videos

array

example:
"videos": [
{
"code": "kD51kbDZCjM",
"link": "https://www.youtube.com/watch?v=kD51kbDZCjM"
}
],

videos of the object in array with "code" (optional) and"link" as the absolute url of the video