Skip to content

Best index

davidmagnussonvalueguard edited this page Dec 1, 2022 · 4 revisions

Best index

The code below gives an example of how to use the client to get the best index

import valueguard

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


print(vgClient.index_best(search_criteria={
    "wgs84lat": 59.864908174031974,
    "wgs84lon": 17.648463519218435,
    "category": "apartment"
}))

Field list

Field name Description Example
index_id Index id 110001800403

Required search criteria fields

Field name Description Example
wgs84lat Y-coordinate (latitude) from WGS84.
a global positioning system
59.864908174031974
wgs84lon X-coordinate (longitude) from WGS84.
a global positioning system
17.648463519218435
category Category of residence apartment or house

Raw request

Get

curl https://api.valueguard.se/v1/index/best?access_token={access_token}&wgs84lat={wgs84lat}&wgs84lon={wgs84lon}&category={category}
Clone this wiki locally