Authentication, input and response

Returns the impact of an Energylabel change on sale duration and difference in expected transaction price vs. asking price

POST https://api.altum.ai/energyinsights

Headers

Name
Type
Description

x-api-key*

string

Unique API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)

Content-Type

string

application/json

Request Body

Name
Type
Description

postcode*

string

1234AB

housenumber*

integer

1

houseaddition

string

A

current_energy_label

string

B

target_energy_label*

string

A+++

ecovalue

boolean

1 to receive Ecovalue, default = 0

{
	"current_insights": {
		"stratification": "('B', 'Dorpskern', 'vrijstaand', '1990-2004', '>150')",
		"mean_sales_duration": "124.0",
		"median_sales_duration": "144.0",
		"mean_diff_price": "28733.0",
		"median_diff_price": "42000.0"
	},
	"target_insights": {
		"stratification": "('A', 'Dorpskern', 'vrijstaand', '1990-2004', '>150')",
		"mean_sales_duration": "118.0",
		"median_sales_duration": "118.0",
		"mean_diff_price": "-12375.0",
		"median_diff_price": "-17250.0"
	},
	"delta": {
		"mean_sales_duration": "6.0",
		"median_sales_duration": "26.0",
		"mean_diff_price": "41108.0",
		"median_diff_price": "59250.0",
		"mean_diff_price_percentage": "143.1",
		"median_diff_price_percentage": "141.1",
		"ecovalue": "12872"
	}
}

Request body

Example request

{
  "postcode": "1015GS",
  "housenumber":58,
  "houseaddition": "A1",
  "target_energy_label": "A",
  "ecovalue": 1
}

Last updated