A module for implementing a base class for Udalmap.

class udalmap.base.UdalMap(timeout=None)

Implement all available GET queries in Udalmap API.

timeout

Timeout for requests, in seconds

Type:

float, optional

group(groupId, **kwargs)

Get a group.

Parameters:

• groupId (str) – The id number of the group

• **kwargs – lang: {“SPANISH”, “BASQUE”} summarized: {“false”, “true”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

group_subgroups(groupId, **kwargs)

Find all subgroups of a group.

Parameters:

• groupId (str) – The id number of the group

• **kwargs – lang: {“SPANISH”, “BASQUE”} summarized: {“false”, “true”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

groups(**kwargs)

Find all groups.

Parameters:

**kwargs – lang: {“SPANISH”, “BASQUE”} summarized: {“false”, “true”}

Returns:

Representation of the JSON returned from the API.

Return type:

list of dict

indicator_data(indicatorId, **kwargs)

Get an indicator data.

Parameters:

• indicatorId (str) – The id number of the indicator

• **kwargs – lang: {“SPANISH”, “BASQUE”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

indicator_entities_data(indicatorId, **kwargs)

Get indicators’ data for all entities.

Parameters:

• indicatorId (str) – The id number of the indicator

• **kwargs – lang: {“SPANISH”, “BASQUE”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

indicator_entity_data(indicatorId, entityId, **kwargs)

Get indicator data of an entity.

Parameters:

• indicatorId (str) – The id number of the indicator

• entityId (str) – The id number of the entity

• **kwargs – lang: {“SPANISH”, “BASQUE”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

indicator_municipalities_data(indicatorId, **kwargs)

Get indicators’ data for all municipalities.

Parameters:

• indicatorId (str) – The id number of the indicator

• **kwargs – lang: {“SPANISH”, “BASQUE”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

indicator_municipality_data(indicatorId, municipalityId, **kwargs)

Get indicator data of a municipality.

Parameters:

• indicatorId (str) – The id number of the indicator

• municipalityId (str) – The id number of the municipality

• **kwargs – lang: {“SPANISH”, “BASQUE”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

indicator_region_data(indicatorId, regionId, **kwargs)

Get indicator data of a region.

Parameters:

• indicatorId (str) – The id number of the indicator

• regionId (str) – The id number of the region

• **kwargs – lang: {“SPANISH”, “BASQUE”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

indicator_regions_data(indicatorId, **kwargs)

Get indicators’ data for all regions.

Parameters:

• indicatorId (str) – The id number of the indicator

• **kwargs – lang: {“SPANISH”, “BASQUE”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

indicators(**kwargs)

Find all indicators.

Parameters:

**kwargs – lang: {“SPANISH”, “BASQUE”}

Returns:

Representation of the JSON returned from the API.

Return type:

list of dict

municipality_indicators_data(municipalityId, **kwargs)

Find indicators’ data for a municipality.

Parameters:

• municipalityId (str) – The id number of the municipality

• **kwargs – lang: {“SPANISH”, “BASQUE”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

subgroup(subgroupId, **kwargs)

Get a subgroup.

Parameters:

• subgroupId (str) – The id number of the subgroup

• **kwargs – lang: {“SPANISH”, “BASQUE”} summarized: {“false”, “true”}

Returns:

Representation of the JSON returned from the API.

Return type:

dict

subgroup_indicators(subgroupId, **kwargs)

Find all indicators of a subgroup.

Parameters:

• subgroupId (str) – The id number of the subgroup

• **kwargs – lang: {“SPANISH”, “BASQUE”} summarized: {“false”, “true”}

Returns:

Representation of the JSON returned from the API.

Return type:

list of dict

subgroups(**kwargs)

Find subgroups of all groups.

Parameters:

**kwargs – lang: {“SPANISH”, “BASQUE”} summarized: {“false”, “true”}

Returns:

Representation of the JSON returned from the API.

Return type:

list of dict