> For the complete documentation index, see [llms.txt](https://help.bizmachine.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.bizmachine.com/en/api-and-integrations/api-endpoints/endpoint-aggregated-data.md).

# Endpoint aggregated-data: company profile

A complete company profile in one API call: identification, address, general company contacts, NACE, indicators and a summary of 25 metrics.

*Updated: 5 October 2026*

```
GET /{dataset}/v4/companies/{nationalIn}/aggregated-data
```

The basic endpoint for company data. It returns a complete profile: identification, address, general company contacts, NACE, indicators and a summary of 25 metrics (latest values only, no time series).

***

### What this endpoint returns

`aggregated-data` answers the basic questions about a company in one call:

* **Who is it?** Name, Company ID (IČO), VAT ID, legal form, date of establishment, status (active, in liquidation and so on), company description
* **Where is it based?** Address with GPS coordinates, location hierarchy (municipality → district → region)
* **What are the general contacts?** Website, email, phone, LinkedIn, Facebook
* **How big is it?** Employee count band, revenue, assets, EBIT
* **How is it growing?** Activity, Growth and Reachability indicators (0 to 100)
* **What does it do?** Primary NACE code plus other categories
* **Does it have risks?** Number of risk signals (insolvency, enforcement and so on)

#### When to use this endpoint

* You need a basic company profile before a business meeting or an analysis
* You are enriching CRM records: name, address, industry, size
* As the first call in a pipeline: you find out what the company is, then decide what to call next
* You need a quick overview of metrics without historical time series

#### When to use a different endpoint

| You need                               | Use instead       |
| -------------------------------------- | ----------------- |
| Metric history (multi-year series)     | `metrics` (v3)    |
| Detailed risk signals                  | `risks` (v4)      |
| Ownership structure with history       | `owners` (v4)     |
| Detailed indicators with their drivers | `indicators` (v3) |
| Detailed financial statements          | `financials` (v3) |

#### Availability

The endpoint is available for all datasets: **cz, sk, hu, pl, de**.

***

### Technical details

{% openapi src="/files/FGwu42o2gqsEWtcATX3u" path="/{dataset}/v4/companies/{nationalIn}/aggregated-data" method="get" %}
[api-spec.temp.json](https://247275268-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYkl7SJ14Nk0vzhVx7upl%2Fuploads%2Fgit-blob-f3abeffbb2534d765afc74352238d1f9ef6bc845%2Fapi-spec.temp.json?alt=media)
{% endopenapi %}

#### What to watch out for

* `employees` has no exact value, only a band in `category`. The exact number of employees is not available in this endpoint.
* `contacts.website` has a `.value` field (not `.url`), the same pattern as `email` and `phoneNumber`.
* `contacts` are the general company contacts (website, email, phone, LinkedIn, Facebook), **not personal contacts** of specific people.
* `indicators.*` can be `null` at the level of the whole object (not only `.value`). Always check that the object exists before you access `.value`.
* `selfDeclaredCategories` can have 400+ items, which makes a large payload.
* `risks` is `null` when the company has no risks (not an empty array).
* The endpoint contains a summary of about 25 metrics without history. For all 64 metrics with multi-year series, use `metrics` (v3).

***

### Instructions for AI agents

Copy this block and give it to your agent. It describes how to use the endpoint correctly.

```
## BizMachine API: aggregated-data endpoint

Purpose: Returns a complete company profile in a single API call - identity, address,
company contacts, NACE codes, key metrics (latest values only), and business indicators.

When to use:
- You have a company's national identifier (IČO) and need a full profile
- You are enriching CRM records (name, address, industry, size, contacts)
- As the entry point in a pipeline before deciding which other endpoints to call
- You need a quick metrics overview without historical time series

When NOT to use:
- Historical metrics (multi-year time series) → use /metrics (v3)
- Detailed risk signals → use /risks (v4)

URL:
  GET https://api.bizmachine.com/{dataset}/v4/companies/{nationalIn}/aggregated-data

Required:
  - Path: dataset - "cz", "sk", "hu", "pl" or "de"
  - Path: nationalIn - company national ID / IČO (e.g. "27082440")
  - Header: X-Api-Key: {api_key}

Optional:
  - Header: Accept-Language: CS  (for Czech field names and values)

Key response fields:
  data.basicInfo.nationalIn          - company ID (IČO)
  data.basicInfo.name                - company name
  data.basicInfo.vatIn               - VAT number
  data.basicInfo.health.code         - company status ("inbusiness", "dissolved", ...)
  data.basicInfo.establishedAt       - founding date (ISO 8601)
  data.basicInfo.legalForm.name      - legal form
  data.basicInfo.selfDescription     - company description
  data.address.text                  - full address
  data.address.city                  - city
  data.address.postalCode            - postal code
  data.address.coordinates           - GPS (latitude, longitude)
  data.contacts.website.value        - company website
  data.contacts.email.value          - company email
  data.contacts.phoneNumber.value    - company phone
  data.contacts.linkedIn.value       - LinkedIn profile URL
  data.contacts.facebook.value       - Facebook profile URL
  data.metrics.revenue               - revenue {value, currency} or band in category
  data.metrics.employees             - headcount: band ONLY in category.name (value is always null)
  data.metrics.ebit                  - EBIT {value, currency}
  data.metrics.ebitda                - EBITDA {value, currency}
  data.metrics.assetsTotal           - total assets {value, currency}
  data.metrics.revenueGrowth         - revenue growth (ratio)
  data.metrics.personnelCost         - personnel costs {value, currency}
  data.metrics.locationCount         - number of operating locations
  data.metrics.openJobCountCurrentTotal - current open job positions
  data.metrics.riskCount             - number of risks (null if none)
  data.indicators.activity.value     - activity score (0 to 100)
  data.indicators.growth.value       - growth score (0 to 100)
  data.indicators.reachability.value - reachability score (0 to 100)
  data.nace.primary.code             - primary NACE code
  data.nace.primary.name             - NACE category name
  meta.prospector.link               - link to company profile in Prospector UI

Gotchas:
  - data.metrics.employees.value is ALWAYS null - exact headcount unavailable, band only
  - data.contacts.website.value - field is .value (not .url), consistent with email and phone
  - data.contacts = company contacts (web, email, phone, LinkedIn, Facebook) - NOT personal contacts
  - data.indicators.* can be null at the object level (not just .value) - always null-check the parent object before accessing .value
  - data.basicInfo.selfDeclaredCategories can have 400+ items → large payload
  - data.risks is null when no risks present (not an empty array)
  - data.metrics contains more fields than listed above - for full 64 metrics with history → combine with /metrics (v3)

Typical workflow (CRM enrichment):
  1. Call aggregated-data → get basic profile + metrics
  2. Call /metrics (v3) → get historical time series
  = complete profile in 2 API calls
```

***

Need help? Write to <support@bizmachine.com>