Every command, argument and option of ausbildungssuche 0.0.6, read from the CLI itself.
These options work with every command.
| Option | Description | Default |
|---|---|---|
-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: AUSBILDUNGSSUCHE_API_KEY) | |
--timeout <ms> |
time limit per request in milliseconds, whole response included | |
--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 |
ausbildungssuche obtain-keyObtain 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.
ausbildungssuche obtain-key [options]Options
| Option | Description | Default |
|---|---|---|
--export |
print "export AUSBILDUNGSSUCHE_API_KEY=<key>" for use with eval |
ausbildungssuche searchSearch apprenticeship/training offers
ausbildungssuche search [options]Options
| Option | Description | Default |
|---|---|---|
--sw <text> |
search keyword (sw); currently ignored by the API, use --ids to filter by occupation | |
--sty <n> |
offer type 0..3 (sty); 4 is rejected with HTTP 400 | |
--orte <loc> |
location as "Name_lon_lat", longitude first, e.g. "Köln_6.957_50.938" (orte) | |
--re <code> |
Bundesland code (re), e.g. BAY, NRW, THÜ; comma-separated for several | |
--uk <radius> |
radius: "Bundesweit" or 10, 25, 50, 100 (km) | |
--ids <id> |
occupation id(s), the dkzId from angebot.systematiken[]; comma-separated for several (ids) | |
--bart <type> |
training type (bart) | |
--bg |
only offers eligible for an education voucher (bg) | |
--bt <date> |
start date (bt) | |
--page <n> |
0-based page | |
--size <n> |
page size (1..2000; the server returns at most 20 rows) |
ausbildungssuche detailsFull details for one apprenticeship offer by id
ausbildungssuche details [options] <id>Arguments
<id>
required