Structural resources¶
Example 1: Get a list of classifications:
from istacpy.structuralresources import classifications
classifications.get_structuralresources_codelists()
Example 2: Get a list of geographic coordinate from Icod de los Vinos:
from istacpy.structuralresources import variables
variables.get_structuralresources_geoinfo('VR_TERRITORIO', 'MUN_ICOD_VINOS')
istacpy.structuralresources.category¶
- istacpy.structuralresources.category.get_structuralresources_categorisations(limit=25, offset=0, query='', orderby='')¶
Get categorisations
This function returns the content from
/v1.0/categorisations
- Parameters
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_categorisations() >>> get_structuralresources_categorisations( ... query="ID EQ 2090", ... orderby="ID ASC" ... )
- istacpy.structuralresources.category.get_structuralresources_categorisations_agency(agencyid, limit=25, offset=0, query='', orderby='')¶
Get categorisations agency
This function returns the content from
/v1.0/categorisations/{agencyID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_categorisations_agency("ISTAC")
- istacpy.structuralresources.category.get_structuralresources_categorisations_agency_resource(agencyid, resourceid, limit=25, offset=0, query='', orderby='')¶
Get categorisations agency resource
This function returns the content from
/v1.0/categorisations/{agencyID}/{resourceID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_categorisations_agency_resource("ISTAC", "cat2")
- istacpy.structuralresources.category.get_structuralresources_categorisations_agency_resource_version(agencyid, resourceid, version)¶
Get categorisations agency resource version
This function returns the content from
/v1.0/categorisations/{agencyID}/{resourceID}/{version}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
version (string) – Specific version of the resource.
Examples
>>> get_structuralresources_categorisations_agency_resource_version( ... "ISTAC", ... "cat2", ... "01.000" ... )
- istacpy.structuralresources.category.get_structuralresources_category_schemes(limit=25, offset=0, query='', orderby='')¶
Get category schemes
This function returns the content from
/v1.0/categoryschemes
- Parameters
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_category_schemes() >>> get_structuralresources_category_schemes( ... query="ID EQ 2090", ... orderby="ID ASC" ... )
- istacpy.structuralresources.category.get_structuralresources_category_schemes_agency(agencyid, limit=25, offset=0, query='', orderby='')¶
Get category schemes agency
This function returns the content from
/v1.0/categoryschemes/{agencyID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_category_schemes_agency( ... "ISTAC", ... query="ID EQ 2090", ... orderby="ID ASC" ...)
- istacpy.structuralresources.category.get_structuralresources_category_schemes_agency_resource(agencyid, resourceid, limit=25, offset=0, query='', orderby='')¶
Get category schemes agency resource
This function returns the content from
/v1.0/categoryschemes/{agencyID}/{resourceID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_category_schemes_agency_resource( ... "ISTAC", ... "TEMAS_CANARIAS" ... )
- istacpy.structuralresources.category.get_structuralresources_category_schemes_agency_resource_version(agencyid, resourceid, version)¶
Get category schemes agency resource version
This function returns the content from
/v1.0/categoryschemes/{agencyID}/{resourceID}/{version}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
version (string) – Specific version of the resource.
Examples
>>> get_structuralresources_category_schemes_agency_resource_version( ... "ISTAC", ... "TEMAS_CANARIAS", ... "01.000" ... )
- istacpy.structuralresources.category.get_structuralresources_category_schemes_agency_resource_version_categories(agencyid, resourceid, version, limit=25, offset=0, query='', orderby='')¶
Get category schemes agency resource version categories
This function returns the content from
/v1.0/categoryschemes/{agencyID}/{resourceID}/{version}/categories
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
version (string) – Specific version of the resource.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_category_schemes_agency_resource_version_categories( ... "ISTAC", ... "TEMAS_CANARIAS", ... "01.000" ... )
- istacpy.structuralresources.category.get_structuralresources_category_schemes_agency_resource_version_categories_id(agencyid, resourceid, version, categoryid)¶
Get category schemes agency resource version categories (id)
This function returns the content from
/v1.0/categoryschemes/{agencyID}/{resourceID}/{version}/categories/{categoryID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
version (string) – Specific version of the resource.
categoryid (string) – category identifier
Examples
>>> get_structuralresources_category_schemes_agency_resource_version_categories_id( ... "ISTAC", ... "TEMAS_CANARIAS", ... "01.000", ... "060" ... ) >>> get_structuralresources_category_schemes_agency_resource_version_categories_id( ... "ISTAC", ... "TEMAS_CANARIAS", ... "01.000", ... "060.060_010.060_010_010" ... )
istacpy.structuralresources.classifications¶
- istacpy.structuralresources.classifications.get_structuralresources_codelist_families(limit=25, offset=0, orderby='', query='')¶
Get codelist families
This function returns the list of families of classifications
- Parameters
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.orderby (string) – Field by which to sort the results.
query (string) – Query to filter the results.
Examples
>>> get_structuralresources_codelist_families()
- istacpy.structuralresources.classifications.get_structuralresources_codelist_families_id(id)¶
Get codelist families
This function allows to obtain a family of classifications in particular.
- Parameters
id (string) – codelist family identificator
Examples
>>> get_structuralresources_codelist_families_id('CODELIST_ID')
- istacpy.structuralresources.classifications.get_structuralresources_codelists(limit=25, offset=0, query='', orderby='')¶
Get codelists
This function allows to obtain the list of classifications.
- Parameters
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_codelists()
- istacpy.structuralresources.classifications.get_structuralresources_codelists_agency(agencyid, limit=25, offset=0, query='', orderby='')¶
Get codelists agency
This function allows obtaining the list of all the classifications maintained by a certain organization.
- Parameters
agencyid (string) – Agency identificator.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_codelists_agency("ISTAC") >>> get_structuralresources_codelists_agency("ESTAT")
- istacpy.structuralresources.classifications.get_structuralresources_codelists_agency_resource(agencyid, resourceid, limit=25, offset=0, query='', orderby='')¶
Get codelists agency resource
This function allows to obtain all the versions of a classification with a certain identifier and that is also kept by a certain organization.
- Parameters
agencyid (string) – Agency identificator.
resourceid (string) – Resource identificator.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_codelists_agency_resource("ISTAC", "CL_AREA_ES")
- istacpy.structuralresources.classifications.get_structuralresources_codelists_agency_resource_version(agencyid, resourceid, version)¶
Get codelists agency resource version
This function allows you to consult a particular version of a classification.
- Parameters
agencyid (string) – Agency identificator.
resourceid (string) – Resource identificator.
version (string) – Specific resource version.
Examples
>>> get_structuralresources_codelists_agency_resource_version( ... "ISTAC", ... "CL_AREA_ES", ... "01.000" ... )
- istacpy.structuralresources.classifications.get_structuralresources_codelists_agency_resource_version_codes(agencyid, resourceid, version, limit=25, offset=0, query='', orderby='', openness='', order='', fields='')¶
Get codelists agency resource version codes
This function allows to consult the codes of a version of a classification. Note that if wildcards are used as
~all
or one of thelimit
,offset
,query
ororderBy
parameters, the list will be automatically paginated.- Parameters
agencyid (string) – Agency identificator.
resourceid (string) – Resource identificator.
version (string) – Specific resource version.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
openness (string) – Opening established for viewing.
order (string) – Order established for visualization.
fields (string) – Additional fields that you want to show in the answer.
Examples
>>> get_structuralresources_codelists_agency_resource_version_codes( ... "ISTAC", ... "CL_AREA_ES", ... "01.000" ... )
- istacpy.structuralresources.classifications.get_structuralresources_codelists_agency_resource_version_codes_codeid(agencyid, resourceid, version, codeid)¶
Get codelists agency resource version codes (codeID)
This function allows to consult a specific code of a version of a classification.
- Parameters
agencyid (string) – Agency identificator.
resourceid (string) – Resource identificator.
version (string) – Specific resource version.
codeid (string) – Code identificator.
Examples
>>> get_structuralresources_codelists_agency_resource_version_codes_codeid( "ISTAC", "CL_AREA_ES", "01.000", "ES706A01")
istacpy.structuralresources.concepts¶
- istacpy.structuralresources.concepts.get_structuralresources_concept_schemes(limit=25, offset=0, query='', orderby='')¶
Get concept schemes
This function returns the content from
/v1.0/conceptschemes
- Parameters
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_concept_schemes() >>> get_structuralresources_concept_schemes( ... query="ID EQ 2090", ... orderby="ID ASC" ... )
- istacpy.structuralresources.concepts.get_structuralresources_concept_schemes_agency(agencyid, limit=25, offset=0, query='', orderby='')¶
Get concept schemes agency
This function returns the content from
/v1.0/conceptschemes/{agencyID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_concept_schemes_agency("ISTAC") >>> get_structuralresources_concept_schemes_agency( ... "ESTAT", ... query="ID EQ 2090", ... orderby="ID ASC" ... )
- istacpy.structuralresources.concepts.get_structuralresources_concept_schemes_agency_resource(agencyid, resourceid, limit=25, offset=0, query='', orderby='')¶
Get concept schemes agency resource
This function returns the content from
/v1.0/conceptschemes/{agencyID}/{resourceID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_concept_schemes_agency_resource( ... agencyid="ISTAC", ... resourceid="CSM_C00010A_SIE" ... )
- istacpy.structuralresources.concepts.get_structuralresources_concept_schemes_agency_resource_version(agencyid, resourceid, version)¶
Get concept schemes agency resource version
This function returns the content from
/v1.0/conceptschemes/{agencyID}/{resourceID}/{version}
- Parameters
agencyid (string) –
resourceid (string) –
version (string) –
Examples
>>> get_structuralresources_concept_schemes_agency_resource_version( ... gencyid="ISTAC", ... resourceid="CSM_C00010A_SIE", ... version="01.000" ... )
- istacpy.structuralresources.concepts.get_structuralresources_concept_schemes_agency_resource_version_concepts(agencyid, resourceid, version, limit=25, offset=0, query='', orderby='', fields='')¶
Get concept schemes agency resource version concepts
This function returns the content from
/v1.0/conceptschemes/{agencyID}/{resourceID}/{version}/concepts
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
version (string) – Specific version of the resource.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
fields (string) – Additional fields that you want to show in the answer.
Examples
>>> get_structuralresources_concept_schemes_agency_resource_version_concepts( ... agencyid="ISTAC", ... resourceid="CSM_C00010A_SIE", ... version="01.000" ... )
- istacpy.structuralresources.concepts.get_structuralresources_concept_schemes_agency_resource_version_concepts_id(agencyid, resourceid, version, conceptid)¶
Get concept schemes agency resource version concepts (id)
This function returns the content from
/v1.0/conceptschemes/{agencyID}/{resourceID}/{version}/concepts/{conceptID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
version (string) – Specific version of the resource.
conceptid (string) – Concept identifier.
Examples
>>> get_structuralresources_concept_schemes_agency_resource_version_concepts_id( ... agencyid="ISTAC", ... resourceid="CSM_C00010A_SIE", ... version="01.000", ... conceptID="ELECTORES" ... )
- istacpy.structuralresources.concepts.get_structuralresources_concept_types()¶
Get concept types
This function returns the content from
/v1.0/conceptTypes
Examples
>>> get_structuralresources_concept_types()
istacpy.structuralresources.datastructures¶
- istacpy.structuralresources.datastructures.get_structuralresources_content_constraints(limit=25, offset=0, query='', orderby='')¶
Get content constraints
This function returns the content from
/v1.0/contentConstraints
- Parameters
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_content_constraints() >>> get_structuralresources_content_constraints( ... query="ID EQ 2090", ... orderby="ID ASC" ... )
- istacpy.structuralresources.datastructures.get_structuralresources_content_constraints_agency(agencyid, limit=25, offset=0, query='', orderby='')¶
Get content constraints agency
This function returns the content from
/v1.0/contentConstraints/{agencyID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_content_constraints_agency("ISTAC")
- istacpy.structuralresources.datastructures.get_structuralresources_content_constraints_agency_resource(agencyid, resourceid, limit=25, offset=0, query='', orderby='')¶
Get content constraints agency resource
- This function returns the content from
/v1.0/contentConstraints/{agencyID}/{resourceID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_content_constraints_agency_resource( ... "ISTAC", ... "CSM_C00010A_SIE" ... )
- istacpy.structuralresources.datastructures.get_structuralresources_content_constraints_agency_resource_version(agencyid, resourceid, version)¶
Get content constraints agency resource version
This function returns the content from
/v1.0/contentConstraints/{agencyID}/{resourceID}/{version}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
version (string) – Specific version of the resource.
Examples
>>> get_structuralresources_content_constraints_agency_resource_version( ... "ISTAC", ... "CSM_C00010A_SIE", ... "01.000" ... )
- istacpy.structuralresources.datastructures.get_structuralresources_content_constraints_agency_resource_version_regions(regioncode, agencyid, resourceid, version)¶
Get content constraints agency resource version regions
This function returns the content from
/v1.0/contentConstraints/{agencyID}/{resourceID}/{version}/regions/
{regionCode}- Parameters
regioncode (string) –
agencyid (string) –
resourceid (string) –
version (string) –
Examples
>>> get_structuralresources_content_constraints_agency_resource_version_regions( ... "0001", ... "ISTAC", ... "CSM_C00010A_SIE", ... "01.000" ... )
- istacpy.structuralresources.datastructures.get_structuralresources_data_structures(limit=25, offset=0, query='', orderby='')¶
Get data structures
This function returns the content from
/v1.0/datastructures
- Parameters
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_data_structures() >>> get_structuralresources_data_structures( ... query="ID EQ 2090", ... orderby="ID ASC" ... )
- istacpy.structuralresources.datastructures.get_structuralresources_data_structures_agency(agencyid, limit=25, offset=0, query='', orderby='')¶
Get data structures agency
This function returns the content from
/v1.0/datastructures/{agencyID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_data_structures_agency("ISTAC")
- istacpy.structuralresources.datastructures.get_structuralresources_data_structures_agency_resource(agencyid, resourceid, limit=25, offset=0, query='', orderby='')¶
Get data structures agency resource
This function returns the content from
/v1.0/datastructures/{agencyID}/{resourceID}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_data_structures_agency_resource( ... "ISTAC", ... "DSD_C00010A_00001" ... )
- istacpy.structuralresources.datastructures.get_structuralresources_data_structures_agency_resource_version(agencyid, resourceid, version)¶
Get data structures agency resource version
This function returns the content from
/v1.0/datastructures/{agencyID}/{resourceID}/{version}
- Parameters
agencyid (string) – Identifier of the agency that publishes.
resourceid (string) – Resource identifier.
version (string) – Specific version of the resource.
Examples
>>> get_structuralresources_data_structures_agency_resource_version( ... "ISTAC", ... "DSD_C00010A_00001", ... "01.001" ... )
istacpy.structuralresources.variables¶
- istacpy.structuralresources.variables.get_structuralresources_geoinfo(variableid, resourceid, fields='', limit=25, offset=0, query='', orderby='')¶
Get geoinfo
This function returns data from
/v1.0/variables/{variableID}/variableelements/{resourceID}/geoinfo
- Parameters
variableid (string) – Variable identificator.
resourceid (string) – Resource identificator.
fields (string) – Additional fields that you want to show in the answer.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_geoinfo("VR_TERRITORIO", "MUN_ICOD_VINOS")
- istacpy.structuralresources.variables.get_structuralresources_variable_families(limit=25, offset=0, query='', orderby='')¶
Get variable families
This function returns data from
/v1.0/variablefamilies
- Parameters
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_variable_families()
- istacpy.structuralresources.variables.get_structuralresources_variable_families_id(id)¶
Get variable families (id)
This function returns data from
/v1.0/variablefamilies/{id}
- Parameters
id (string) – Variable family identificator.
Examples
>>> get_structuralresources_variable_families_id("VRF_DEMOGRAFICAS")
- istacpy.structuralresources.variables.get_structuralresources_variable_families_id_variables(id, limit=25, offset=0, query='', orderby='')¶
Get variable families (id) variables
This function returns data from
/v1.0/variablefamilies/{id}/variables
- Parameters
id (string) – Variable family identificator.
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_variable_families_id_variables("VRF_DEMOGRAFICAS")
- istacpy.structuralresources.variables.get_structuralresources_variableelements(variableid, limit=25, offset=0, query='', orderby='')¶
Get variableelements
This function returns data from
/v1.0/variables/{variableID}/variableelements
- Parameters
variableid (string) –
limit (int) –
offset (int) –
offset = 0
.query (string) –
orderby (string) –
Examples
>>> get_structuralresources_variableelements("VR_SEXO")
- istacpy.structuralresources.variables.get_structuralresources_variableelements_resource(variableid, resourceid)¶
Get variableelements resource
This function returns data from
/v1.0/variables/{variableID}/variableelements/{resourceID}
- Parameters
variableid (string) – Resource identificator.
resourceid (string) – Variable identificator.
Examples
>>> get_structuralresources_variableelements_resource("VR_SEXO", "FEMALE")
- istacpy.structuralresources.variables.get_structuralresources_variables(limit=25, offset=0, query='', orderby='')¶
Get variables
This function returns data from
/v1.0/variables
- Parameters
limit (int) – Results limit. By default
limit = 25
.offset (int) – Displacement. Result from which it is returned. By default
offset = 0
.query (string) – Query to filter the results.
orderby (string) – Field by which to sort the results.
Examples
>>> get_structuralresources_variables()
- istacpy.structuralresources.variables.get_structuralresources_variables_id(id)¶
Get variables (id)
This function returns data from
/v1.0/variables/{id}
- Parameters
id (string) – Variable identifier.
Examples
>>> get_structuralresources_variables_id("VR_SEXO")