Commands

Every command, argument and option of entgeltatlas 0.0.5, read from the CLI itself.

Global options

These options work with every command.

OptionDescriptionDefault
-V, --version output the version number
--base-url <url> API base URL https://rest.arbeitsagentur.de
--api-key <key> X-API-Key header value (env: ENTGELTATLAS_API_KEY)
--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
--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

entgeltatlas obtain-key

Obtain the public X-API-Key this API requires and print it. The key is published by the Bundesagentur für Arbeit and is not a secret; none is bundled with this package, so it is read from the source at run time.

entgeltatlas obtain-key [options]

Options

OptionDescriptionDefault
--export print "export ENTGELTATLAS_API_KEY=<key>" for use with eval

entgeltatlas entgelte

Gross-salary statistics for a KldB-2010 occupation code

entgeltatlas entgelte [options] <kldb>

Arguments

<kldb> required
KldB-2010 occupation code (3–5 digits, e.g. 84304)

Options

OptionDescriptionDefault
-l, --level <code> Anforderungsniveau 1–4 (see `codes`)
-r, --region <code> Region 1–30 (see `codes`)
-g, --gender <code> Geschlecht 1–3 (see `codes`)
-a, --age <code> Alter 1–4 (see `codes`)
-b, --branch <code> Branche 1–11 (see `codes`)

entgeltatlas codes

Print the dimension code tables (l/r/g/a/b) — works offline, no API key

entgeltatlas codes [options]