Developers

Investment calculation

Integrating the investment calculation is simply placing this snippet on your website. Please make sure that the form and its fields are hidden and that this form will be submitted right after the page is ready.

Documentation

Key	Description	Required
version	Here you can specify the version number of the integration. By default, the latest version will be taken if not specified. The latest version is 1.0	No
api_key	This is your api_key you'll receive from Investr.	Yes
reference	This is the reference of the property. This is useful when statistics are requested for one specific property.	Yes
price	The purchase price of the property. This should be an integer. If you have a price_construction and a price_land parameter set, this sum should be the purchase price.	Yes
title	A title you want to give to the property.	Yes
description	A description you want to give to the property.	No
image	An HTTP link to the image. Like: https://www.yourdomain.com/image.jpg	Yes
price_construction	Construction value of the property. This field is required when the value of new_building is 1 for Belgium.	No
price_land	Land value of the property. This field is required when the value of new_building is 1 for Belgium.	No
ground_lease	Ground lease value of the property. This field is required when the value of new_building is 1 for Belgium.	No
cadastrall_income	Cadastrall income value of the property.	No
garage_cost	The garage cost.	No
extra_cost	The extra costs.	No
gross_rent_profit	The gross rent profit of the property per month. * Investr will predict the gross_rent_profit when you set land_area, surface_livable, number_of_bedrooms, is_renovated or cadasrall_income. Only available for Belgium.	Yes*
land_area	The total land area of the property in square meters. When the property is an apartment and surface_livable is provided, land_area will have the same value as surface_livable.	No
surface_livable	The total livable surface of the property in square meters.	No
property_tax	The monthly property tax. Is only available for Spain.	No
syndicate_costs	The monthly syndicate costs. Is only available for Spain.	No
number_of_bedrooms	The number of bedrooms the property contains.	No
property_type_id	This is an ID from the list below: 1: Detached House 2: Terraced House 3: Semi-detached House 4: Flat 5: Land 6: Service Flat 7: Room 8: Garage 9: Parking 10: Other 11: Catering 12: Office 13: Industry 14: Shop 15: Other Professional 16: Professional Land 17: Hotel Real Estate 18: Investment Property 19: Student Housing	Yes
new_building	This boolean indicates if this property is new. 1 = new property, 0 = existing property When this value is 1, you must fill in price_construction and price_land.	Yes
is_renovated	This boolean indicates if this property is renovated. 1 = is renovated, 0 = is not renovated	No
construction_year	The year that the property was built.	No
vat_percentage	If you need to pay VAT on the total price of a property, you have to fill in the vat_percentage field. Example: 0.21 Don't fill in this property when you have set vat_percentage_on_construction or registration_rights_percentage.	No
vat_percentage_on_construction	If you need to pay VAT on the construction price of a property, you have to fill in the vat_percentage_on_construction field. Example: 0.21 Don't fill in this property when you have set vat_percentage.	No
registration_rights_percentage	If there is a specific percentage for the registration rights, you have to fill in the registration_rights_percentage field. Example: 0.21 Don't fill in this property when you have set vat_percentage.	No
address_street	This is the street address of the property.	No
address_number	This is the house number of the property.	No
address_bus_number	This is the bus number of the property.	No
address_city	This is the city address of the property.	Yes
address_zip_code	This is the zip code of the property.	Yes
country_code	BE: België NL: Nederland FR: France ES: Spain	Yes