Skip to content
Adrian Gortzak edited this page Aug 18, 2022 · 25 revisions

The code below gives an example of how to use the client to get area data

import valueguard

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

print(vgClient.areas(search_criteria={
"name":"Huddinge"
}))

Field list

Field name Description Example
name Name of area Huddinge
id ID of area 6
key Key of area 0126
category_id ID of category 1
category_name Name of category municipality

Search criteria fields

Field name Description Example
ids ID of areas {1,2,3}
category_ids ID of categories {1,2,3}
names names of areas Vallentuna

Raw request

Get

curl https://api.valueguard.se/v1/area?access_token={access_token}&ids={id}
Clone this wiki locally