Commands

Every command, argument and option of luftqualitaet 0.6.1, read from the CLI itself.

Global options

These options work with every command.

Option	Description	Default
`-V, --version`	output the version number
`--base-url <url>`	API host; the CLI adds /api/air-data/v3 itself	`https://luftdaten.umweltbundesamt.de`
`--timeout <ms>`	per-request timeout in milliseconds (0..2147483647)
`--user-agent <ua>`	User-Agent header value
`--max-retries <n>`	retries for transient 429/503 responses and reset connections (0..10; linear backoff, or the server's Retry-After when longer, up to 30 s)
`--max-redirects <n>`	HTTP redirects to follow (0..20; 0 = none; default 5)
`--max-response-bytes <n>`	cap response body size in bytes (0 = unlimited; default 100 MiB)
`--log-format <format>`	how errors, warnings and notes are written to stderr: text (log4j style: time, level, [topic], message) or jsonl (one JSON object per line: ts, level, topic, msg); default text
`--compact`	print JSON on a single line instead of pretty-printed

`luftqualitaet components`

List measured components (pollutants)

luftqualitaet components [options]

Options

Option	Description	Default
`--lang <lang>`	de \| en
`--index <index>`	id \| code

`luftqualitaet networks`

List measurement networks

luftqualitaet networks [options]

Options

Option	Description	Default
`--lang <lang>`	de \| en
`--index <index>`	id \| code

`luftqualitaet scopes`

List measurement scopes

luftqualitaet scopes [options]

Options

Option	Description	Default
`--lang <lang>`	de \| en
`--index <index>`	id \| code

`luftqualitaet station-types`

List station types

luftqualitaet station-types [options]

Options

Option	Description	Default
`--lang <lang>`	de \| en

`luftqualitaet station-settings`

List station settings

luftqualitaet station-settings [options]

Options

Option	Description	Default
`--lang <lang>`	de \| en

`luftqualitaet transgression-types`

List exceedance types

luftqualitaet transgression-types [options]

Options

Option	Description	Default
`--lang <lang>`	de \| en

`luftqualitaet airquality`

Air-quality index data for a station/window

luftqualitaet airquality [options]

Options

Option	Description	Default
`--date-from <YYYY-MM-DD>` required	window start date
`--time-from <1-24>` required	window start hour
`--date-to <YYYY-MM-DD>` required	window end date
`--time-to <1-24>` required	window end hour
`--station <id>` required	station id

`luftqualitaet airquality-limits`

Available date range per station for air-quality data

luftqualitaet airquality-limits [options]

`luftqualitaet measures`

Raw measurements of one component/scope series for a station/window

luftqualitaet measures [options]

Options

Option	Description	Default
`--component <id>` required	component id
`--scope <id>` required	scope id (averaging, see `scopes`)
`--date-from <YYYY-MM-DD>` required	window start date
`--time-from <1-24>` required	window start hour
`--date-to <YYYY-MM-DD>` required	window end date
`--time-to <1-24>` required	window end hour
`--station <id>` required	station id

`luftqualitaet measures-limits`

Available date range per scope/component/station

luftqualitaet measures-limits [options]

`luftqualitaet annual-balances`

Annual tabulations for a component and year (final data; the year's exceedance counts)

luftqualitaet annual-balances [options]

Options

Option	Description	Default
`--component <id>` required	component id
`--year <YYYY>` required	year (>= 2016)
`--lang <lang>`	de \| en
`--index <index>`	id \| code (no effect on these rows; kept for compatibility)

`luftqualitaet transgressions`

Exceedance table for a component and year (running year, preliminary data)

luftqualitaet transgressions [options]

Options

Option	Description	Default
`--component <id>` required	component id
`--year <YYYY>` required	year (>= 2016)
`--lang <lang>`	de \| en
`--index <index>`	id \| code (no effect on these rows; kept for compatibility)

`luftqualitaet thresholds`

Thresholds for a use (airquality | measure)

luftqualitaet thresholds [options]

Options

Option	Description	Default
`--use <use>` required	airquality \| measure
`--lang <lang>`	de \| en
`--component <id>`	component id
`--scope <id>`	scope id

`luftqualitaet meta`

Combined metadata for a use

luftqualitaet meta [options]

Options

Option	Description	Default
`--use <use>` required	airquality \| measure \| transgression \| annualbalance \| map
`--lang <lang>`	de \| en
`--date-from <YYYY-MM-DD>`	window start date (required for use=airquality; for other uses it narrows the station list)
`--date-to <YYYY-MM-DD>`	window end date (given together with --date-from)
`--time-from <1-24>`	window start hour (needs the dates; default 1)
`--time-to <1-24>`	window end hour (needs the dates; default 24)