Rychlý start

Tvůj první profil firmy za pět minut.

Potřebuješ účet a terminál. Na konci budeš mít ukázkovým požadavkem načtený profil firmy Hetzner Online GmbH a budeš vědět, co odpověď obsahuje.

Zkopíruj API klíč

Založ si bezplatný účet a potvrď svou e-mailovou adresu. Dostaneš 150 startovních kreditů s platností 30 dní.

Tvůj první API klíč na tebe už čeká v Účet › API klíče. Zkopíruj ho a zacházej s ním jako s heslem.

Každý požadavek posílá klíč v headeru x-api-key. V příkladech za něj stojí TVUJ_API_KLIC.

Pokud API odpoví 401, klíč chybí nebo nebyl zkopírován celý. Při 403 ještě není potvrzena tvoje e-mailová adresa. Potvrzovací odkaz najdeš ve své schránce.

Načti profil firmy

Zavolej fetch-organization a předej název firmy v parametru q. Bez dalších parametrů dostaneš základní údaje za 5 kreditů.

Zkopíruj požadavek, vlož svůj klíč a spusť ho. cURL vypíše JSON přímo. V Pythonu a JavaScriptu je odpověď pak v data. Pomocí print(data["name"]) nebo console.log(data.name) uvidíš název firmy.

curl -G "https://handelsregister.ai/api/v1/fetch-organization" \
  -H "x-api-key: TVUJ_API_KLIC" \
  --data-urlencode 'q=Hetzner Online GmbH'

import requests

response = requests.get(
    "https://handelsregister.ai/api/v1/fetch-organization",
    headers={"x-api-key": "TVUJ_API_KLIC"},
    params={
        "q": "Hetzner Online GmbH",
    },
)
data = response.json()

const url = new URL("https://handelsregister.ai/api/v1/fetch-organization");
url.searchParams.append("q", "Hetzner Online GmbH");

const response = await fetch(url, {
  headers: { "x-api-key": "TVUJ_API_KLIC" },
});
const data = await response.json();

Přečti odpověď

Odpovědí je profil firmy jako JSON. Tato pole potřebuješ nejčastěji:

Přečti odpověď
Pole	Význam
entity_id	ID firmy v handelsregister.ai. Ulož si ho pro navazující požadavky.
name, legal_form, status	Název firmy, právní forma a stav v rejstříku, v příkladu `ACTIVE`.
registration	Rejstříkový soud, typ rejstříku a rejstříkové číslo, v příkladu Ansbach HRB 6089.
address, seat	Obchodní adresa se souřadnicemi a k tomu sídlo podle rejstříku.
purpose, industry_classification	Předmět podnikání a odvětví podle WZ 2008 a WZ 2025.
representation_scheme	Způsob zastupování: `current` platí dnes, `history` ukazuje každý zapsaný stav.
meta	Kolik požadavek stál (`request_credit_cost`) a tvůj zůstatek poté (`credits_remaining`).

1{2  "entity_id": "94eb910fef13f94585c48c263fa446d4",3  "name": "Hetzner Online GmbH",4  "status": "ACTIVE",5  "legal_form": "GmbH",6  "registration": {7    "court": "Ansbach",8    "register_type": "HRB",9    "register_number": "6089"10  },11  "industry_classification": {12    "WZ2008": [13      {14        "code": "62.01.0",15        "label": "Erbringung von Dienstleistungen der Informationstechnologie"16      },17      {18        "code": "63.11.0",19        "label": "Datenverarbeitung, Hosting und damit verbundene Tätigkeiten"20      },21      {22        "code": "61.90.0",23        "label": "Telekommunikation, sonstige"24      }25    ],26    "WZ2025": [27      {28        "code": "62.20.1",29        "label": "Erbringung von Beratungsleistungen auf dem Gebiet der Informationstechnologie"30      },31      {32        "code": "46.50.1",33        "label": "Großhandel mit Datenverarbeitungsgeräten, peripheren Geräten und Software"34      },35      {36        "code": "62.90.0",37        "label": "Erbringung von sonstigen Dienstleistungen der Informationstechnologie"38      }39    ]40  },41  "address": {42    "house_number": "25",43    "street": "Industriestraße",44    "postal_code": "91710",45    "city": "Gunzenhausen",46    "county": "Weißenburg-Gunzenhausen",47    "state": "Bayern",48    "country": "DEU",49    "coordinates": {50      "latitude": 49.12483,51      "longitude": 10.7805252    }53  },54  "seat": {55    "city": "Gunzenhausen"56  },57  "registration_date": null,58  "representation_scheme": {59    "current": [60      "Ist nur ein Geschäftsführer bestellt, so vertritt er die Gesellschaft allein. Sind mehrere Geschäftsführer bestellt, so wird die Gesellschaft durch zwei Geschäftsführer oder durch einen Geschäftsführer gemeinsam mit einem Prokuristen vertreten."61    ],62    "history": [63      {64        "value": [65          "Ist nur ein Vorstandsmitglied bestellt, so vertritt es die Gesellschaft allein. Sind mehrere Vorstandsmitglieder bestellt, so wird die Gesellschaft durch zwei Vorstandsmitglieder oder durch ein Vorstandsmitglied gemeinsam mit einem Prokuristen vertreten."66        ],67        "effective_from": "2002-10-15",68        "effective_to": "2015-07-28"69      },70      {71        "value": [72          "Ist nur ein Geschäftsführer bestellt, so vertritt er die Gesellschaft allein. Sind mehrere Geschäftsführer bestellt, so wird die Gesellschaft durch zwei Geschäftsführer oder durch einen Geschäftsführer gemeinsam mit einem Prokuristen vertreten."73        ],74        "effective_from": "2015-07-28",75        "effective_to": null76      }77    ]78  },79  "purpose": "Die Durchführung von Internet- und Netzwerkdienstleistungen, das Erstellen und Vertreiben von Software, der Handel mit Hard- und Software, der Betrieb einer Werbeagentur,darüber hinaus der Im- und Export von Waren aller Art, soweit sie keiner Einfuhr- oder Ausfuhrbeschränkung unterliegen und soweit keine Genehmigungen erforderlich sind.",80  "meta": {81    "request_credit_cost": 5,82    "credits_remaining": 14583  }84}

200 · Ukázková odpověď pro Hetzner Online GmbH, jen základní údaje

S entity_id se později na stejnou firmu zeptáš přímo. Je to také klíč pro fetch-document a Signals. Rejstříkový soud a rejstříkové číslo jsou stejně jednoznačné, v příkladu Ansbach HRB 6089.

curl -G "https://handelsregister.ai/api/v1/fetch-organization" \
  -H "x-api-key: TVUJ_API_KLIC" \
  --data-urlencode 'q=94eb910fef13f94585c48c263fa446d4'

import requests

response = requests.get(
    "https://handelsregister.ai/api/v1/fetch-organization",
    headers={"x-api-key": "TVUJ_API_KLIC"},
    params={
        "q": "94eb910fef13f94585c48c263fa446d4",
    },
)
data = response.json()

const url = new URL("https://handelsregister.ai/api/v1/fetch-organization");
url.searchParams.append("q", "94eb910fef13f94585c48c263fa446d4");

const response = await fetch(url, {
  headers: { "x-api-key": "TVUJ_API_KLIC" },
});
const data = await response.json();

Kam dál

Přidat funkce Jednatelé, společníci nebo finance ve stejném požadavku. Načíst firmu podle rejstříkového čísla Jednoznačná cesta přes rejstříkový soud, rejstříkové číslo a entity_id. Základní pojmy Jak fungují kredity, režim v reálném čase, historie a prázdné hodnoty. Plugin pro ChatGPT Stejná data v chatu, bez kódu. Python SDK API v Pythonu, s hotovými metodami. Node SDK API v JavaScriptu a TypeScriptu.