SDK for JavaScript and TypeScript

npm install @quellenkontor/sdk

pnpm add @quellenkontor/sdk
yarn add @quellenkontor/sdk
bun add @quellenkontor/sdk

import { Quellenkontor } from "@quellenkontor/sdk";

// reads the key from QK_KEY
const qk = new Quellenkontor();

// or explicitly, with options
const qk2 = new Quellenkontor({
  apiKey: process.env.QK_KEY,
  timeoutMs: 10_000,
  wiederholungen: 3,
});

const qk = new Quellenkontor({ cache: false }); // always a fresh request

// or clear the cache on purpose, for example after a webhook
const qk2 = new Quellenkontor();
qk2.cacheLeeren();

const qk = new Quellenkontor({ offline: false }); // always throw the network error instead

// with the offline fallback (default): recognizable by the offline field
const qkMitFallback = new Quellenkontor();
const ml = await qkMitFallback.hr.mindestlohn({ datum: "2027-01-15" });
if (ml.offline) console.warn("Offline data from", ml.datenstand);

const frist = await qk.hr.kuendigungsfrist({ eintritt: "2017-03-01", zugang: "2026-11-10" });
console.log(frist.ende); // "2027-02-28"

const laender = ["HE", "BY", "NW"] as const;
const ergebnisse = await Promise.all(laender.map((land) => qk.hr.feiertage({ jahr: 2027, land })));
for (const e of ergebnisse) console.log(e.land_name, e.anzahl);

const januar = await qk.hr.arbeitstage({ von: "2027-01-01", bis: "2027-01-31", land: "HE" });
console.log(januar.arbeitstage, januar.feiertage_an_arbeitstagen.map((f) => f.name));

const { verlauf } = await qk.hr.verlauf("rechengroessen");
for (const stufe of verlauf) await speichere(stufe); // your own function

import { Quellenkontor, QuellenkontorFehler } from "@quellenkontor/sdk";

try {
  const r = await qk.hr.rechengroessen({ jahr: 2030 });
} catch (e) {
  if (e instanceof QuellenkontorFehler && e.code === "kein_wert") {
    // Value not promulgated yet: show a notice instead of guessing
  } else if (e instanceof QuellenkontorFehler && e.status === 429) {
    // Quota used up
  } else {
    throw e;
  }
}

import { writeFile } from "node:fs/promises";

const csv = await qk.anfrage("/hr/feiertage", { jahr: 2027, land: "HE", trennzeichen: "semikolon" }, "csv");
await writeFile("feiertage-2027-he.csv", csv);

import { Quellenkontor } from "@quellenkontor/sdk";

const qk = new Quellenkontor();

export async function GET(request: Request) {
  const land = new URL(request.url).searchParams.get("land") ?? "HE";
  const daten = await qk.hr.feiertage({ jahr: 2027, land: land as "HE" });
  return Response.json(daten, { headers: { "Cache-Control": "s-maxage=86400" } });
}