Authentifizierung

Zur Verwendung der API musst du dich mit einem API-Key authentifizieren. Dazu wird HTTP Basic Authentication verwendet. Der API-Key ist als Benutzernamen einzugeben. Ein Passwort ist nicht erforderlich.

Der Host für alle APIs lautet: http://api.opendata.host/

registered-companies/find

Sucht bestimmte (alle) registrierten Firmen aus dem österreichischen Firmenbuch. Die Suche erfolgt über den Firmennamen oder die Firmenbuchnummer.

Pro Request werden kostenfrei maximal 100 Datensätze ausgegeben.
 

URL:

http://api.opendata.host/1.0/registered-company/find?country=xx&reg-no-class=xxx&reg-no=xxx&company-name=xxx&limit=xxx&offset=xxx

 

Beispiel:

http://api.opendata.host/1.0/registered-companies/find?company-name=orf&offset=2&limit=3

 

Parameter

country	Land, default at
reg-no-class	In welchem Register steht die Identifikationsnummer, Default at-fb
reg-no	Identifikationsnummer aus dem angegebenen Register
company-name	Teil des Namens der Firma. Derzeit nur "like"-search --> Firmenname beginnt mit ...
limit	Anzahl der maximal angezeigten Ergebniss, default 100
offset	Index des Startelements, default 0

 

Resultat

Erfolg

registered-companies/find?country=at&reg-no-class=at-fb&company-name=compass-datenbank
{
  "offset": 0,
  "limit": 100,
  "size": 1,
  "errorCode": 0,
  "companies": [
    {
      "country": "at",
      "reg-no-class": "at-fb",
      "reg-no": "092117t",
      "reg-status": "registered",
      "business-name": "Compass-Datenbank GmbH",
      "legal-form": "Gesellschaft mit beschränkter Haftung",
      "registered-office": "politischer Gemeinde Wien",
      "business-address": {
        "country": "AUT",
        "postal-code": "1140",
        "street-address": "Matznergasse",
        "street-number": "17"
      }
    }
  ]
}

Fehler

registered-companies/find?company-name=ichbineineunbekanntefirma
{
  "size": 0,
  "errorCode": 1,
  "errorMessage": "No results found"
}

Fehlercodes

Folgende Fehlercodes werden verwendet

0	Erfolg	keine Message
1	Keine Resultate gefunden	No results found
2	Keine Daten bei Compass gefunden	No data available
3	Eingabeparameter entsprechen nicht dem erwarteten Format (z.B. Firmennummer)	Invalid input format
4	Suche zu allgemein	Please narrow your search conditions
5	Unerwarteter Fehler	Internal error