ResidentialRegistry

Description

THIS DOCUMENTATION IS UNDER DEVELOPMENT, BUT WE THINK MOST THINGS ARE CORRECT NOW! PLEASE LET US KNOW IF YOU HAVE ANY QUESTIONS!

Search parameters

Field name	Type	Example	Description
street_name	varchar(60)	Storgatan	street name in address
street_number	list	[1,3,None]	street number in address
street_suffix	char(5)	A	suffix in address
street_additional_info	varchar(40)	StreetAddress	`street_address` (= most common), `metric_address`, `village_address`, `farm_address`. Note: This information is not necessary
postal_code	varchar(7)	12322	postal code
postal_city	varchar(40)	Stockholm	postal area
unit_number	smallint(4)	1001	unique number on every apartment at the same address

unparsed_address? Needed from the beginning or maybe add later?

Result

Field name	Type	Example	Description	Used for
universal_property_id	varchar(255)	909a6a48-a405-90ec-e040-ed8f66444c3f	unique id (uuid) for all residences	All
unparsed_address	varchar(60)	Storgatan 1A, 12322, Stockholm, lgh 1001	address of the residence (street, nr, letter, postal code, postal area, apartment number (if apartment) )	All
street_name	varchar(60)	Storgatan	street name in address	All
street_number	list	[1,3,None]	street number in address	All
street_suffix	char(5)	A	suffix in address	All
street_additional_info	varchar(40))	StreetAddress	`street_address` (= most common), `metric_address`, `village_address`, `farm_address`. If missing, presume it is a `street_address`	All
postal_code	varchar(7)	12322	postal code	All
postal_city	varchar(40)	Stockholm	postal area	All
unit_number	smallint(4)	1001	unique number on every apartment at the same address	Apartment
property_sub_type	string	'SingleFamilyResidence'	Building structure type of home. Accepted values are 'Apartment', 'SingleFamilyResidence', 'Townhouse', 'Duplex', 'Terraced', 'Cabin', 'Farm', 'Other...', 'Unknown...'	All
occupant_type	string	'Owner'	Ownership type of home. Accepted values are 'Owner', 'TenantOwnership'	All
building_number	mediumint(5)	1	A numeric ID to identify buildings on the same property	All
living_area	decimal	75	Living area of home in square meters	All
rooms_total	decimal	4	Number of rooms in home	Apartment...
year_built	int	1950	Building construction year	All
latitude	decimal	59.405589	Latitude of current residence	All
longitude	decimal	18.323536	Longitude of current residence	All
entry_level	int	2	the floor of the residence i.e. where the entry is	Apartment
stories_total	int	4	the highest floor on the address	Apartment

Note on address

Every street_name is unique within each postal_area. If there is a postal_area in the API call, postal_code is not used. The postal codes in Sweden change frequently, which leads to errors. Postal areas are more stable over time.

Note on property_sub_type

We follow the RESO standard to the largest possible extent. However, the Swedish house types "kedjehus" ('chain house') and "radhus" ('row house') are not separated in the RESO standard. We use 'Terraced' for "kedjehus" and 'Townhouse' for "radhus". The difference is that for a "kedjehus" there is a building, usually a garage, between the houses that is connecting them.

Notes on occupant_type

Many homes are classed as "unknown". Most of them are rentals.
New homes are sometimes "unknown". It might take a while before they get the right classification.
Single family houses that are labeled "unknown" are usually owned by a legal entity
For valuation purposes, a single family house with unknown occupant type can still be valued as if it was owned by a private individual

Model Usage

SDK

import modelmarket as mm
import pandas as pd

mm_client = mm.Client()
# Login
mm_client.authenticate("USER","PASSWORD")

# Perform inference and get the predicted value