Início rápido

Seu primeiro perfil de empresa em cinco minutos.

Você precisa de uma conta e de um terminal. No fim, você terá obtido o perfil da Hetzner Online GmbH com uma requisição de exemplo e saberá o que a resposta contém.

Copie sua chave de API

Crie uma conta gratuita e confirme seu endereço de e-mail. Você recebe 150 créditos iniciais, válidos por 30 dias.

Sua primeira chave de API já está esperando por você em Conta › Chaves de API. Copie-a e trate-a como uma senha.

Toda requisição envia a chave no header x-api-key. Os exemplos usam SUA_CHAVE_DE_API no lugar dela.

Se a API responder com 401, a chave está faltando ou não foi copiada por inteiro. Com 403, seu endereço de e-mail ainda não está confirmado. O link de confirmação está na sua caixa de entrada.

Obtenha um perfil de empresa

Chame fetch-organization e passe o nome da empresa no parâmetro q. Sem outros parâmetros, você recebe os dados básicos por 5 créditos.

Copie a requisição, insira sua chave e execute. O cURL imprime o JSON diretamente. Em Python e JavaScript, a resposta fica em data. Com print(data["name"]) ou console.log(data.name) você vê o nome da empresa.

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

import requests

response = requests.get(
    "https://handelsregister.ai/api/v1/fetch-organization",
    headers={"x-api-key": "SUA_CHAVE_DE_API"},
    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": "SUA_CHAVE_DE_API" },
});
const data = await response.json();

Leia a resposta

A resposta é o perfil da empresa em JSON. Estes são os campos que você mais usa:

Leia a resposta
Campo	Significado
entity_id	O ID da empresa no handelsregister.ai. Guarde-o para requisições seguintes.
name, legal_form, status	Nome da empresa, forma jurídica e situação no registro, no exemplo `ACTIVE`.
registration	Tribunal de registro, tipo de registro e número de registro, no exemplo Ansbach HRB 6089.
address, seat	Endereço comercial com coordenadas, mais a sede segundo o registro.
purpose, industry_classification	Objeto social e setor segundo a WZ 2008 e a WZ 2025.
representation_scheme	Regras de representação: `current` vale hoje, `history` mostra cada estado registrado.
meta	Quanto a requisição custou (`request_credit_cost`) e o seu saldo depois (`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 · Resposta de exemplo para a Hetzner Online GmbH, só dados básicos

Com o entity_id, você consulta a mesma empresa diretamente depois. Ele também é a chave para fetch-document e Signals. Tribunal de registro e número de registro são igualmente únicos, no exemplo Ansbach HRB 6089.

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

import requests

response = requests.get(
    "https://handelsregister.ai/api/v1/fetch-organization",
    headers={"x-api-key": "SUA_CHAVE_DE_API"},
    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": "SUA_CHAVE_DE_API" },
});
const data = await response.json();

Para onde seguir

Adicionar recursos Diretores, sócios ou finanças na mesma requisição. Obter uma empresa pelo número de registro O caminho único por tribunal de registro, número de registro e entity_id. Conceitos básicos Como funcionam créditos, Tempo real, histórico e valores vazios. Plugin do ChatGPT Os mesmos dados num chat, sem nenhum código. Python SDK A API em Python, com métodos prontos. Node SDK A API em JavaScript e TypeScript.