Available data for a region.

The regional_data endpoint allows you to request information about available data for a given region and its subregions.

You can do this by providing either an empty payload or by specifying only a region_level to see available data for that specific level.

Finding out the available data for the region

See below for an example of how to retrieve available data for the Netherlands.

# retrieve Country resource
>>> url = "https://www.the-datagarden.io/country/netherlands/regional_data/"
>>> 
>>> headers = {'Content-Type': 'application/json', 'Authorization': 'Bearer <access_token>'}
>>> payload = []
>>> 
>>> response = requests.request("GET", url, headers=headers, payload=payload)
>>> print(response.json())

The response provides information about the types of data available for this country and its subregions. The response includes two sections:

regional_hierarchy: Describes the types and hierarchy of subregions within the country.
available_data_by_region_type: Dict with region types within the country and the available data for each region type including the country itself.

For each region type the datamodels, sources, period range and period types. As well as the total count of available data objects are given

			
{
	"name": "Netherlands",
	"iso_cc_2": "NL",
	"region_hierarchy": {
		"country": {
			"count": 1,
			"region_level": 0,
			"with_geojson": 1
		},
		"region": {
			"count": 4,
			"region_level": 1,
			"with_geojson": 4
		},
		"province": {
			"count": 12,
			"region_level": 2,
			"with_geojson": 12
		},
		"corop region": {
			"count": 40,
			"region_level": 3,
			"with_geojson": 40
		},
		"city": {
			"count": 355,
			"region_level": 4,
			"with_geojson": 355
		},
		"postcode-4": {
			"count": 3964,
			"region_level": 5,
			"with_geojson": 3963
		}
	},
	"available_data_by_region_type": {
		"country": {
			"health": {
				"count": 35,
				"sources": [
					"UNICEF",
					"Eurostat"
				],
				"to_period": "2023-01-01T00:00:00Z",
				"from_period": "2000-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			},
			"economics": {
				"count": 103,
				"sources": [
					"UNCTAD",
					"Eurostat"
				],
				"to_period": "2023-01-01T00:00:00Z",
				"from_period": "1975-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			},
			"demographics": {
				"count": 185,
				"sources": [
					"Eurostat",
					"United Nations"
				],
				"to_period": "2100-01-01T00:00:00Z",
				"from_period": "1950-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			}
		},
		"region": {
			"health": {
				"count": 44,
				"sources": [
					"Eurostat"
				],
				"to_period": "2021-01-01T00:00:00Z",
				"from_period": "2011-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			},
			"economics": {
				"count": 112,
				"sources": [
					"Eurostat"
				],
				"to_period": "2022-01-01T00:00:00Z",
				"from_period": "1995-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			},
			"weatherdata": {
				"count": 28900,
				"sources": [
					"Datagarden regional weather average for period",
					"Datagarden regional average weather observations"
				],
				"to_period": "2024-08-31T00:00:00Z",
				"from_period": "2008-01-01T00:00:00Z",
				"period_type": [
					"D",
					"M",
					"Q",
					"W"
				]
			},
			"demographics": {
				"count": 136,
				"sources": [
					"Eurostat"
				],
				"to_period": "2023-01-01T00:00:00Z",
				"from_period": "1990-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			}
		},
		"province": {
			"health": {
				"count": 132,
				"sources": [
					"Eurostat"
				],
				"to_period": "2021-01-01T00:00:00Z",
				"from_period": "2011-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			},
			"economics": {
				"count": 336,
				"sources": [
					"Eurostat"
				],
				"to_period": "2022-01-01T00:00:00Z",
				"from_period": "1995-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			},
			"weatherdata": {
				"count": 86688,
				"sources": [
					"Datagarden regional weather average for period",
					"Datagarden regional average weather observations"
				],
				"to_period": "2024-08-31T00:00:00Z",
				"from_period": "2008-01-01T00:00:00Z",
				"period_type": [
					"D",
					"M",
					"Q",
					"W"
				]
			},
			"demographics": {
				"count": 408,
				"sources": [
					"Eurostat"
				],
				"to_period": "2023-01-01T00:00:00Z",
				"from_period": "1990-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			}
		},
		"corop region": {
			"economics": {
				"count": 1120,
				"sources": [
					"Eurostat"
				],
				"to_period": "2022-01-01T00:00:00Z",
				"from_period": "1995-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			},
			"weatherdata": {
				"count": 256672,
				"sources": [
					"Datagarden regional weather average for period",
					"Datagarden regional average weather observations"
				],
				"to_period": "2024-08-31T00:00:00Z",
				"from_period": "2008-01-01T00:00:00Z",
				"period_type": [
					"D",
					"M",
					"Q",
					"W"
				]
			},
			"demographics": {
				"count": 1133,
				"sources": [
					"Eurostat"
				],
				"to_period": "2022-01-01T00:00:00Z",
				"from_period": "1990-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			}
		},
		"city": {
			"health": {
				"count": 6365,
				"sources": [
					"RIVM"
				],
				"to_period": "2024-01-01T00:00:00Z",
				"from_period": "2006-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			}
		},
		"postcode-4": {
			"household": {
				"count": 19801,
				"sources": [
					"CBS"
				],
				"to_period": "2023-01-01T00:00:00Z",
				"from_period": "2019-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			},
			"demographics": {
				"count": 19806,
				"sources": [
					"CBS"
				],
				"to_period": "2023-01-01T00:00:00Z",
				"from_period": "2019-01-01T00:00:00Z",
				"period_type": [
					"Y"
				]
			}
		}
	}
}