| Type: | Package |
| Title: | Obtaining Open Data from Instituto Canario De Estadistica (ISTAC) API |
| Version: | 0.2.2 |
| Date: | 2022-12-20 |
| Maintainer: | Alberto Gonzalez <jgonyanp@gobiernodecanarias.org> |
| Description: | You can access to open data published in Instituto Canario De Estadistica (ISTAC) APIs at https://datos.canarias.es/api/estadisticas/. |
| License: | GPL (≥ 3) |
| Encoding: | UTF-8 |
| Imports: | jsonlite, utils |
| RoxygenNote: | 7.1.2 |
| NeedsCompilation: | no |
| Packaged: | 2022-12-20 14:07:31 UTC; luis |
| Author: | Alberto Gonzalez [aut, cre] |
| Repository: | CRAN |
| Date/Publication: | 2022-12-20 15:20:02 UTC |
Get indicators
Description
This function returns a list of indicators published in the ISTAC-indicators database. An indicator is a measure used to know the intensity of a phenomenon in spacetime. This measure can refer to different spatial or temporal granularities.
Usage
get_indicators(
q = "",
order = "",
limit = 25,
offset = 0,
fields = "",
representation = ""
)
Arguments
q |
(string): Metadata query on which the searches can be built using “id“, “subjectCode“ or “geographicValue“. |
order |
(string): Order. Possible values are: “update“ and “id“. Order criteria are “ASC“ and “DESC“. |
limit |
(int): Results limit. By default “limit = 25“. |
offset |
(int): Displacement. Result from which it is returned. By default “offset = 0“. |
fields |
(string): Use of the answer by adding new fields. Possible values are: “+metadata“, “+data“ and “+observationsMetadata“. |
representation |
(string): Allows filtering the observations by their value. Its use only makes sense when “+data“ and/or “+observationsMetadata“ has been included. |
Examples
get_indicators(
q='id IN ("AFILIACIONES", "EMPLEO_REGISTRADO_AGRICULTURA")',
order="id ASC",
fields="+data",
representation="GEOGRAPHICAL[35003|35005], MEASURE[ABSOLUTE]"
)
Get indicators code
Description
This function returns the metadata that describe the characteristics of a specific indicator, allowing the compression of the measured fact; also through the data request the complete data (for all spacetime) of the indicator is provided.
Usage
get_indicators_code(indicatorcode)
Arguments
indicatorcode |
(string): an indicator code |
Examples
get_indicators_code("AFILIACIONES")
get_indicators_code("PARO_REGISTRADO")
Get indicators code data
Description
This function returns complete data (for all spacetime) of the indicator. On the other hand, metadata describing the characteristics of a specific indicator are offered through the metadata request, allowing the compression of the measured fact.
Usage
get_indicators_code_data(
indicatorcode,
representation = "",
granularity = "",
fields = "",
as_dataframe = F
)
Arguments
indicatorcode |
(string): an indicator code |
representation |
(string): Allows filtering the observations by their value. |
granularity |
(string): Allows to filter the observations through the granularities of the same. |
fields |
(string): Allows you to customize the response by excluding fields. The possible values are: |
as_dataframe |
(bool): If True, this function returns a namedtuple with: - dataframe: pandas dataframe built from API response. - codelists: mapping between codes and representations for each column. “-observationsMetadata“. |
Examples
get_indicators_code_data("AFILIACIONES")
Get geographic granularities
Description
This function returns a list of geographic granularities treated in the ISTAC-indicators database. For example provincial, insular or municipal granularity.
Usage
get_indicators_geographic_granularities()
Examples
get_indicators_geographic_granularities()
Get geographical values
Description
This function returns values of a geographical granularity that in turn are part of a specific theme or system of indicators.
Usage
get_indicators_geographical_values(
geographicalgranularitycode,
subjectcode,
systemcode = ""
)
Arguments
geographicalgranularitycode |
(string): geographical granularity code |
subjectcode |
(string): subject code |
systemcode |
(string): system code |
Examples
get_indicators_geographical_values(
"REGIONS",
subjectcode="051",
systemcode="C00067A"
)
Get subjects
Description
This function returns all subjects which the ISTAC classifies its statistical operations.
Usage
get_indicators_subjects()
Examples
get_indicators_subjects()
Get indicators systems
Description
This function returns a list of indicator systems published in the ISTAC-indicators database. The indicators are simple or compound statistics, however a single indicator can rarely provide useful information about complex phenomena such as the economic situation, living conditions, schooling or others. Indicator systems are generally designed to generate more and more accurate information about the conditions of a phenomenon; and for this they are organized in dimensions or areas of analysis, under which the indicators are integrated.
Usage
get_indicators_systems(limit = 25, offset = 0)
Arguments
limit |
(int): Results limit. By default “limit = 25“. |
offset |
(int): Displacement. Result from which it is returned. By default “offset = 0“. |
Examples
get_indicators_systems()
Get indicators system code
Description
This function returns metadata of a system of indicators published in the ISTAC-indicators database. The indicators are simple or compound statistics, however a single indicator can rarely provide useful information about complex phenomena such as the economic situation, living conditions, schooling or others.
Usage
get_indicators_systems_code(indicatorsystemcode)
Arguments
indicatorsystemcode |
(string): an indicator system code |
Examples
get_indicators_systems_code("C00075H")
Get indicators system code instances
Description
This function returns instances of indicators associated with a specific indicator system. An instance of an indicator is nothing more than a spatio-temporal query of an indicator when it is incorporated into a specific indicator system.
Usage
get_indicators_systems_code_instances(
indicatorsystemcode,
q = "",
order = "",
limit = 25,
offset = 0,
fields = "",
representation = "",
granularity = ""
)
Arguments
indicatorsystemcode |
(string): with an indicator system code |
q |
(string): Query of metadata on which the searches can be built are: “id“ and “geographicalValue“. |
order |
(string): Order. Possible values are: “update“ and “id“ and order criteria are “ASC“ and “DESC“. |
limit |
(int): Results limit. By default “limit = 25“. |
offset |
(int): Displacement. Result from which it is returned. By default “offset = 0“. |
fields |
(string): Use of the answer by adding new fields. Possible values are: “+metadata“, “+data“ and “+observationsMetadata“. |
representation |
(string): Allows filtering the observations by their value. Its use only makes sense when “+data“ and/or “+observationsMetadata“ has been included. |
granularity |
(string): Allows to filter the observations through the granularities of the same. Its use only makes sense when “+data“ and/or “+observationsMetadata“ has been included. |
Examples
get_indicators_systems_code_instances("C00075H")
get_indicators_systems_code_instances(
"C00075H",
q='id EQ "INDICADORES_MUNICIPALES"'
)
Get indicators system code instances code
Description
This function returns metadata of an indicator set associated with a specific indicator system. An instance of an indicator is nothing more than a spatio-temporal query of an indicator when it is incorporated into a specific indicator system.
Usage
get_indicators_systems_code_instances_code(
indicatorsystemcode,
indicatorinstancecode
)
Arguments
indicatorsystemcode |
(string) indicator system code |
indicatorinstancecode |
(string) indicator instance code |
Examples
get_indicators_systems_code_instances_code(
"C00075H",
"21af0477-d63b-493b-ad02-4ab181547223"
)
Get indicators system code instances code data
Description
This function returns metadata of an indicator set associated with a specific indicator system. An instance of an indicator is nothing more than a spatio-temporal query of an indicator when it is incorporated into a specific indicator system.
Usage
get_indicators_systems_code_instances_code_data(
indicatorsystemcode,
indicatorinstancecode,
representation = "",
granularity = "",
fields = ""
)
Arguments
indicatorsystemcode |
(string): Indicator system code |
indicatorinstancecode |
(string): Indicator instance code |
representation |
(string): Allows filtering the observations by their value. |
granularity |
(string): Allows to filter the observations through the granularities of the same. |
fields |
(string): Allows you to customize the response by excluding fields. The possible values are: “-observationsMetadata“. |
Examples
get_indicators_systems_code_instances_code_data(
"C00075H",
"21af0477-d63b-493b-ad02-4ab181547223"
)
Get time granularities
Description
This function returns a list of temporary granularity treated in the ISTAC data bank-indicators ordered from highest to lowest granularity. For example annual, quarterly or monthly granularity.
Usage
get_indicators_time_granularities()
Examples
get_indicators_time_granularities()
Get datasets
Description
This function allows consulting all existing statistical data cubes.
Usage
get_statisticalresources_datasets(
lang = "es",
limit = 25,
offset = 0,
orderby = "",
query = ""
)
Arguments
lang |
(string): Language in which you want to get the answer. |
limit |
(int): Results limit. By default “limit=25“. |
offset |
(int): Displacement. Result from which it is returned. By default “offset=0“. |
orderby |
(string): Order. Possible values are “ID ASC“ or “ID DESC“. |
query |
(string): Metadata query on which the searches can be built. |
Examples
get_statisticalresources_datasets(limit=5)
Get datasets (agencyID)
Description
This function allows to consult all the data sets maintained by a certain organization.
Usage
get_statisticalresources_datasets_agency(
agencyid,
lang = "es",
limit = 25,
offset = 0,
orderby = "",
query = ""
)
Arguments
agencyid |
(string): Identifier of the maintainer organization of the resource. A possible value is “ISTAC“. |
lang |
(string): Language in which you want to get the answer. |
limit |
(int): Results limit. By default “limit=25“. |
offset |
(int): Displacement. Result from which it is returned. By default “offset=0“. |
orderby |
(string): Order. Possible values are “ID ASC“ or “ID DESC“. |
query |
(string): Metadata query on which the searches can be built. |
Examples
get_statisticalresources_datasets_agency(agencyid="ISTAC")
Get datasets (agencyID / resourceID)
Description
This function allows to obtain all the versions of a statistical cube with a certain identifier and that also maintains a certain organization.
Usage
get_statisticalresources_datasets_agency_resource(
agencyid,
resourceid,
lang = "es",
limit = 25,
offset = 0,
orderby = "",
query = ""
)
Arguments
agencyid |
(string): Identifier of the maintainer organization of the resource. A possible value is “ISTAC“. |
resourceid |
(string): Resource identifier. A possible value is “C00010A_000002“. |
lang |
(string): Language in which you want to get the answer. |
limit |
(int): Results limit. By default “limit=25“. |
offset |
(int): Displacement. Result from which it is returned. By default “offset=0“. |
orderby |
(string): Order. Possible values are “ID ASC“ or “ID DESC“. |
query |
(string): Metadata query on which the searches can be built. |
Examples
get_statisticalresources_datasets_agency_resource(
agencyid="ISTAC",
resourceid="C00010A_000002"
)
Get datasets (agencyID / resourceID / version)
Description
This function allows to obtain a certain version of a statistical cube with a certain identifier and that also maintains a certain organization.
Usage
get_statisticalresources_datasets_agency_resource_version(
agencyid,
resourceid,
version,
dim = "",
fields = "",
lang = "es",
as_dataframe = F
)
Arguments
agencyid |
(string): Identifier of the maintainer organization of the resource. A possible value is “ISTAC“. |
resourceid |
(string): Resource identifier. A possible value is “C00010A_000002“. |
version |
(string): Resource version. A possible value is “001.000“. |
dim |
(string): Allows filtering the data obtained in the response. A example is “TIME_PERIOD:2009|2010“. |
fields |
(string): Allows you to customize the response by excluding fields from it. The possible values are “-metadata“ and “-data“. |
lang |
(string): Language in which you want to get the answer. |
as_dataframe |
(bool): If True, this function returns a namedtuple with: - dataframe: pandas dataframe built from API response. - codelists: mapping between codes and representations for each column. |
Examples
get_statisticalresources_datasets_agency_resource_version(
agencyid="ISTAC",
resourceid="C00010A_000012",
version="001.000",
dim="TIME_PERIOD:2009")
Get queries
Description
This function allows consulting all existing statistical queries.
Usage
get_statisticalresources_queries(
lang = "es",
limit = 25,
offset = 0,
orderby = "",
query = ""
)
Arguments
lang |
(string): Language in which you want to get the answer. |
limit |
(int): Results limit. By default “limit=25“. |
offset |
(int): Displacement. Result from which it is returned. By default “offset=0“. |
orderby |
(string): Order. Possible values are “ID ASC“ or “ID DESC“, |
query |
(string): Metadata query on which the searches can be built. |
Examples
get_statisticalresources_queries(limit=5)
Get queries (agencyID)
Description
This function allows to consult all the queries maintained by a certain organization.
Usage
get_statisticalresources_queries_agency(
agencyid,
lang = "es",
limit = 25,
offset = 0,
orderby = "",
query = ""
)
Arguments
agencyid |
(string): Identifier of the maintainer organization of the resource. A possible value is “ISTAC“. |
lang |
(string): Language in which you want to get the answer. |
limit |
(int): Results limit. By default “limit=25“. |
offset |
(int): Displacement. Result from which it is returned. By default “offset=0“. |
orderby |
(string): Order. Possible values are “ID ASC“ or “ID DESC“, |
query |
(string): Metadata query on which the searches can be built. |
Examples
get_statisticalresources_queries_agency(agencyid="ISTAC", limit=5)
Get queries (agencyID / resourceID)
Description
This function allows to obtain final data of a statistical query with a certain identifier and that also maintains a certain organization.
Usage
get_statisticalresources_queries_agency_resource(
agencyid,
resourceid,
fields = "",
lang = "es",
as_dataframe = FALSE
)
Arguments
agencyid |
(string): Identifier of the maintainer organization of the resource. A possible value is “ISTAC“. |
resourceid |
(string): Resource identifier. A possible value is “C00005A_000004“. |
fields |
(string): Allows you to customize the response by excluding fields from it. - The possible values are “-metadata“ and “-data“. |
lang |
(string): Language in which you want to get the answer. |
as_dataframe |
(bool): If True, this function returns a namedtuple with: - dataframe: pandas dataframe built from API response. - codelists: mapping between codes and representations for each column. |
Examples
get_statisticalresources_queries_agency_resource(
agencyid="ISTAC",
resourceid="C00005A_000004"
)
Get categorisations
Description
This function returns the content from “/v1.0/categorisations“
Usage
get_structuralresources_categorisations(
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get categorisations agency
Description
This function returns the content from “/v1.0/categorisations/agencyID“
Usage
get_structuralresources_categorisations_agency(
agencyid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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")
Get categorisations agency resource
Description
This function returns the content from “/v1.0/categorisations/agencyID/resourceID“
Usage
get_structuralresources_categorisations_agency_resource(
agencyid,
resourceid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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")
Get categorisations agency resource version
Description
This function returns the content from “/v1.0/categorisations/agencyID/resourceID/version“
Usage
get_structuralresources_categorisations_agency_resource_version(
agencyid,
resourceid,
version
)
Arguments
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"
)
Get category schemes
Description
This function returns the content from “/v1.0/categoryschemes“
Usage
get_structuralresources_category_schemes(
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get category schemes agency
Description
This function returns the content from “/v1.0/categoryschemes/agencyID“
Usage
get_structuralresources_category_schemes_agency(
agencyid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get category schemes agency resource
Description
This function returns the content from “/v1.0/categoryschemes/agencyID/resourceID“
Usage
get_structuralresources_category_schemes_agency_resource(
agencyid,
resourceid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get category schemes agency resource version
Description
This function returns the content from “/v1.0/categoryschemes/agencyID/resourceID/version“
Usage
get_structuralresources_category_schemes_agency_resource_version(
agencyid,
resourceid,
version
)
Arguments
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"
)
Get category schemes agency resource version categories
Description
This function returns the content from “/v1.0/categoryschemes/agencyID/resourceID/version/categories“
Usage
get_structuralresources_category_schemes_agency_resource_version_categories(
agencyid,
resourceid,
version,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get category schemes agency resource version categories (id)
Description
This function returns the content from “/v1.0/categoryschemes/agencyID/resourceID/version/categories/categoryID“
Usage
get_structuralresources_category_schemes_agency_resource_version_categories_id(
agencyid,
resourceid,
version,
categoryid
)
Arguments
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"
)
Get codelist families
Description
This function returns the list of families of classifications
Usage
get_structuralresources_codelist_families(
limit = 25,
offset = 0,
orderby = "",
query = ""
)
Arguments
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()
Get codelist families
Description
This function allows to obtain a family of classifications in particular.
Usage
get_structuralresources_codelist_families_id(id)
Arguments
id |
(string): codelist family identificator |
Examples
get_structuralresources_codelist_families_id('CODELIST_ID')
Get codelists
Description
This function allows to obtain the list of classifications.
Usage
get_structuralresources_codelists(
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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()
Get codelists agency
Description
This function allows obtaining the list of all the classifications maintained by a certain organization.
Usage
get_structuralresources_codelists_agency(
agencyid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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")
Get codelists agency resource
Description
This function allows to obtain all the versions of a classification with a certain identifier and that is also kept by a certain organization.
Usage
get_structuralresources_codelists_agency_resource(
agencyid,
resourceid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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")
Get codelists agency resource version
Description
This function allows you to consult a particular version of a classification.
Usage
get_structuralresources_codelists_agency_resource_version(
agencyid,
resourceid,
version
)
Arguments
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"
)
Get codelists agency resource version codes
Description
This function allows to consult the codes of a version of a classification. Note that if wildcards are used as “~all“ or one of the “limit“, “offset“, “query“ or “orderBy“ parameters, the list will be automatically paginated.
Usage
get_structuralresources_codelists_agency_resource_version_codes(
agencyid,
resourceid,
version,
limit = 25,
offset = 0,
query = "",
orderby = "",
openness = "",
order = "",
fields = ""
)
Arguments
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. |
orderby |
(string): Order established for data. |
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"
)
Get codelists agency resource version codes (codeID)
Description
This function allows to consult a specific code of a version of a classification.
Usage
get_structuralresources_codelists_agency_resource_version_codes_codeid(
agencyid,
resourceid,
version,
codeid
)
Arguments
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")
Get concept schemes
Description
This function returns the content from “/v1.0/conceptschemes“
Usage
get_structuralresources_concept_schemes(
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get concept schemes agency
Description
This function returns the content from “/v1.0/conceptschemes/agencyID“
Usage
get_structuralresources_concept_schemes_agency(
agencyid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get concept schemes agency resource
Description
This function returns the content from “/v1.0/conceptschemes/agencyID/resourceID“
Usage
get_structuralresources_concept_schemes_agency_resource(
agencyid,
resourceid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get concept schemes agency resource version
Description
This function returns the content from “/v1.0/conceptschemes/agencyID/resourceID/version“
Usage
get_structuralresources_concept_schemes_agency_resource_version(
agencyid,
resourceid,
version
)
Arguments
agencyid |
(string) Identifier of the agency that publishes. |
resourceid |
(string) Resource identifier. |
version |
(string) Specific version of the resource. |
Examples
get_structuralresources_concept_schemes_agency_resource_version(
agencyid="ISTAC",
resourceid="CSM_C00010A_SIE",
version="01.000"
)
Get concept schemes agency resource version concepts
Description
This function returns the content from “/v1.0/conceptschemes/agencyID/resourceID/version/concepts“
Usage
get_structuralresources_concept_schemes_agency_resource_version_concepts(
agencyid,
resourceid,
version,
limit = 25,
offset = 0,
query = "",
orderby = "",
fields = ""
)
Arguments
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"
)
Get concept schemes agency resource version concepts (id)
Description
This function returns the content from “/v1.0/conceptschemes/agencyID/resourceID/version/concepts/conceptID“
Usage
get_structuralresources_concept_schemes_agency_resource_version_concepts_id(
agencyid,
resourceid,
version,
conceptid
)
Arguments
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"
)
Get concept types
Description
This function returns the content from “/v1.0/conceptTypes“
Usage
get_structuralresources_concept_types()
Examples
get_structuralresources_concept_types()
Get content constraints
Description
This function returns the content from “/v1.0/contentConstraints“
Usage
get_structuralresources_content_constraints(
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get content constraints agency
Description
This function returns the content from “/v1.0/contentConstraints/agencyID“
Usage
get_structuralresources_content_constraints_agency(
agencyid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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")
Get content constraints agency resource
Description
This function returns the content from “/v1.0/contentConstraints/agencyID/resourceID“
Usage
get_structuralresources_content_constraints_agency_resource(
agencyid,
resourceid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get content constraints agency resource version
Description
This function returns the content from “/v1.0/contentConstraints/agencyID/resourceID/version“
Usage
get_structuralresources_content_constraints_agency_resource_version(
agencyid,
resourceid,
version
)
Arguments
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"
)
Get content constraints agency resource version regions
Description
This function returns the content from “/v1.0/contentConstraints/agencyID/resourceID/version/regions/“regionCode
Usage
get_structuralresources_content_constraints_agency_resource_version_regions(
regioncode,
agencyid,
resourceid,
version
)
Arguments
regioncode |
(string) Region code. |
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_regions(
"0001",
"ISTAC",
"CSM_C00010A_SIE",
"01.000"
)
Get data structures
Description
This function returns the content from “/v1.0/datastructures“
Usage
get_structuralresources_data_structures(
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get data structures agency
Description
This function returns the content from “/v1.0/datastructures/agencyID“
Usage
get_structuralresources_data_structures_agency(
agencyid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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")
Get data structures agency resource
Description
This function returns the content from “/v1.0/datastructures/agencyID/resourceID“
Usage
get_structuralresources_data_structures_agency_resource(
agencyid,
resourceid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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"
)
Get data structures agency resource version
Description
This function returns the content from “/v1.0/datastructures/agencyID/resourceID/version“
Usage
get_structuralresources_data_structures_agency_resource_version(
agencyid,
resourceid,
version
)
Arguments
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"
)
Get geoinfo
Description
This function returns data from “/v1.0/variables/variableID/variableelements/resourceID/geoinfo“
Usage
get_structuralresources_geoinfo(
variableid,
resourceid,
fields = "",
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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")
Get variable families
Description
This function returns data from “/v1.0/variablefamilies“
Usage
get_structuralresources_variable_families(
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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()
Get variable families (id)
Description
This function returns data from “/v1.0/variablefamilies/id“
Usage
get_structuralresources_variable_families_id(id)
Arguments
id |
(string): Variable family identificator. |
Examples
get_structuralresources_variable_families_id("VRF_DEMOGRAFICAS")
Get variable families (id) variables
Description
This function returns data from “/v1.0/variablefamilies/id/variables“
Usage
get_structuralresources_variable_families_id_variables(
id,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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")
Get variableelements
Description
This function returns data from “/v1.0/variables/variableID/variableelements“
Usage
get_structuralresources_variableelements(
variableid,
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
variableid |
(string) Variable 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_variableelements("VR_SEXO")
Get variableelements resource
Description
This function returns data from “/v1.0/variables/variableID/variableelements/resourceID“
Usage
get_structuralresources_variableelements_resource(variableid, resourceid)
Arguments
variableid |
(string): Resource identificator. |
resourceid |
(string): Variable identificator. |
Examples
get_structuralresources_variableelements_resource("VR_SEXO", "FEMALE")
Get variables
Description
This function returns data from “/v1.0/variables“
Usage
get_structuralresources_variables(
limit = 25,
offset = 0,
query = "",
orderby = ""
)
Arguments
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()
Get variables (id)
Description
This function returns data from “/v1.0/variables/id“
Usage
get_structuralresources_variables_id(id)
Arguments
id |
(string): Variable identifier. |
Examples
get_structuralresources_variables_id("VR_SEXO")