destatis hello
Connectivity check (helloworld/whoami) — needs no credentials
destatis hello [options]Befehle
Alle Befehle, Argumente und Optionen von destatis 0.0.6, 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 base URL | https://genesis.destatis.de |
--token <token> |
GENESIS API token (env: DESTATIS_API_TOKEN) | |
--username <user> |
GENESIS account username (env: DESTATIS_USERNAME) | |
--password <pass> |
GENESIS account password (env: DESTATIS_PASSWORD) | |
--language <lang> |
response language Werte: de, en | de |
--pagelength <n> |
max list results for find/catalogue (1..25000; ignored by data/metadata) | |
--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 | |
-o, --output <file> |
write output (JSON, or a download) to this file | |
--force |
overwrite the --output file if it already exists |
destatis logincheck
Validate your credentials (helloworld/logincheck)
destatis logincheck [options]destatis find
Full-text search across statistics, tables, cubes, variables and time series
destatis find [options] <term>Argumente
<term>erforderlich- search term (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--category <cat> |
restrict to an object type Werte: all, tables, statistics, cubes, variables, time-series | all |
destatis catalogue
Browse the catalogue: list objects by code selection (e.g. `124*`)
destatis catalogue tables
List tables (Tabellen)
destatis catalogue tables [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue statistics
List statistics (Statistiken)
destatis catalogue statistics [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue cubes
List data cubes (Datenquader)
destatis catalogue cubes [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue timeseries
List time series (Zeitreihen)
destatis catalogue timeseries [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue variables
List variables (Merkmale)
destatis catalogue variables [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue values
List variable values (Ausprägungen)
destatis catalogue values [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue terms
List search terms (Begriffe)
destatis catalogue terms [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue jobs
List background jobs (Aufträge)
destatis catalogue jobs [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue modified
List recently modified objects
destatis catalogue modified [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue results
List saved result tables (Ergebnistabellen)
destatis catalogue results [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis catalogue qualitysigns
List quality-sign symbols
destatis catalogue qualitysigns [options] [selection]Argumente
[selection]optional
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area (default server-side; try `all`) | |
--search-criterion <c> |
field `selection` matches Werte: Code, Content | |
--sort-criterion <c> |
result sort order Werte: Code, Content | |
--type <type> |
object subtype filter |
destatis metadata
Describe an object's structure (metadata) by its code
destatis metadata table
Describe a table
destatis metadata table [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area |
destatis metadata statistic
Describe a statistic
destatis metadata statistic [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area |
destatis metadata cube
Describe a data cube
destatis metadata cube [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area |
destatis metadata timeseries
Describe a time series
destatis metadata timeseries [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area |
destatis metadata variable
Describe a variable
destatis metadata variable [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area |
destatis metadata value
Describe a variable value
destatis metadata value [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area |
destatis data
Retrieve statistical data (tables, cubes, time series, results)
destatis data table
Fetch a table's data (data/table) — CSV in Object.Content
destatis data table [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area | |
--start-year <year> |
earliest year (YYYY) | |
--end-year <year> |
latest year (YYYY) | |
--timeslices <n> |
number of time slices from the end | |
--region-var <code> |
regional variable code | |
--region-key <key> |
regional key (e.g. a Land/Kreis code, `*` wildcard ok) | |
--contents <labels> |
restrict to these value labels (comma-separated) | |
--stand <date> |
only data newer than this date (DD.MM.YYYY) | |
--structure |
include the dimension structure tree | |
--transpose |
transpose rows and columns | |
--compress |
compress repeated labels | |
--class-var1 <code> |
classifying variable 1 code | |
--class-key1 <key> |
classifying key 1 (value selection) | |
--class-var2 <code> |
classifying variable 2 code | |
--class-key2 <key> |
classifying key 2 (value selection) | |
--class-var3 <code> |
classifying variable 3 code | |
--class-key3 <key> |
classifying key 3 (value selection) | |
--class-var4 <code> |
classifying variable 4 code | |
--class-key4 <key> |
classifying key 4 (value selection) | |
--class-var5 <code> |
classifying variable 5 code | |
--class-key5 <key> |
classifying key 5 (value selection) |
destatis data cube
Fetch a data cube (data/cube)
destatis data cube [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area | |
--start-year <year> |
earliest year (YYYY) | |
--end-year <year> |
latest year (YYYY) | |
--timeslices <n> |
number of time slices from the end | |
--region-var <code> |
regional variable code | |
--region-key <key> |
regional key (e.g. a Land/Kreis code, `*` wildcard ok) | |
--contents <labels> |
restrict to these value labels (comma-separated) | |
--stand <date> |
only data newer than this date (DD.MM.YYYY) | |
--structure |
include the dimension structure tree | |
--transpose |
transpose rows and columns | |
--compress |
compress repeated labels | |
--class-var1 <code> |
classifying variable 1 code | |
--class-key1 <key> |
classifying key 1 (value selection) | |
--class-var2 <code> |
classifying variable 2 code | |
--class-key2 <key> |
classifying key 2 (value selection) | |
--class-var3 <code> |
classifying variable 3 code | |
--class-key3 <key> |
classifying key 3 (value selection) | |
--class-var4 <code> |
classifying variable 4 code | |
--class-key4 <key> |
classifying key 4 (value selection) | |
--class-var5 <code> |
classifying variable 5 code | |
--class-key5 <key> |
classifying key 5 (value selection) |
destatis data timeseries
Fetch a time series (data/timeseries)
destatis data timeseries [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area | |
--start-year <year> |
earliest year (YYYY) | |
--end-year <year> |
latest year (YYYY) | |
--timeslices <n> |
number of time slices from the end | |
--region-var <code> |
regional variable code | |
--region-key <key> |
regional key (e.g. a Land/Kreis code, `*` wildcard ok) | |
--contents <labels> |
restrict to these value labels (comma-separated) | |
--stand <date> |
only data newer than this date (DD.MM.YYYY) | |
--structure |
include the dimension structure tree | |
--transpose |
transpose rows and columns | |
--compress |
compress repeated labels | |
--class-var1 <code> |
classifying variable 1 code | |
--class-key1 <key> |
classifying key 1 (value selection) | |
--class-var2 <code> |
classifying variable 2 code | |
--class-key2 <key> |
classifying key 2 (value selection) | |
--class-var3 <code> |
classifying variable 3 code | |
--class-key3 <key> |
classifying key 3 (value selection) | |
--class-var4 <code> |
classifying variable 4 code | |
--class-key4 <key> |
classifying key 4 (value selection) | |
--class-var5 <code> |
classifying variable 5 code | |
--class-key5 <key> |
classifying key 5 (value selection) |
destatis data result
Fetch a saved result table (data/result)
destatis data result [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--area <area> |
data area | |
--start-year <year> |
earliest year (YYYY) | |
--end-year <year> |
latest year (YYYY) | |
--timeslices <n> |
number of time slices from the end | |
--region-var <code> |
regional variable code | |
--region-key <key> |
regional key (e.g. a Land/Kreis code, `*` wildcard ok) | |
--contents <labels> |
restrict to these value labels (comma-separated) | |
--stand <date> |
only data newer than this date (DD.MM.YYYY) | |
--structure |
include the dimension structure tree | |
--transpose |
transpose rows and columns | |
--compress |
compress repeated labels | |
--class-var1 <code> |
classifying variable 1 code | |
--class-key1 <key> |
classifying key 1 (value selection) | |
--class-var2 <code> |
classifying variable 2 code | |
--class-key2 <key> |
classifying key 2 (value selection) | |
--class-var3 <code> |
classifying variable 3 code | |
--class-key3 <key> |
classifying key 3 (value selection) | |
--class-var4 <code> |
classifying variable 4 code | |
--class-key4 <key> |
classifying key 4 (value selection) | |
--class-var5 <code> |
classifying variable 5 code | |
--class-key5 <key> |
classifying key 5 (value selection) |
destatis data tablefile
Download a table as a file (ZIP) — use -o <file>
destatis data tablefile [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--format <fmt> |
download format Werte: datencsv, csv, ffcsv, xlsx, html, genml | |
--area <area> |
data area | |
--start-year <year> |
earliest year (YYYY) | |
--end-year <year> |
latest year (YYYY) | |
--timeslices <n> |
number of time slices from the end | |
--region-var <code> |
regional variable code | |
--region-key <key> |
regional key (e.g. a Land/Kreis code, `*` wildcard ok) | |
--contents <labels> |
restrict to these value labels (comma-separated) | |
--stand <date> |
only data newer than this date (DD.MM.YYYY) | |
--structure |
include the dimension structure tree | |
--transpose |
transpose rows and columns | |
--compress |
compress repeated labels | |
--class-var1 <code> |
classifying variable 1 code | |
--class-key1 <key> |
classifying key 1 (value selection) | |
--class-var2 <code> |
classifying variable 2 code | |
--class-key2 <key> |
classifying key 2 (value selection) | |
--class-var3 <code> |
classifying variable 3 code | |
--class-key3 <key> |
classifying key 3 (value selection) | |
--class-var4 <code> |
classifying variable 4 code | |
--class-key4 <key> |
classifying key 4 (value selection) | |
--class-var5 <code> |
classifying variable 5 code | |
--class-key5 <key> |
classifying key 5 (value selection) |
destatis data cubefile
Download a cube as a file (ZIP) — use -o <file>
destatis data cubefile [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--format <fmt> |
download format Werte: datencsv, csv, ffcsv, xlsx, html, genml | |
--area <area> |
data area | |
--start-year <year> |
earliest year (YYYY) | |
--end-year <year> |
latest year (YYYY) | |
--timeslices <n> |
number of time slices from the end | |
--region-var <code> |
regional variable code | |
--region-key <key> |
regional key (e.g. a Land/Kreis code, `*` wildcard ok) | |
--contents <labels> |
restrict to these value labels (comma-separated) | |
--stand <date> |
only data newer than this date (DD.MM.YYYY) | |
--structure |
include the dimension structure tree | |
--transpose |
transpose rows and columns | |
--compress |
compress repeated labels | |
--class-var1 <code> |
classifying variable 1 code | |
--class-key1 <key> |
classifying key 1 (value selection) | |
--class-var2 <code> |
classifying variable 2 code | |
--class-key2 <key> |
classifying key 2 (value selection) | |
--class-var3 <code> |
classifying variable 3 code | |
--class-key3 <key> |
classifying key 3 (value selection) | |
--class-var4 <code> |
classifying variable 4 code | |
--class-key4 <key> |
classifying key 4 (value selection) | |
--class-var5 <code> |
classifying variable 5 code | |
--class-key5 <key> |
classifying key 5 (value selection) |
destatis data timeseriesfile
Download a time series as a file (ZIP) — use -o <file>
destatis data timeseriesfile [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--format <fmt> |
download format Werte: datencsv, csv, ffcsv, xlsx, html, genml | |
--area <area> |
data area | |
--start-year <year> |
earliest year (YYYY) | |
--end-year <year> |
latest year (YYYY) | |
--timeslices <n> |
number of time slices from the end | |
--region-var <code> |
regional variable code | |
--region-key <key> |
regional key (e.g. a Land/Kreis code, `*` wildcard ok) | |
--contents <labels> |
restrict to these value labels (comma-separated) | |
--stand <date> |
only data newer than this date (DD.MM.YYYY) | |
--structure |
include the dimension structure tree | |
--transpose |
transpose rows and columns | |
--compress |
compress repeated labels | |
--class-var1 <code> |
classifying variable 1 code | |
--class-key1 <key> |
classifying key 1 (value selection) | |
--class-var2 <code> |
classifying variable 2 code | |
--class-key2 <key> |
classifying key 2 (value selection) | |
--class-var3 <code> |
classifying variable 3 code | |
--class-key3 <key> |
classifying key 3 (value selection) | |
--class-var4 <code> |
classifying variable 4 code | |
--class-key4 <key> |
classifying key 4 (value selection) | |
--class-var5 <code> |
classifying variable 5 code | |
--class-key5 <key> |
classifying key 5 (value selection) |
destatis data resultfile
Download a saved result as a file (ZIP) — use -o <file>
destatis data resultfile [options] <name>Argumente
<name>erforderlich- object code (must be non-empty)
Optionen
| Option | Beschreibung | Standard |
|---|---|---|
--format <fmt> |
download format Werte: datencsv, csv, ffcsv, xlsx, html, genml | |
--area <area> |
data area | |
--start-year <year> |
earliest year (YYYY) | |
--end-year <year> |
latest year (YYYY) | |
--timeslices <n> |
number of time slices from the end | |
--region-var <code> |
regional variable code | |
--region-key <key> |
regional key (e.g. a Land/Kreis code, `*` wildcard ok) | |
--contents <labels> |
restrict to these value labels (comma-separated) | |
--stand <date> |
only data newer than this date (DD.MM.YYYY) | |
--structure |
include the dimension structure tree | |
--transpose |
transpose rows and columns | |
--compress |
compress repeated labels | |
--class-var1 <code> |
classifying variable 1 code | |
--class-key1 <key> |
classifying key 1 (value selection) | |
--class-var2 <code> |
classifying variable 2 code | |
--class-key2 <key> |
classifying key 2 (value selection) | |
--class-var3 <code> |
classifying variable 3 code | |
--class-key3 <key> |
classifying key 3 (value selection) | |
--class-var4 <code> |
classifying variable 4 code | |
--class-key4 <key> |
classifying key 4 (value selection) | |
--class-var5 <code> |
classifying variable 5 code | |
--class-key5 <key> |
classifying key 5 (value selection) |