Befehle

Alle Befehle, Argumente und Optionen von luftqualitaet 0.6.1, direkt aus der CLI gelesen.

Die Beschreibungen der Befehle, Argumente und Optionen stammen direkt aus der CLI und sind englisch.

Globale Optionen

Diese Optionen gelten für jeden Befehl.

Option	Beschreibung	Standard
`-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]

Optionen

Option	Beschreibung	Standard
`--lang <lang>`	de \| en
`--index <index>`	id \| code

`luftqualitaet networks`

List measurement networks

luftqualitaet networks [options]

Optionen

Option	Beschreibung	Standard
`--lang <lang>`	de \| en
`--index <index>`	id \| code

`luftqualitaet scopes`

List measurement scopes

luftqualitaet scopes [options]

Optionen

Option	Beschreibung	Standard
`--lang <lang>`	de \| en
`--index <index>`	id \| code

`luftqualitaet station-types`

List station types

luftqualitaet station-types [options]

Optionen

Option	Beschreibung	Standard
`--lang <lang>`	de \| en

`luftqualitaet station-settings`

List station settings

luftqualitaet station-settings [options]

Optionen

Option	Beschreibung	Standard
`--lang <lang>`	de \| en

`luftqualitaet transgression-types`

List exceedance types

luftqualitaet transgression-types [options]

Optionen

Option	Beschreibung	Standard
`--lang <lang>`	de \| en

`luftqualitaet airquality`

Air-quality index data for a station/window

luftqualitaet airquality [options]

Optionen

Option	Beschreibung	Standard
`--date-from <YYYY-MM-DD>` erforderlich	window start date
`--time-from <1-24>` erforderlich	window start hour
`--date-to <YYYY-MM-DD>` erforderlich	window end date
`--time-to <1-24>` erforderlich	window end hour
`--station <id>` erforderlich	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]

Optionen

Option	Beschreibung	Standard
`--component <id>` erforderlich	component id
`--scope <id>` erforderlich	scope id (averaging, see `scopes`)
`--date-from <YYYY-MM-DD>` erforderlich	window start date
`--time-from <1-24>` erforderlich	window start hour
`--date-to <YYYY-MM-DD>` erforderlich	window end date
`--time-to <1-24>` erforderlich	window end hour
`--station <id>` erforderlich	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]

Optionen

Option	Beschreibung	Standard
`--component <id>` erforderlich	component id
`--year <YYYY>` erforderlich	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]

Optionen

Option	Beschreibung	Standard
`--component <id>` erforderlich	component id
`--year <YYYY>` erforderlich	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]

Optionen

Option	Beschreibung	Standard
`--use <use>` erforderlich	airquality \| measure
`--lang <lang>`	de \| en
`--component <id>`	component id
`--scope <id>`	scope id

`luftqualitaet meta`

Combined metadata for a use

luftqualitaet meta [options]

Optionen

Option	Beschreibung	Standard
`--use <use>` erforderlich	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)