Specificatie wonen

Details of the JSON specification used by Pyber to export residetial object details to other systems or websites.

This page details the specification of an JSON feed to export property information.

Update 09-01-2023:

Financial section:
Rental lot feature tags has been added: “rental_lot”, “rental_lot_price” & “rental_lot_condition”

In order to get data page by page limit and offset can be used. Limit will limit number of records in one response. Offset will offset requested records.
This parameters can be set via url arguments.

For example:
https://app.pyber.nl/export/objects/9872ed9fc22fc182d371c3e9ed316094?offset=0&limit=10
https://app.pyber.nl/export/objects/9872ed9fc22fc182d371c3e9ed316094?offset=10&limit=10

				
					<?php

$url = 'https://app.pyber.nl/export/objects/9872ed9fc22fc182d371c3e9ed316094';

function get_data($url) {
    $handler = curl_init();

    curl_setopt($handler, CURLOPT_URL, $url);
    curl_setopt($handler, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($handler, CURLOPT_USERAGENT, 'Pyber Client');

    $response = curl_exec($handler);

    curl_close($handler);

    return json_decode($response, true);
}

$start = microtime(true);

$limit = 10;
$offset = 0;
$requests = 0;

do {
    $requestUrl = "{$url}?offset={$offset}&limit={$limit}";
    
    echo "Requesting {$requestUrl}...\n";
    
    $data = get_data($requestUrl);
    
    $requests += 1;
    $offset += $limit;
} while (count($data) == $limit);

$finish = microtime(true);
$spent = $finish - $start;

print_r([
    'requests' => $requests,
    'spent' => $spent
]);

echo "\n";

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.

Field name

Type

Values

Description

General fields

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:

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

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)

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

commercial_manager_main_phone

string

example: "+31850201615"

primary telephone incl. landcode of the responsible agent (optional)

commercial_manager_whatsapp

string

example: "+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

locations

multi

"At the edge of the forest", "On water", "On park", "On busy road", "On a quiet road", "In the center", "In residential district", "Unobstructed view", "Sheltered location", "Open location", "Outside the built-up area", "Sea View", "Business area", "On waterway", "In wooded surroundings", "Rural location"

location area of the object

At the edge of the forest	aan bosrand
On water	aan water
On park	aan park
On busy road	aan drukke weg
On a quiet road	aan rustige weg
In the center	in centrum
In residential district	in woonwijk
Unobstructed view	vrij uitzicht
Sheltered location	beschutte ligging
Open location	open ligging
Outside the built-up area	buiten bebouwde kom
On waterway	aan vaarwater
Sea view	Zeezicht
Business area	Bedrijventerrein
In wooded surroundings	in bosrijke omgeving
Rural location	landelijk gelegen

views

multi

"sea", "garden", "skyline", "yard", "street", "mountains", "forest", "city"

object views

sea	zee
garden	tuin
skyline	skyline
yard	achtertuin
street	straat
mountains	bergen
forest	bos
city	stad

living_styles

multi

"energy_efficient",
"by_the_water",
"ground_floor",
"wooded_area",
"with_garage",
"child_friendly_neighborhood",
"special_properties",
"rural_location",
"in_the_centre",
"starter_homes",
"diy_homes",
"design_homes",
"peaceful_living",
"with_swimming_pool",
"monument",
"home_office",
"luxury_homes",
"ready_to_move_in"

Living style(s) (Woonstijlen)

Energiezuinig	Energy efficient
Aan het water	By the water
Gelijkvloers	Ground floor
Bosrijke omgeving	Wooded area
Met garage	With garage
Kindvriendelijke buurt	Child friendly neighborhood
Bijzondere woningen	Special properties
Landelijk gelegen	Rural location
In het centrum	In the centre
Starterswoningen	Starter homes
Kluswoningen	DIY homes
Design woningen	Design homes
Rustig wonen	Peaceful living
Met zwembad	With swimming pool
Monument	Monument
Kantoor aan huis	Home office
Luxe woningen	Luxury homes
Instapklaar	Ready to move in

gated_community

boolean

"true" or "false"

indicates if object is within a gated community

Gated community

Resort

Land registries

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

Kadastrale gegevens

municipality

string

example: "Lelystad"

municipality of the land

Municipality

Gemeente

municipality_code

string

example: "LLS00"

municipality code of the land

Municipality code

Gemeente code

section

string

example: "A1"

section of the land

Section

Sectie

plot_number

string

example: "321E"

plot number of the land

Plot number

Perceelnummer

surface

integer

example: "150"

indicates the plot surface in m² 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" or "price_on_request"

indicates the sales price type of the object

Asking price	Vraagprijs
Purchase price	Koopprijs
Price on request	Prijs op aanvraag

acceptance

string

"tax_charged", "exclusive_building_interest" or "tax_included"

indicates the acceptance (aanvaarding)

In consultation	In overleg
By date	Per datum
Directly	Direct

acceptance_date

date

example: "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

price_specification

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" or "Price on request"

indicates the rental price type of the object

Rental price	Huurprijs
Price on request	Prijs op aanvraag

rental_condition

string

"monthly" or "yearly"

REQUIRED indicates the rental price condition in euro of the object

Monthly	Per maand
Yearly	Jaarlijks

renter_costs

integer

example: "1000"

indicates the renter costs in euro of the object

Costs renter

Kosten huurder

deposit

integer

example: "2000"

indicates the deposit in euro of the object

Deposit

Waarborgsom

availability

string

"permanent" or "temporarily"

indicates the rental availability of the object

Permanent	Permanent
Temporarily	Tijdelijk

available_from

date

example: "31-12-2020"

indicates the availability date of the rental object

Available from

Beschikbaar vanaf

rented_till

date

example: "31-12-2022"

indicates the availability date of the rental object

Rented till

Verhuurd tot

min_contract_length

integer

example: "12"

indicates the minimum rental contract length in months

Min. contract length

Minimale huurtermijn (in maanden)

rent_includes

multi

"Gas", "Water", "Energy", "Television", "Internet", "Service costs"

indicates the included rental services

Gas	Gas
Water	Water
Energy	Energie
Television	Televisie
Internet	Internet
Service costs	Servicekosten

rental_price_specification

multi

"tax_charged", "indexed", "furnished", "including_service_costs", "excluding_service_costs", "upholstered"

indicates the rental price specification

Tax charged	BTW belast
Indexed	Geïndexeerd
Furnished	Gemeubileerd
Including service costs	Inclusief servicekosten
Excluding service costs	Exclusief servicekosten
Upholstered	Gestoffeerd

contract_length

integer

example: "24"

indicates the fixed rental contract length in months

Contract length

Huurtermijn (in maanden)

service_costs

integer

example: "60"

indicates the monthly service costs in euro of the object

Service costs

Servicekosten

owners_contribution_community

integer

example: "60"

indicates the monthly community of owners contribution costs in euro of the object

Community of owners contribution

Bijdrage VVE

pets_allowed

boolean

"true" or "false"

indicates if there are pets allowed

Pets allowed

Huisdieren toegestaan

holiday_rental

boolean

"true" or "false"

indicates if object is a holiday rental

Holiday rental

Vakantieverhuur

investment

boolean

"true" or "false"

indicates if object is an investment object

Investment property

Beleggingsobject

rental_lot

boolean

"1" or "0" (true or false)

indicates if object has a rental lot

Rental lot

Huurkavel

rental_lot_price

integer

example: "1000"

indicates the price of the rental lot

Price

Prijs

rental_lot_condition

string

"monthly" or "yearly"

indicates the price condition of the rental lot

Monthly	Per maand
Yearly	Per jaar

Object categories & types

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

new_construction

boolean

"true" or "false"

REQUIRED indicates if object is a new construction

New construction

Nieuwbouw

build_year

integer

example: "1997"

indicates the build year of the object in YYYY

Build year

Bouwjaar

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 period

Bouwperiode

living_space

integer

example: "145"

indicates the living space in m² of the object

Living space

Woonoppervlakte

volume

integer

example: "280"

indicates the volume of the living space in m³ of the object

Volume

plot_surface

integer

example: "550"

indicates the plot surface in m² of the object

Plot surface

Perceeloppervlakte

other_indoor_space

integer

example: "12"

indicates the other indoor space in m² of the object

Other indoor space

Overige inpandige ruimte

external_storage

integer

example: "20"

indicates external storage space in m² of the object

External storage

Externe bergruimte

rooms

integer

example: "3"

indicates the total number of rooms of the object

Rooms

Kamers

bedrooms

integer

example: "2"

indicates the total number of bedrooms of the object

Bedrooms

Slaapkamers

roof

string

"Saddle roof", "Flat roof", "Pent roof", "Mansard roof", "Hipped roof", "Composed roof", "Gambrel roof" or "Tent roof"

indicates the rooftype of the object

Saddle roof	Zadeldak
Flat roof	Plat dak
Pent roof	Lessenaardak
Mansard roof	Mansarde dak
Hipped roof	Dwarskap
Composed roof	Samengesteld dak
Gambrel roof	Schilddak
Tent roof	Tentdak

roof_material

multi

"Slate", "Thatch", "Asbestos", "Plastic", "Tiles", "Bituminous roofing", "Metal", "Other material"

indicates the roof material(s) of the object

Slate	Leisteen
Thatch	Riet
Asbestos	Asbest
Plastic	Kunststof
Tiles	Pannen
Bituminous roofing	Bitumineuze dakbekleding
Metal	Metaal
Other material	Overig

specialities

multi

"Monumental building",
"Monument",
"Upholstered",
"Partly upholstered",
"Partly rented",
"Furnished",
"Double occupancy possible",
"Double occupancy present",
"Protected city or village view",
"Accessible to the elderly",
"Accessible for the disabled",
"Fixer-upper"

indicates the specialities of the object

Monumental building	Monumentaal pand
Monument	Monument
Upholstered	Gestoffeerd
Partly upholstered	Gedeeltelijk gestoffeerd
Partly rented	Gedeeltelijk verhuurd
Furnished	Gemeubileerd
Double occupancy possible	Dubbele bewoning mogelijk
Double occupancy present	Dubbele bewoning aanwezig
Protected city or village view	Beschermd stads- of dorpsgezicht
Accessible to the elderly	Toegankelijk voor ouderen
Accessible for the disabled	Toegankelijk voor gehandicapten
Fixer-upper	Kluswoning

Garden

garden

multi

example:"garden": [ "Backyard", "Front yard", "Side garden", "Garden around", "Patio/atrium", "Place", "Sun terrace" ],

indicates garden types in array (multiple options possible)

Backyard	Achtertuin
Front yard	Voortuin
Side garden	Zijtuin
Garden around	Tuin rondom
Patio/atrium	Patio/atrium
Place	Plaats
Sun terrace	Zonneterras

garden_quality

string

"To apply", "Neglected", "Normal", "Beautifull laid out", "Looked after" or "Laid out under architecture"

indicates garden quality

To apply	Aan te leggen
Neglected	Verwaarloosd
Normal	Normaal
Beautifull laid out	Fraai aangelegd
Looked after	Verzorgd
Laid out under architecture	Aangelegd onder architectuur

garden_position

string

"North", "Northeast", "East", "Southeast", "South", "Southwest", "West" or "Northwest"

indicates the position of the garden

North	Noord
Northeast	Noordoost
East	Oost
Southeast	Zuidoost
South	Zuid
Southwest	Zuidwest
West	West
Northwest	Noordwest

garden_length

integer

example: "800"

indicates the length (in cm) of the garden

Length

Lengte (hoofdtuin)

garden_width

integer

example: "500"

indicates the width (in cm) of the garden

Width

Breedte (hoofdtuin)

garden_surface

integer

example: "40"

indicates the surface (in m²) of the garden

Surface

Oppervlakte (hoofdtuin)

garden_total_surface

integer

example: "55"

indicates the total surface (in m²) of all the gardens combined

Total surface

Totale oppervlakte

Storage

storage

string

"Built stone", "Built wood", "Detached stone", "Detached wood", "Indoor", "Box" or "Freestanding plastic"

indicates the storage (berging / schuur)

Built stone	Aangebouwd steen
Built wood	Aangebouwd hout
Detached stone	Vrijstaand steen
Detached wood	Vrijstaand hout
Indoor	Inpandig
Box	Box
Freestanding plastic	Vrijstaand kunststof

storage_total_amount

integer

example: "1"

indicates the total storages

Total amount

Totaal aantal

storage_facilities

multi

"Equipped with heating", "Equipped with electricity", "Equipped with water", "With attic"

indicates the storage facilities (voorzieningen)

Equipped with heating	Voorzien van verwarming
Equipped with electricity	Voorzien van elektra
Equipped with water	Voorzien van water
With attic	Met vliering

storage_insulation

multi

"Roof insulation",
"Wall insulation",
"Floor insulation",
"Double glass",
"Partially double glass",
"Sashes",
"Completely insulated",
"No cavity",
"Eco-building",
"No insulation"

indicates the storage insulations (isolatie)

Roof insulation	Dakisolatie
Wall insulation	Muurisolatie
Floor insulation	Vloerisolatie
Double glass	Dubbel glas
Partially double glass	Gedeeltelijk dubbel glas
Sashes	Voorzetramen
Completely insulated	Volledig geïsoleerd
No cavity	Geen spouw
Eco-building	Eco-bouw
No insulation	Geen isolatie

Garage & Parking

garage_capacity

integer

example: "2"

indicates the garage capacity

Capacity

Capaciteit

garage_total_amount

integer

example: "1"

indicates the total amount of garages

Total garages

Totaal aantal garages

garage_length

integer

example: "600"

indicates the length of the garage (in cm)

Length

Lengte

garage_width

integer

example: "800"

indicates the width of the garage (in cm)

Width

Breedte

garage_surface

integer

example: "48"

indicates the surface of the garage (in m²)

Surface

Oppervlakte

garage_services

multi

"Equipped with heating", "Equipped with electricity", "Equipped with water", "With attic", "With electric door"

indicates the garage facilities (voorzieningen)

Equipped with heating	Voorzien van verwarming
Equipped with electricity	Voorzien van elektra
Equipped with water	Voorzien van water
With attic	Met vliering
With electric door	Met elektrische deur

garage_insulation

multi

"Roof insulation",
"Wall insulation",
"Floor insulation",
"Double glass",
"Partially double glass",
"Sashes",
"Completely insulated",
"No cavity",
"Eco-building",
"No insulation"

indicates the garage insulations (isolatie)

Roof insulation	Dakisolatie
Wall insulation	Muurisolatie
Floor insulation	Vloerisolatie
Double glass	Dubbel glas
Partially double glass	Gedeeltelijk dubbel glas
Sashes	Voorzetramen
Completely insulated	Volledig geïsoleerd
No cavity	Geen spouw
Eco-building	Eco-bouw
No insulation	Geen isolatie

parking_facilities

multi

"Public parking",
"Paid parking",
"Parking garage",
"Parking permits",
"On own terrain",
"On closed ground"

indicates the parking facilities (Parkeerfaciliteiten)

Public parking	Openbaar parkeren
Paid parking	Betaald parkeren
Parking garage	Parkeergarage
Parking permits	Parkeervergunningen
On own terrain	Op eigen terrein
On closed ground	Op afgesloten terrein

parking_capacity

integer

example: "2"

indicates the parking capacity

Parking capacity

Parkeer capaciteit

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)

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.

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)

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", "type": "Bedroom", }, { "id": 274929, "sort": 2, "url": "https://domain.com/object/2781512586.jpg", "type": "Bathroom", }, { "id": 274930, "sort": 3, "url": "https://domain.com/object/3412723251.jpg", "type": "Guest room", }, { "id": 274931, "sort": 4, "url": "https://domain.com/object/3445401687.jpg", "type": "Kitchen", } ]

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

type

string

example: "Bedroom", "Bathroom", "Guest room", "Other", "Kitchen", "Hall", "Living room", "Garage", "Yard", "Street view", "Balcony", "Terrace", "Office", "Hobby room", "Parking", "Lounge room", "Attic", "Landing", "Scullery", "Salvage"

indicates the type (short description) of the image

Bedroom	Slaapkamer
Bathroom	Badkamer
Guest room	Kamer
Other	Overig
Kitchen	Keuken
Hall	Hal
Living room	Woonkamer
Garage	Garage
Yard	Tuin
Street view	Straat
Balcony	Balkon
Terrace	Terras
Office	Kantoor
Hobby room	Hobbykamer
Parking	Parkeerplaats
Lounge room	Lounge
Attic	Zolder
Landing	Overloop
Scullery	Bijkeuken
Salvage	Berging

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

Single-family house	Eengezinswoning
Mansion	Herenhuis
Villa	Villa
Country house	Landhuis
Bungalow	Bungalow
Farmhouse	Woonboerderij
Canal house	Grachtenpand
Houseboat	Woonboot
Mobile home	Stacaravan
Caravan	Woonwagen
Estate	Landgoed

Top floor	Bovenwoning
Ground floor apartment	Benedenwoning
Duplex	Maisonnette
Gallery flat	Galerijflat
Porch flat	Portiekflat
Ground floor flat + top floor	Beneden + bovenwoning
Penthouse	Penthouse
Gatehouse	Portiekwoning
Dorm room	Studentenkamer
Double ground floor apartment	Dubbel benedenhuis
Mezzanine	Tussenverdieping

Indoor garage	InpandigeGarage
Garage	Garage
Parking garage	Parkeer kelder
Parking place	Parkeerplaats / Capaciteit
Salvage	Berging
Trailer park location	Woonwagenstandplaats
Mobile home pitch	Stacaravanstandplaats
Berth	Ligplaats
Bottom part	Onderstuk
Storage space	Opslagruimte

Detached house	Vrijstaande woning
Townhouse	Geschakelde woning
Semi-detached house	2-onder-1-kapwoning
Terraced house	Tussenwoning
Corner house	Hoekwoning
End house	Eindwoning
Half detached house	Halfvrijstaande woning
Switched semi-detached house	Geschakelde 2-onder-1-kapwoning
Staggered	Verspringend

Docs

Specificatie wonen

Details of the JSON specification used by Pyber to export residetial object details to other systems or websites.

Table of Contents

Field name

Type

Values

Description

General fields

Open house

Commercial manager

Address & location

Land registries

Financial

Object categories & types

Energy class

Construction

Garden

Storage

Garage & Parking

Descriptions

Custom descriptions (SEO purposes)

Media

Volg ons

House	Woonhuis
Apartment	Appartement
Building land	Bouwgrond
Other	Overig OG