Skip to content
robert-valueguard edited this page May 15, 2024 · 9 revisions

Get ads

The code below gives an example of how to use the client to get ads.

import valueguard

vgClient = valueguard.Client()
vgClient.authenticate("<username>", "<password>")

print(vgClient.ads(search_criteria={
    "id":"2342342"
}))

Field list

Field name Description Example
id Ad id 324234
residential_registry_id Residential registry id unique id (serial number) for all residences
source: Valueguard
street Street name in address 1:a villagatan
number Street number in address 1
letter Letter after street number in address, if any A
rooms Number of rooms 5
living_area Area of residence in sqm 137
construction_year Year it was built 1920
ancillary_area Ancillary area in sqm, not part of the primary building area 23
category Apartment for apartments, house for detached houses, town houses etc. apartment
price Last price on the ad 1900000
monthly_fee Monthly fee 3654
error_code 1 = suspected error in data
0 = no suspected error in data
0
firm Firm notar
active That the ad is currently active True
has_pdf If the ad has and pdf snapshot True
registered_date When the ad was registered 2012-03-23
delete_date When the ad was removed 2017-03-23
url Url of ad https://webpage.se/ad/2
rt90x X-coordinate (longitude) from RT90.
a Swedish positioning system by LMV used before 2007
6586700
rt90y Y-coordinate (latitude) from RT90.
a Swedish positioning system by LMV used before 2007
1367905

Search criteria fields

Field name Description Example
category Category of residence apartment
id Ad id 12312312
residential_registry_id Residential registry id 481515
active That the ad is currently active True
has_pdf If the ad has and pdf snapshot True
firm Firm notar

Raw request

Get

curl https://api.valueguard.se/v1/ads?access_token={access_token}&id={id}

Clone this wiki locally