Specificatie BOG
Details of the JSON specification used by Pyber to export business object details to other systems or websites.
This page details the specification of an JSON feed to export property information
Update 12-01-2023:
CHR section:
Within chr_sector_categories field a new value has been added: “wellness”
The JSON feed will contain all the property information for one account.
Each feed URL can only contain property information for a single account or estate agent. If there are multiple estate agents, each one will have their own unique URL.
The property feed is an absolute feed of all the property information – not an incremental one. The feed contains ALL the properties that are ADDED or UPDATED by the agency. The feed does not contain any properties that are DELETED.
When a property is ADDED, there will be a new property record for it in the feed. You need to process and store all associated images.
If a property is UPDATED in the feed, the "updated" tag in our feed will also change. When you see a change in the "updated" tag, the property will need to be UPDATED in your database and processed with all associated images. Please note, if the date does not change, there is no need to update the property. Our JSON feed is updated automatically. However we strongly recommand to import the feed not more than 1 time per hour.
If a property is DELETED, there will be no property record for it in our feed. In this case you need to DELETE properties and any associated images from your database when there is no matching property record in our feed.
In order to correctly insert, update or delete, we identify each property as a unique entity in the feed. We do this using the "id" tag which must consistently and uniquely identify each one of the properties.
Table of Contents
Field name
Type
Values
Description
General fields
string example: "B1234"
REQUIRED unique object id
date time "2020-02-16 22:15:17" REQUIRED created date
date time "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
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:
| Available | Beschikbaar |
| Under offer | Onder bod |
| Sold | Verkocht |
| Rented | Verhuurd |
| Sold under reservation | Verkocht onder voorbehoud |
| Rented under reservation | Verhuurd onder voorbehoud |
| Under option | Onder optie |
| Actioned | Geveild/verkocht bij inschrijving |
| Withdrawn | Ingetrokken |
| Available soon | Binnenkort beschikbaar |
boolean "yes" or "no" indicates if object is featured or not
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
"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
string "John Smith" string "j.smith@mail.com" string "https://domain.com/img.jpg" commercial_manager_main_phone
string "+31850201615" primary telephone incl. landcode of the responsible agent (optional)
commercial_manager_whatsapp
string "+31850201615" WhatsApp number incl. landcode of the responsible agent (optional)
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
| Neighborhood | Wijk |
multi
"business_park",
"office_park",
"shopping_area",
"neighborhood_shopping_center",
"furniture_boulevard",
"residential_area",
"rural_area",
"other" location area of the object
| Business park | Bedrijventerrein |
| Office park | Kantorenpark |
| Shopping area city center | Winkelgebied stadscentrum |
| Neighborhood shopping center | Wijkwinkelcentrum |
| Furniture Boulevard | Meubelboulevard |
| In residential area | In woonwijk |
| Rural area | Landelijk gebied |
| Other | Overig |
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 location | Stationslocatie |
| In port area | In havengebied |
| To waterway | Aan vaarwater |
| In indoor shopping mall | In 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
array
example:
"land_registries": [},
{
"municipality": "Vlissingen",
"municipality_code": "1033",
"section": "A",
"plot_number": "5032",
"surface": "150",
"scope": "Geheel perceel",
"scope_kind": "Volle eigendom"
{
"municipality": "Vlissingen",
"municipality_code": "1033",
"section": "A",
"plot_number": "5298",
"surface": "15",
"scope": "Geheel perceel",
"scope_kind": "Volle eigendom"
}
],
Land registries
| Land registries | Kadastrale gegevens |
string
example: "Lelystad"
municipality of the land
| Municipality | Gemeente |
string
"LLS00" municipality code of the land
| Municipality code | Gemeente code |
string
example: "A1"
section of the land
| Section | Sectie |
string
example: "321E"
plot number of the land
| Plot number | Perceelnummer |
surface
integer
example: "150"
indicates the plot surface in m2 of the object
| Surface | Oppervlakte |
scope
string
"Geheel perceel",
"Deelperceel",
"Appartementsrecht of complex", "Beklemming" or
"Lidmaatschapsrecht" indicates the scope of the land registry of the object
| Whole parcel | Geheel perceel |
| Part parcel | Deelperceel |
| Apartment rights or complex | Appartementsrecht of complex |
| Constriction | Beklemming |
| Membership rights | Lidmaatschapsrecht |
scope_kind
string
"Volle eigendom","Erfpacht","Eigendom belast met erfpacht","Ondererfpacht","Opstal","Eigendom belast met opstal","Erfpacht en opstal","Eigendom belast met erfpacht en opstal","Beklemrecht","Eigendom belast met beklemrecht","Stadsmeierrecht","Eigendom belast met stadsmeierrecht","Onderbeklemrecht","Vruchtgebruik","Eigendom belast met vruchtgebruik","Gebruik en bewoning","Eigendom belast met gebruik en bewoning","Eigendom belast met beperkte rechten","Erfpacht belast met vruchtgebruik","Opstal belast met vruchtgebruik","Erfpacht en opstal belast met vruchtgebruik","Beklemrecht belast met vruchtgebruik","Erfpacht belast met gebruik en bewoning","Opstal belast met gebruik en bewoning","Erfpacht en opstal belast met gebruik en bewoning","Beklemrecht belast met gebruik en bewoning","Zie akte","Lidmaatschapsrecht","Mandelig" or"Recht van overbouw"
indicates the kind of scope of the land registry of the object
| Full ownership | Volle eigendom |
| Leasehold | Erfpacht |
| Property in charge of ground lease | Eigendom belast met erfpacht |
| Under leasehold | Ondererfpacht |
| Building rights | Opstal |
| Property in charge of building | Eigendom belast met opstal |
| Ground lease and building | Erfpacht en opstal |
| Property in charge of ground lease and building | Eigendom belast met erfpacht en opstal |
| Constriction rights | Beklemrecht |
| Property in charge of constriction rights | Eigendom belast met beklemrecht |
| City meier right | Stadsmeierrecht |
| Property in charge of city meier right | Eigendom belast met stadsmeierrecht |
| Under Constriction rights | Onderbeklemrecht |
| Usufruct | Vruchtgebruik |
| Property in charge of usufruct | Eigendom belast met vruchtgebruik |
| Use and habitation | Gebruik en bewoning |
| Property in charge of use and habitation | Eigendom belast met gebruik en bewoning |
| Property in charge of restricted rights | Eigendom belast met beperkte rechten |
| Ground lease with usufruct | Erfpacht belast met vruchtgebruik |
| Building rights in charge with usufruct | Opstal belast met vruchtgebruik |
| Ground lease and building rights in charge with usufruct | Erfpacht en opstal belast met vruchtgebruik |
| Constriction rights in charge with usufruct | Beklemrecht belast met vruchtgebruik |
| Ground lease in charge with occupation and habitation | Erfpacht belast met gebruik en bewoning |
| Ground lease in charge with use and habitation | Opstal belast met gebruik en bewoning |
| Ground lease and building rights in charge with use and habitation | Erfpacht en opstal belast met gebruik en bewoning |
| Constriction rights in charge with use and habitation | Beklemrecht belast met gebruik en bewoning |
| See deed | Zie akte |
| Membership rights | Lidmaatschapsrecht |
| Mandelig | Mandelig |
| Right of overhang | Recht van overbouw |
Financial
price
integer example: "350000"
REQUIRED indicates the sales price in euro of the object
| Price | Prijs |
price_type_sale
string
"asking_price",
"purchase_price",
"price_on_request" or
"negotiable_price" indicates the sales price type of the object
| Asking price | Vraagprijs |
| Purchase price | Koopprijs |
| Price on request | Prijs op aanvraag |
| Price negotiable | Prijs n.o.t.k. |
price_vat
boolean "true" or "false" REQUIRED indicated the price incl. or excl. VAT (BTW belast)
acceptance_date
date
"31-12-2020" indicates the acceptance date
| Acceptance date | Datum 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 charged | BTW belast |
| Exclusive building interest | Exclusief bouwrente |
| Tax included | Inclusief BTW |
rental_price
integer example: "1750"
REQUIRED indicates the rental price in euro of the object
| Rental price | Huurprijs |
price_type_rent
string
"Rental price", "Price on request" or"negotiable_price"
indicates the rental price type of the object
| Rental price | Huurprijs |
| Price on request | Prijs op aanvraag |
| Price negotiable | Prijs n.o.t.k. |
rental_condition
string
"monthly", "yearly" or"yearly_per_meter"
REQUIRED indicates the rental price condition in euro of the object
| Monthly | Per maand |
| Yearly | Jaarlijks |
| Per m2 / per year | Per m2 / per jaar |
service_costs
integer example: "60"
indicates the monthly service costs in euro of the object
| Service costs | Servicekosten |
service_costs_period
string
"monthly",
"yearly" or
"yearly_per_meter" indicates the service costs period in euro of the object
| per month | per maand |
| per year | per jaar |
| Per m2 / per year | per m2 / per jaar |
service_costs_vat
boolean "true" or "false" indicates if there the service costs are VAT included (BTW belast)
Business object categories
string "office","retail","space","land","area","chr","other","leisure","investment" or"public"
REQUIRED indicates main category type of the business object:
| Office space | Kantoorruimte |
| Retail space | Winkelruimte |
| Business space | Bedrijfsruimte |
| Building land | Bouwgrond |
| Paved outdoor area | Verhard buitenterrein |
| CHR | Horeca |
| Other | Overige |
| Leisure | Leisure |
| Investment | Belegging |
| Public real estate | Maatschappelijk 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 space | Kantoorruimte |
| Retail space | Winkelruimte |
| Business space | Bedrijfsruimte |
| Building land | Bouwgrond |
| Paved outdoor area | Verhard buitenterrein |
| CHR | Horeca |
| Other | Overige |
| Leisure | Leisure |
| Investment | Belegging |
| Public real estate | Maatschappelijk 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
"100" within "chr" the "size" indicates the size (surface) of chr in m2
| Size | Oppervlakte |
array "chr"
sales_floor_area
integer
"60" within "chr" the "sales_floor_area" indicates the sales floor area (surface) of chr in m2
| Sales floor area | Verkoop 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 floor | Gelegen 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
| Drenthe | Drenthe |
| Flevoland | Flevoland |
| Friesland | Friesland |
| Gelderland | Gelderland |
| Groningen | Groningen |
| Limburg | Limburg |
| Noord-Brabant | Noord-Brabant |
| Noord-Holland | Noord-Holland |
| Overijssel | Overijssel |
| Utrecht | Utrecht |
| Zeeland | Zeeland |
| Zuid-Holland | Zuid-Holland |
| Amsterdam | Amsterdam |
| Den Haag | Den Haag |
| Rotterdam | Rotterdam |
| Utrecht (stad) | Utrecht (stad) |
| Hollands-Utrechtsemeren | Hollands-Utrechtsemeren |
| Ijsselmeerkust | Ijsselmeerkust |
| Noordzeebadplaatsen | Noordzeebadplaatsen |
| Utrechtse Heuvelrug ’t Gooi | Utrechtse Heuvelrug ’t Gooi |
| Veluwe en Veluwerand | Veluwe en Veluwerand |
| Waddeneilanden | Waddeneilanden |
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
"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 sector | Drankensector |
| Fast food sector | Fastfoodsector |
| Restaurant sector | Restaurantsector |
| Hotel sector | Hotelsector |
array "chr"
beverage
multi
"cafe","bistro","disco","hall_center"
within "chr" the "sector" indicates the "beverage" sector (Drankensector)
| Cafe | Café |
| Bistro | Eetcafé |
| Disco | Discotheek |
| (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, restaria | Cafetaria, restaria |
| Lunchroom, sandwich shop | Lunchroom, broodjeszaak |
| Ice cream parlor | Ijssalon |
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 hotel | Luxe hotel |
| Congress hotel | Congreshotel |
| Hotel garni | Hotel-garni |
array "chr"
hotel_rooms
integer
"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 rooms | Aantal 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 restaurant | Bistro, petit-restaurant |
| Cafe Restaurant | Café-restaurant |
| Luxury restaurant | Luxe restaurant |
| Roadside restaurant | Wegrestaurant |
| Chinese Indian restaurant | Chinees-Indisch restaurant |
| Pancake house / creperie | Pannenkoekenhuis/creperie |
| Restaurant party center | Restaurant-partycentrum |
| Congress hall center | Congres-zalencentrum |
chr_sector_categories
multi "cafeteria",
"cafe_restaurant",
"hull_catering_space",
"day_exploitation",
"bistro",
"hotel",
"lunchroom",
"restaurant",
"road_restaurant",
"halls_party_center",
"investment",
"wellness" if main "category" is "chr" it could contain additional "chr_sector_categories"
| Cafeteria | Cafeteria |
| Cafe Restaurant | Café-restaurant |
| Hull catering space | Casco-horecaruimte |
| Day exploitation | Dagexploitatie |
| Bistro | (Eet)café |
| Hotel | Hotel |
| Lunchroom | Lunchroom |
| Restaurant | Restaurant |
| Road restaurant | Wegrestaurant |
| Hall party center | Zalen/partycentrum |
| Investment | Belegging |
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
| Size | Oppervlakte |
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 from | In units vanaf |
array "office"
deepenings
integer
example: "5"
within "office" the "deepenings" indicates number of deepenings of the office
| Deepenings | Verdiepingen |
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
| Size | Oppervlakte |
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 from | In 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):
| Camping | Camping |
| Bungalow park | Bungalowpark |
| Day recreation | Dagrecreatie |
| Wellness | Wellness |
| Other | Overig |
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 shop | Kampwinkel |
| Electricity | Electra |
| Sewerage | Riolering |
| Catering present | Horeca aanwezig |
| Toilet buildings | Toiletgebouwen |
| Swimming pool | Zwembad |
| Front desk | Receptie |
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 space | Kantoorruimte |
| Retail space | Winkelruimte |
| Business space | Bedrijfsruimte |
| Paved outdoor area | Verhardbuitenterrein |
| CHR | Horeca |
| Leisure | Leisure |
| Public real estate | Maatschappelijkvastgoed |
| Living space | Woonruimte |
| Building land | Grond |
| Agricultural business | Agrarischbedrijf |
| Other | Overig |
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 space | Bedrijfsruimte |
| Office space | Kantoorruimte |
| CHR | Horeca |
| Other | Overige |
| Retail space | Winkelruimte |
volume
integer
"3000" Note: if "land" is present it could include the following tag "volume" (Bouwvolume):
| Built volume | Bouwvolume |
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 institution | Zorg instelling |
| Sport institution | Sport instelling |
| Cultural Institution | Culturele instelling |
| Religious Institution | Religieuze Instelling |
| Educational institution | Onderwijs 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 box | Garagebox |
| Practice space | Praktijkruimte |
array "other"
size
integer
example: "80"
within "other" the "size" indicates the size (surface) of the surface in m2
| Size | Oppervlakte |
array "other"
deepenings
integer
example: "1"
within "other" the "deepenings" indicates number of deepenings
| Deepenings | Verdiepingen |
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 available | Woonruimte aanwezig |
| Living space possible | Woonruimte mogelijk |
object_situation
string "indoor",
"extension" or
"detached" REQUIRED if residential object is present
| Indoor | Inpandig |
| Extension | Aanbouw |
| Detached | Vrijstaand |
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.
Energy class
energy_class
string
"A+++++",
"A++++",
"A+++",
"A++",
"A+",
"A",
"B",
"C",
"D",
"E",
"F" or
"G" indicates the energy class of the object
| A+++++ | A+++++ |
| A++++ | A++++ |
| A+++ | A+++ |
| A++ | A++ |
| A+ | A+ |
| A | A |
| B | B |
| C | C |
| D | D |
| E | E |
| F | F |
| G | G |
energy_index
string
example: "1.78"
indicates the energy class index of the object
| Energy index | Energie index |
Construction
boolean
"true" or "false" REQUIRED indicates if object is a new construction
| New construction | Nieuwbouw |
integer "1997" indicates the build year of the object in YYYY
| Build year | Bouwjaar |
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 period | Bouwperiode |
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)
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
"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"
}
]
"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
"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)
panorama_viewer
string
"https:/app.pyber.nl/objects/45539/panorama-viewer" absolute url of the panorama / virtual tour of the object (if multiple images are uploaded, this will be automatically combined within the panorama viewer)
external_panoramas
string
"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
