Commands

Every command, argument and option of regionalatlas 0.1.0, read from the CLI itself.

Global options

These options work with every command.

OptionDescriptionDefault
-V, --version output the version number
--base-url <url> ArcGIS data host base URL https://www.gis-idmz.nrw.de
--catalog-url <url> indicator catalogue URL (services.json) https://regionalatlas.statistikportal.de/taskrunner/services.json
--timeout <ms> time limit per request in ms, whole response included (0 = no timeout)
--user-agent <ua> User-Agent header value
--max-retries <n> retries for transient 429/503 responses (0..10)
--max-response-bytes <n> cap response body size in bytes (0 = unlimited; default 100 MiB)
--compact print JSON on a single line instead of pretty-printed

regionalatlas themes

List the subject areas (Themenbereiche) with their indicator counts

regionalatlas themes [options]

regionalatlas indicators

List indicators (Indikatoren): code, short and long title, available years

regionalatlas indicators [options]

Options

OptionDescriptionDefault
--theme <substr> filter by theme title (case-insensitive substring)
--year <yyyy> only indicators offering this year
--search <substr> filter over code + short + long title (case-insensitive)

regionalatlas query

Fetch indicator data rows per region (Bundesland / Kreis / Gemeinde)

regionalatlas query [options] <indicator-code>

Arguments

<indicator-code> required
indicator code (AI002-1-5) or table form (ai002_1_5)

Options

OptionDescriptionDefault
--level <level> geo level: land | regierungsbezirk | kreis | gemeinde land
--year <yyyy> reporting year (defaults to the newest year in the catalogue)
--region <name|ags> keep only rows matching this name (substring) or AGS
--fields <a,b,c> keep only these value fields (comma-separated)