index definitions

The code below gives an example of how to get index definitions from a name like search

import valueguard

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


print(vgClient.index_definitions(search_criteria={
    "name_like":"110001"
}))

print(vgClient.index_definitions(search_criteria={
    "name_like":"uppsala"
}))

Raw response

{'index_definitions':[{
    "id": 110001800403,
    "full_name": "HOX Flats Stockholm",
    "short_name": "Stockholm BR",
    "full_description": "Indexet visar värdeutvecklingen per månad för en genomsnittlig bostadsrätt i Stockholms kommun. Läs mer på http://www.valueguard.se/beskrivning.",
    "short_description": "HOX Index per månad för bostadsrätter i Stockholm (HOXFLATSTO)",
    "version": "4.0.3",
    "quality_id": "5",
    "area_id": "180",
    "house_type": "Bostadsrätter",
    "averaging_period": "1m",
    "ticker": "HOXFLATSTO",
    "averaging_period_nr": "1",
    "rooms": null,
    "year": null,
    "last_publishing_date": "2006-02-11 09:00:00.0",
    "max_i_average_date": "2006-01-15",
    
}, ...]}

Search criteria fields

Field name	Description	Example
name_like	Finds index definitions with (id, short_name, full_name) that is like "name_like"	uppsala

Raw request

Get

curl https://api.valueguard.se/v1/index/definitions?access_token={access_token}&name_like={name_like}