API-Dokumentation

REST-API für programmatischen Zugriff auf das PledgeBook-Register. Ideal für Banken, Kreditinstitute und Finanzdienstleister zur automatisierten Pfandrechtsprüfung.

Authentifizierung

Alle API-Endpunkte (außer /api/v1/status) erfordern einen gültigen API-Key im Header:

X-PledgeBook-API-Key: pb_live_IhrKeyHier...

API-Keys erhalten Sie über die Zugangsseite. Jeder Key hat ein Standard-Limit von 1.000 Anfragen pro Stunde.

Rate Limiting

Jeder API-Key hat ein konfigurierbares Anfrage-Limit pro Stunde (Standard: 1.000). Bei Überschreitung erhalten Sie einen 429-Statuscode:

{
  "error": "Rate Limit erreicht. Versuchen Sie es später erneut."
}

Stufe-2-Zugang (Consent-Token)

Standardmäßig liefert die API nur Stufe-1-Daten (Existenz der Belastung, Kategorie, Gläubiger, Rang). Für Stufe-2-Daten (Beträge, Fälligkeiten, Vertragspartner) benötigen Sie einen Consent-Token.

So erhalten Sie einen Token:

Registrieren Sie sich als Gläubiger auf PledgeBook
Fordern Sie eine Detailauskunft für das gewünschte Unternehmen an
Das Unternehmen gibt die Detailauskunft frei
Sie erhalten einen Consent-Token per E-Mail und im Dashboard

Verwenden Sie den Token im Header:

X-PledgeBook-Consent-Token: eyJkYXJJZCI6ImNs...

Bei gültigem Token enthält die Antwort "dataTier": "stufe2" und zusätzliche Felder wie betrag, gesicherteForderung und faelligAm. Ungültige oder abgelaufene Tokens führen nicht zu einem Fehler — die API gibt einfach Stufe-1-Daten zurück.

Basis-URL

https://pledgebook.at/api/v1

Alle Antworten werden im JSON-Format zurückgegeben.

Endpunkte

GET/api/v1/search/company

Firmensuche nach FN

Sucht eine Firma anhand der Firmenbuchnummer. Gibt die Firma mit allen Assets und deren Pfandrechten zurück.

Authentifizierung erforderlich

Parameter

Name	Typ	Beschreibung
fn	string	Firmenbuchnummer (z.B. 123456a)

cURL

curl -X GET "https://pledgebook.at/api/v1/search/company?fn=123456a" \
  -H "X-PledgeBook-API-Key: pb_live_IhrKeyHier"

JavaScript

const res = await fetch(
  "https://pledgebook.at/api/v1/search/company?fn=123456a",
  {
    headers: {
      "X-PledgeBook-API-Key": "pb_live_IhrKeyHier"
    }
  }
);
const data = await res.json();
console.log(data.result);

Python

import requests

response = requests.get(
    "https://pledgebook.at/api/v1/search/company",
    params={"fn": "123456a"},
    headers={"X-PledgeBook-API-Key": "pb_live_IhrKeyHier"}
)
data = response.json()
print(data["result"])

Beispiel-Antwort

{
  "result": {
    "fn": "123456a",
    "name": "TechStartup GmbH",
    "rechtsform": "GmbH",
    "sitz": "Wien",
    "assets": [
      {
        "id": "clx...",
        "bezeichnung": "SaaS-Lizenzforderungen",
        "kategorie": "ABONNEMENT_FORDERUNGEN",
        "gruppe": "FORDERUNGEN_VERTRAEGE",
        "status": "VERPFAENDET",
        "pledges": [
          {
            "id": "clx...",
            "rang": 1,
            "creditorName": "Erste Bank AG",
            "creditorType": "BANK",
            "amount": 30000,
            "securedClaim": "Betriebsmittelkredit",
            "maturityDate": "2025-12-31T00:00:00.000Z",
            "status": "AKTIV"
          }
        ]
      }
    ]
  }
}

GET/api/v1/search/asset

Asset-Suche

Sucht Assets anhand von Bezeichnung oder Registernummer. Gibt die Assets mit zugehöriger Firma und Pfandrechten zurück.

Authentifizierung erforderlich

Parameter

Name	Typ	Beschreibung
q	string	Suchbegriff (Bezeichnung oder Registernummer)

cURL

curl -X GET "https://pledgebook.at/api/v1/search/asset?q=SaaS-Lizenz" \
  -H "X-PledgeBook-API-Key: pb_live_IhrKeyHier"

JavaScript

const res = await fetch(
  "https://pledgebook.at/api/v1/search/asset?q=SaaS-Lizenz",
  {
    headers: {
      "X-PledgeBook-API-Key": "pb_live_IhrKeyHier"
    }
  }
);
const data = await res.json();
console.log(data.results);

Python

import requests

response = requests.get(
    "https://pledgebook.at/api/v1/search/asset",
    params={"q": "SaaS-Lizenz"},
    headers={"X-PledgeBook-API-Key": "pb_live_IhrKeyHier"}
)
data = response.json()
print(data["results"])

Beispiel-Antwort

{
  "results": [
    {
      "id": "clx...",
      "bezeichnung": "SaaS-Lizenzforderungen",
      "kategorie": "ABONNEMENT_FORDERUNGEN",
      "status": "VERPFAENDET",
      "company": {
        "fn": "123456a",
        "name": "TechStartup GmbH",
        "rechtsform": "GmbH",
        "sitz": "Wien"
      },
      "pledges": [
        {
          "id": "clx...",
          "rang": 1,
          "creditorName": "Erste Bank AG",
          "amount": 30000,
          "status": "AKTIV"
        }
      ]
    }
  ]
}

GET/api/v1/search/creditor

Gläubigersuche

Sucht alle aktiven Pfandrechte eines bestimmten Gläubigers anhand des Namens oder der Firmenbuchnummer.

Authentifizierung erforderlich

Parameter

Name	Typ	Beschreibung
name	string	Name oder FN des Gläubigers (Teilstring-Suche)

cURL

curl -X GET "https://pledgebook.at/api/v1/search/creditor?name=Erste%20Bank" \
  -H "X-PledgeBook-API-Key: pb_live_IhrKeyHier"

JavaScript

const res = await fetch(
  "https://pledgebook.at/api/v1/search/creditor?name=Erste%20Bank",
  {
    headers: {
      "X-PledgeBook-API-Key": "pb_live_IhrKeyHier"
    }
  }
);
const data = await res.json();
console.log(data.results);

Python

import requests

response = requests.get(
    "https://pledgebook.at/api/v1/search/creditor",
    params={"name": "Erste Bank"},
    headers={"X-PledgeBook-API-Key": "pb_live_IhrKeyHier"}
)
data = response.json()
print(data["results"])

Beispiel-Antwort

{
  "results": [
    {
      "id": "clx...",
      "creditorName": "Erste Bank AG",
      "creditorType": "BANK",
      "creditorFn": "33209m",
      "amount": 30000,
      "securedClaim": "Betriebsmittelkredit",
      "maturityDate": "2025-12-31T00:00:00.000Z",
      "status": "AKTIV",
      "assets": [
        {
          "id": "clx...",
          "bezeichnung": "SaaS-Lizenzforderungen",
          "kategorie": "ABONNEMENT_FORDERUNGEN",
          "status": "VERPFAENDET",
          "rang": 1,
          "company": {
            "fn": "123456a",
            "name": "TechStartup GmbH"
          }
        }
      ]
    }
  ]
}

POST/api/v1/search/bulk

Massensuche nach FN

Sucht bis zu 50 Firmen gleichzeitig anhand ihrer Firmenbuchnummern. Ideal für Batch-Prüfungen bei Kreditportfolios.

Authentifizierung erforderlich

Parameter

Name	Typ	Beschreibung
fns	string[]	Array von Firmenbuchnummern (max. 50 pro Anfrage)

cURL

curl -X POST "https://pledgebook.at/api/v1/search/bulk" \
  -H "X-PledgeBook-API-Key: pb_live_IhrKeyHier" \
  -H "Content-Type: application/json" \
  -d '{"fns": ["123456a", "789012b", "345678c"]}'

JavaScript

const res = await fetch(
  "https://pledgebook.at/api/v1/search/bulk",
  {
    method: "POST",
    headers: {
      "X-PledgeBook-API-Key": "pb_live_IhrKeyHier",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      fns: ["123456a", "789012b", "345678c"]
    })
  }
);
const data = await res.json();
console.log(data.results);

Python

import requests

response = requests.post(
    "https://pledgebook.at/api/v1/search/bulk",
    headers={
        "X-PledgeBook-API-Key": "pb_live_IhrKeyHier",
        "Content-Type": "application/json"
    },
    json={"fns": ["123456a", "789012b", "345678c"]}
)
data = response.json()
print(data["results"])

Beispiel-Antwort

{
  "results": [
    {
      "queriedFn": "123456a",
      "found": true,
      "fn": "123456a",
      "name": "TechStartup GmbH",
      "rechtsform": "GmbH",
      "sitz": "Wien",
      "assets": [...]
    },
    {
      "queriedFn": "789012b",
      "found": false
    },
    {
      "queriedFn": "345678c",
      "found": true,
      "fn": "345678c",
      "name": "InnoSoft AG",
      "assets": [...]
    }
  ]
}

GET/api/v1/status

Öffentlicher Endpunkt (kein API-Key erforderlich). Gibt den aktuellen Status des Registers zurück, inklusive Gesamtzahlen und Integritätsstatus der Hash-Chain.

cURL

curl -X GET "https://pledgebook.at/api/v1/status"

JavaScript

const res = await fetch("https://pledgebook.at/api/v1/status");
const data = await res.json();
console.log(data);

Python

import requests

response = requests.get("https://pledgebook.at/api/v1/status")
data = response.json()
print(data)

Beispiel-Antwort

{
  "status": "operational",
  "totalCompanies": 142,
  "totalAssets": 1283,
  "totalPledges": 89,
  "chainValid": true,
  "chainEntries": 4521,
  "lastUpdated": "2026-03-22T10:15:00.000Z"
}

Fehlercodes

Code	Bedeutung
400	Ungültige Anfrage (fehlende Parameter, ungültiger Body)
401	API-Key fehlt
403	Ungültiger oder deaktivierter API-Key
429	Rate Limit überschritten
500	Serverfehler