list_areas
List counties, local authorities or districts with IDs and names by country and level to pass valid area identifiers to query_data.
Instructions
Use when you need the ids and names of the areas (counties, local authorities, districts) to pass to
query_data.
List every geography at one boundary level, for one country ('ireland'
or 'united-kingdom'). level defaults to "county" (Ireland's 26 counties);
the UK's own primary level is "lad" (local authority districts), not
"county". Other levels exist per country (e.g. Ireland's "local_authority",
"garda_division") -- see a dataset's own compatible_levels from
query_data for which levels a given stat is actually published at.
Returns each area's id (used by query_data's area-scoped modes,
always paired with the SAME country), name and level. Slim by default;
include_parents=True adds each area's parents (the regions it sits in)
and Irish-language name.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| level | No | county | |
| country | No | ireland | |
| include_parents | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |