クイックスタート
5分で最初の企業プロフィールを取得。
必要なのはアカウントとターミナルだけです。最後には、例のリクエストでHetzner Online GmbHの企業プロフィールを取得し、レスポンスの内容がわかるようになります。
APIキーをコピーする
無料アカウントを作成し、メールアドレスを確認します。30 日間有効な 150 スタートクレジットが付きます。
最初のAPIキーは、すでにアカウント › APIキーに用意されています。コピーして、パスワードと同じように扱ってください。
すべてのリクエストは、キーをx-api-keyヘッダーで送ります。例ではYOUR_API_KEYをその代わりに使っています。
企業プロフィールを取得する
fetch-organizationを呼び出し、企業名をパラメータqで渡します。その他のパラメータがなければ、5 クレジットで基本データが得られます。
リクエストをコピーし、キーを入れて実行します。cURLはJSONをそのまま出力します。PythonとJavaScriptでは、レスポンスはdataに入ります。print(data["name"])またはconsole.log(data.name)で企業名が表示されます。
curl -G "https://handelsregister.ai/api/v1/fetch-organization" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode 'q=Hetzner Online GmbH'
import requests response = requests.get( "https://handelsregister.ai/api/v1/fetch-organization", headers={"x-api-key": "YOUR_API_KEY"}, 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": "YOUR_API_KEY" }, }); const data = await response.json();
レスポンスを読む
レスポンスはJSON形式の企業プロフィールです。最もよく使うフィールドは次のとおりです:
| フィールド | 意味 |
|---|---|
| entity_id | handelsregister.aiでの企業のID。後続リクエストのために保存してください。 |
| name, legal_form, status |
企業名、法的形態、登記ステータス(例ではACTIVE)。
|
| registration | 登記裁判所、登記簿の種類、登記番号(例ではAnsbach HRB 6089)。 |
| address, seat | 座標付きの営業所在地と、登記簿上の本店所在地。 |
| purpose, industry_classification | 事業目的と、WZ 2008およびWZ 2025による業種。 |
| representation_scheme |
代表権の定め:currentは現在有効なもの、historyは登記されたすべての状態。
|
| meta |
リクエストのコスト(request_credit_cost)と、その後の残高(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}
entity_idを使えば、後で同じ企業を直接照会できます。fetch-documentやSignalsのキーでもあります。登記裁判所と登記番号も同様に一意です(例ではAnsbach HRB 6089)。
curl -G "https://handelsregister.ai/api/v1/fetch-organization" \ -H "x-api-key: YOUR_API_KEY" \ --data-urlencode 'q=94eb910fef13f94585c48c263fa446d4'
import requests response = requests.get( "https://handelsregister.ai/api/v1/fetch-organization", headers={"x-api-key": "YOUR_API_KEY"}, 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": "YOUR_API_KEY" }, }); const data = await response.json();