Commands

Every command, argument and option of fit-connect 0.5.1, 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://routing-api-prod.fit-connect.fitko.net
--api-version <version> Routing API version: v1 or v2 v2
--timeout <ms> time limit per request in milliseconds, whole response included (0 disables)
--user-agent <ua> User-Agent header value (blank falls back to default; some values are blocked by the API)
--max-retries <n> retries for transient 429/503 responses and reset connections (0..10; each backs off, or waits a longer Retry-After or RateLimit-Reset, up to 30 s)
--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

fit-connect routes

Find the responsible authority (Zustellpunkt) for a public service in an area. Provide exactly one area selector: --ags, --ars or --area-id.

fit-connect routes [options] <leikaKey>

Arguments

<leikaKey> required

Options

OptionDescriptionDefault
--ags <ags> Amtlicher Gemeindeschlüssel: 2, 3, 5 or 8 digits (Land, Regierungsbezirk, Kreis, Gemeinde)
--ars <ars> Amtlicher Regionalschlüssel: 2, 3, 5, 9 or 12 digits (Land, Regierungsbezirk, Kreis, Gemeindeverband, Gemeinde)
--area-id <id> Area id from `fit-connect areas`: a positive whole number without leading zeros
--offset <n> start offset into the result set, 0..2147483647 with offset + limit at most 2147483647 (default 0)
--limit <n> page size, 1..500 (default 100)

fit-connect areas

Search areas by name and/or postal code. Supports the `*` wildcard, e.g. `areas "Mag*"`. Terms are split into words on spaces and punctuation, and every word must match the same area. Each word needs at least 2 letters or digits (shorter ones are left out), and at most 10 words are allowed. Use a result's id as --area-id for `fit-connect routes`.

fit-connect areas [options] <query...>

Arguments

<query…> required

Options

OptionDescriptionDefault
--offset <n> start offset into the result set, 0..2147483647 with offset + limit at most 2147483647 (default 0)
--limit <n> page size, 1..500 (default 100)

fit-connect info

Show the version of the deployed Routing API instance

fit-connect info [options]