import Openregister from 'openregister';
const client = new Openregister({
apiKey: 'My API Key',
});
const response = await client.company.getDetailsV1('company_id');
console.log(response.id);
{
"id": "<string>",
"register": {
"company_id": "<string>",
"register_number": "<string>",
"register_type": "HRB",
"register_court": "<string>",
"start_date": "<string>"
},
"registers": [
{
"company_id": "<string>",
"register_number": "<string>",
"register_type": "HRB",
"register_court": "<string>",
"start_date": "<string>"
}
],
"status": "active",
"name": {
"name": "<string>",
"legal_form": "ag",
"start_date": "<string>"
},
"names": [
{
"name": "<string>",
"legal_form": "ag",
"start_date": "<string>"
}
],
"address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"country": "<string>",
"extra": "<string>",
"start_date": "<string>",
"formatted_value": "<string>"
},
"addresses": [
{
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"country": "<string>",
"extra": "<string>",
"start_date": "<string>",
"formatted_value": "<string>"
}
],
"purpose": {
"purpose": "<string>",
"start_date": "<string>"
},
"purposes": [
{
"purpose": "<string>",
"start_date": "<string>"
}
],
"capital": {
"amount": 123,
"currency": "EUR",
"start_date": "<string>"
},
"capitals": [
{
"amount": 123,
"currency": "EUR",
"start_date": "<string>"
}
],
"representation": [
{
"id": "<string>",
"name": "<string>",
"type": "natural_person",
"role": "DIRECTOR",
"start_date": "<string>",
"end_date": "<string>",
"legal_person": {
"name": "<string>",
"city": "<string>",
"country": "<string>"
},
"natural_person": {
"city": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "<string>"
}
}
],
"indicators": [
{
"date": "<string>",
"report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"balance_sheet_total": 123,
"net_income": 123,
"revenue": 123,
"cash": 123,
"employees": 123,
"equity": 123,
"real_estate": 123,
"materials": 123,
"pension_provisions": 123,
"salaries": 123,
"taxes": 123,
"liabilities": 123,
"capital_reserves": 123
}
],
"legal_form": "ag",
"documents": [
{
"id": "<string>",
"type": "articles_of_association",
"date": "<string>",
"latest": true
}
],
"incorporated_at": "<string>",
"terminated_at": "<string>",
"industry_codes": {
"WZ2025": [
{
"code": "<string>"
}
]
},
"sources": [
{
"document_url": "<string>"
}
]
}
import Openregister from 'openregister';
const client = new Openregister({
apiKey: 'My API Key',
});
const response = await client.company.getDetailsV1('company_id');
console.log(response.id);
{
"id": "<string>",
"register": {
"company_id": "<string>",
"register_number": "<string>",
"register_type": "HRB",
"register_court": "<string>",
"start_date": "<string>"
},
"registers": [
{
"company_id": "<string>",
"register_number": "<string>",
"register_type": "HRB",
"register_court": "<string>",
"start_date": "<string>"
}
],
"status": "active",
"name": {
"name": "<string>",
"legal_form": "ag",
"start_date": "<string>"
},
"names": [
{
"name": "<string>",
"legal_form": "ag",
"start_date": "<string>"
}
],
"address": {
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"country": "<string>",
"extra": "<string>",
"start_date": "<string>",
"formatted_value": "<string>"
},
"addresses": [
{
"street": "<string>",
"city": "<string>",
"postal_code": "<string>",
"country": "<string>",
"extra": "<string>",
"start_date": "<string>",
"formatted_value": "<string>"
}
],
"purpose": {
"purpose": "<string>",
"start_date": "<string>"
},
"purposes": [
{
"purpose": "<string>",
"start_date": "<string>"
}
],
"capital": {
"amount": 123,
"currency": "EUR",
"start_date": "<string>"
},
"capitals": [
{
"amount": 123,
"currency": "EUR",
"start_date": "<string>"
}
],
"representation": [
{
"id": "<string>",
"name": "<string>",
"type": "natural_person",
"role": "DIRECTOR",
"start_date": "<string>",
"end_date": "<string>",
"legal_person": {
"name": "<string>",
"city": "<string>",
"country": "<string>"
},
"natural_person": {
"city": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "<string>"
}
}
],
"indicators": [
{
"date": "<string>",
"report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"balance_sheet_total": 123,
"net_income": 123,
"revenue": 123,
"cash": 123,
"employees": 123,
"equity": 123,
"real_estate": 123,
"materials": 123,
"pension_provisions": 123,
"salaries": 123,
"taxes": 123,
"liabilities": 123,
"capital_reserves": 123
}
],
"legal_form": "ag",
"documents": [
{
"id": "<string>",
"type": "articles_of_association",
"date": "<string>",
"latest": true
}
],
"incorporated_at": "<string>",
"terminated_at": "<string>",
"industry_codes": {
"WZ2025": [
{
"code": "<string>"
}
]
},
"sources": [
{
"document_url": "<string>"
}
]
}
API Key Authentication Provide your API key as a Bearer token in the Authorization header.
Unique company identifier. Example: DE-HRB-F1103-267645
Get the most up-to-date company information directly from the Handelsregister. When set to true, we fetch the latest data in real-time from the official German commercial register, ensuring you receive the most current company details. Note: Real-time requests take longer but guarantee the freshest data available.
Successfully retrieved company data
The response is of type object
.