Skip to content

Index statistics

Adrian Gortzak edited this page Nov 4, 2021 · 2 revisions

Get index statistics public

The code below gives an example of how to use the client to get public index statistics.

import valueguard

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


print(vgClient.index_statistics(search_criteria={
    "id":701019009000044
}, public=True))

Field list

Field name Description Example
id index id 701019009000044
name index name HOX Sverige
annual_highest_value annual highest index value 290.36
annual_lowest_value annual lowest index value 270.18
reference_date index reference date 2005-01-15
reference_value index reference value 100.0
average_date last index value's average date 2021-09-15
publishing_date last index value's publishing date 2021-10-21 06:00:00.0
value last index value 290.36
recent_month_change recent month procentage change 0.3
recent_month_trend recent month trend equal
three_month_change three month procentage change 1.1
three_month_trend three month trend up
twelve_month_change twelve month procentage change -12.4
twelve_month_trend twelve month trend down

Search criteria fields

Field name Description Example
id Index id 701019009000044

Public index

Index id Index name
110001800403 HOX Flats Stockholm
110012800403 HOX Flats Malmoe
110014800403 HOX Flats Gothenburg
110090000421 HOX Flats Medium Cities Sweden
110099990421 HOX Flats Sweden
701012009000044 HOX Houses Sweden
701012009999044 HOX Houses Medium Cities Sweden
201012007191044 HOX Malmö Villa
201012007211044 HOX Göteborg Villa
701012007011044 HOX Stockholm Villa
701019009000044 HOX Sverige

Raw public index request

Get

curl https://api.valueguard.se/v1/index/statistics/public?id={id}
Clone this wiki locally