@maschinenlesbar.org/fit-connect-cli
    Preparing search index...

    @maschinenlesbar.org/fit-connect-cli

    fit-connect-cli

    CI Release npm

    Website: English · Deutsch — command reference, guides and API docs

    Find out which German authority is responsible for a public administrative service in a given place — straight from your terminal. fit-connect is a command-line tool over the open FIT-Connect Routing API (routing-api-prod.fit-connect.fitko.net) operated by the FITKO (Föderale IT-Kooperation).

    • Works out of the box — no account, no API key, no configuration. Install and query.
    • Read-only by design — this tool wraps only the Routing API. It does not implement the FIT-Connect Submission (write) path; it never sends an application or any personal data.
    • Clean JSON output — pretty-printed by default, --compact for one-line/scripting.
    • Three commands — routes (find the responsible Zustellpunkt), areas (resolve a place to an area id / codes), and info (API version).

    Want to use this as a TypeScript library or understand how it's built? See DEVELOPING.md.

    npm i -g @maschinenlesbar.org/fit-connect-cli

    This installs the fit-connect command. Requires Node.js 20+.

    Check it works:

    fit-connect --help

    A routing lookup answers "who handles service X in place Y?" and needs two inputs:

    • a Leistungsschlüssel (leikaKey) — the FIM service-catalogue key for the public service, a 14-digit 99… string. It identifies what service. This CLI does not discover service keys — bring one from the FIM-Portal / Leistungskatalog.
    • one area selector identifying where: --ars (Regionalschlüssel), --ags (Gemeindeschlüssel), or --area-id (an id from fit-connect areas).

    The result is one or more Zustellpunkte (delivery points): the responsible authority, its contacts, address, and service-specific notes.

    No setup needed — the API requires no key.

    # 1. Resolve a place to an area id
    fit-connect areas Hanau

    # 2. Route a service key into that area to find the responsible authority
    #    (99123456760610 is an illustrative key with no registered destinations,
    #     so these examples return an empty `routes: []` — that is normal, see below)
    fit-connect routes 99123456760610 --area-id 940

    # Already have the official codes? Skip step 1 (here: Erfurt, by Regionalschlüssel):
    fit-connect routes 99123456760610 --ars 160510000000

    routes <leikaKey> --ags|--ars|--area-id <code>   find the responsible authority
areas  <query...>                                 search areas by name / postal code
info                                              show the deployed Routing API version

    routes <leikaKey>

    Find the responsible destination(s) for a public service in an area. Requires a leikaKey and exactly one area selector.

    Option Description
    --ags <ags> Amtlicher Gemeindeschlüssel of the place
    --ars <ars> Amtlicher Regionalschlüssel of the area
    --area-id <id> Area id from fit-connect areas
    --offset <n> Start offset into the result set (default 0)
    --limit <n> Page size, 1..500 (default 100)

    A lookup that matches no registered destination is not an error — it returns {"count":0,…,"routes":[]} and exits 0.

    This tool does not verify destinationSignature. Each route carries a JWS (destinationSignature, RFC 7515) over its addressing information; the CLI returns it as an opaque, unverified string and performs no signature/crypto validation. Verify the JWS against FITKO's public FIT-Connect keys, per the FIT-Connect spec, before trusting destinationId to submit an application — otherwise a spoofed or MITM'd routing response could misdirect your submission.

    areas <query...>

    Search areas by name and/or postal code. Supports the * wildcard ("Mag*"). Multiple terms are combined with AND — every term must match the same area, so extra terms narrow the search (e.g. areas Frankfurt am Main) rather than searching several places at once. Terms are split into words on spaces and punctuation, so an official name like "Halle (Westf.)" works quoted. Each result has an id (use as --area-id), name, and type. Supports --offset / --limit.

    info

    Print the version of the deployed Routing API instance.

    # Which areas match a name? (a city + its Ortsteile come back)
    fit-connect areas "Halle"

    # Search by postal code
    fit-connect areas 60311

    # The responsible authority's name and email (jq)
    fit-connect --compact routes 99123456760610 --ars 160510000000 \
      | jq -r '.routes[] | "\(.destinationName)\t\(.contactPersons[0].email // "-")"'

    # Use the v1 (legacy) routing service instead of v2
    fit-connect --api-version v1 routes 99123456760610 --area-id 940

    # How many destinations are registered for a service in an area?
    fit-connect --compact routes 99123456760610 --ars 160510000000 | jq '.totalCount'

    See Usage.md for the full, use-case-driven cookbook.

    Every command prints pretty JSON to stdout; errors and diagnostics go to stderr, so piping stdout into jq stays clean. Use --compact for single-line JSON. --compact is a global option and works before or after the command.

    Exit codes:

    Code Meaning
    0 Success (also --help / --version; includes an empty routes: [])
    4 Not found — the API returned 404
    1 Any other API, network, parse, validation, or usage error
    • command not found: fit-connect — the global npm bin directory isn't on your PATH. Run npm bin -g to find it and add it, or run via npx @maschinenlesbar.org/fit-connect-cli ….
    • exactly one area selector error — routes needs precisely one of --ags / --ars / --area-id. Zero or two is rejected before any request.
    • Empty routes: [] — no FIT-Connect Zustellpunkt is registered for that service in that area. This is normal and exits 0, and it is the usual result: routing data is sparse, and many real service keys return no route in large cities too. Try a broader area (the Landkreis or Bundesland) or re-check the Leistungsschlüssel.
    • 403 / bot-detection — the Routing API filters on the User-Agent. The CLI's default UA is accepted, but some UA strings are blocked, so a custom --user-agent can trigger a 403. A missing or blank UA is not itself rejected — and the CLI falls back to its default for an empty value anyway.
    • 429 / rate limited — the CLI retries automatically and honours Retry-After. Raise --max-retries or slow down if it persists.

    These apply to every command and may go before or after it:

    Option Description
    -v, --version Print the version number
    -h, --help Show help for the program or a command
    --compact Print JSON on a single line instead of pretty-printed
    --base-url <url> API base URL (default https://routing-api-prod.fit-connect.fitko.net)
    --api-version <version> Routing API version, v1 or v2 (default v2; v1 is legacy)
    --timeout <ms> Time limit per request in ms, reading the whole response included (default 30000; 0 disables; at most 2147483647)
    --user-agent <ua> User-Agent header value (blank falls back to default; some values are blocked by the API's bot detection)
    --max-retries <n> Retries for transient 429/503 responses (default 2)
    --max-response-bytes <n> Cap response body size in bytes (0 = unlimited; default 100 MiB)
    • Usage.md — full use-case-driven cookbook.
    • GLOSSARY.md — every command, field, and domain term explained.
    • DEVELOPING.md — TypeScript library usage, architecture, testing, CI.
    • SKILLS.md — Claude Code Agent Skills bundled with this repo (find authority, area lookup, service briefing), installable as a plugin.

    This CLI deliberately wraps only the FIT-Connect Routing API — the read-only service that answers "who is responsible?". The FIT-Connect Submission/Destination APIs (the OAuth2-authenticated write path that actually transmits applications) are out of scope and not implemented here.

    This CLI is a client — it accesses data it does not own or redistribute. The upstream routing data is governed by the provider's terms, separately from this tool's code. See DATA_LICENSE.md.

    FITKO — FIT-Connect Routingdienst. No formal open-data license is declared on the Routing API (governed by the FIT-Connect terms of service). Crediting FITKO / FIT-Connect as the source is the good-faith default.

    Dual-licensed — use it under either:

    • AGPL-3.0-or-later (default, free). Note the AGPL's §13 network clause: if you run a modified version as a network service, you must offer that modified source to the service's users.
    • Commercial license (paid), for closed-source / proprietary or SaaS use without the AGPL's obligations.

    See LICENSING.md for details, and CONTRIBUTING.md for the contribution policy (this project does not accept external code contributions). Commercial enquiries: sebs@2xs.org.

    Settings
    Member Visibility

    On This Page
    fit-connect-cli