Skip to content

Index volume

robert-valueguard edited this page Aug 5, 2024 · 8 revisions

Get index area volume

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

import valueguard

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


print(vgClient.index_volume(search_criteria={
    "id":701019009000044,
    "valid_at":2022-06-05
}))

Field list

Field name Description Example
id Index id 701019009000044
valid_from Valid from date 2022-06-01
valid_to Valid to date 2022-06-30
volume Total volume for the index 1070.0

Search criteria fields

Field name Description Example
id Index id 701019009000044

Optional search criteria fields

Field name Description Example
valid_at A date that is included in the desired time span 2022-06-05

Raw public index request

Get

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