> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# North Data

> Search and retrieve company, Handelsregister, and financial data for firms in Germany, Austria, Switzerland, and other European countries via the North Data Data API

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key from `NORTHDATA_API_KEY` is sent as the `X-Api-Key` header.
* **Docs**: [https://northdata.github.io/doc/api/](https://northdata.github.io/doc/api/)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable            | Required | Description                                                                                                                                                            |
| ------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `NORTHDATA_API_KEY` | Yes      | North Data API key (format XXXX-XXXX), sent as the X-Api-Key header [Docs](https://github.com/northdata/api/blob/master/doc/data-api-userguide/data-api-userguide.md). |

## Setup

1. **Get a North Data Premium account with API access**: The Data API is part of North Data's paid Data Services. Request access (a trial can be arranged) at [https://www.northdata.de/\_data](https://www.northdata.de/_data) or via sales.
2. **Obtain your API key**: After activation you receive an API key in the format XXXX-XXXX from North Data.
3. **Set the environment variable**: Set NORTHDATA\_API\_KEY in your .env. The key is sent as the X-Api-Key HTTP header on every request.
4. **Verify access**: Run Get Company with name='\<a known company>' and address='\<its city>' and confirm a JSON profile is returned.

* Only successful queries are billed; search endpoints are billed per unique company returned - keep power search filters narrow
* In Germany, company name plus city uniquely identify a company; alternatively use registerId + registerCity (e.g. 'HRB 12345' + 'Hamburg')
* The API serves JSON by default and is also reachable under [www.northdata.com](http://www.northdata.com) with the same paths

Provider API reference: [https://northdata.github.io/doc/api/](https://northdata.github.io/doc/api/)

## Tools

| Tool              | Access | Description                                                                                                                                                                                                       |
| ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search Companies  | Read   | Fuzzy universal search for companies (and optionally persons) by free-text query, e.g. 'Siemens, München'. Use this to find a company before fetching its details.                                                |
| Get Company       | Read   | Retrieve a single company's profile (register info, address, status, financial indicators). Identify it either by name + address (city), or by registerId + registerCity, or by companyId from a previous search. |
| Power Search      | Read   | Structured company search with filters for location radius, industry segment, legal form, status, and countries. Billed per unique company returned, so keep filters narrow.                                      |
| Suggest Companies | Read   | Auto-complete suggestions for a partial company or person name. Free of charge - suggested companies do not count toward the monthly quota, so use this as a cheap first pass before Get Company.                 |
| Get Person        | Read   | Look up a person (officer, shareholder, representative) by name and address or by a person ID from a previous search result. Billed like company lookups.                                                         |

## Example prompts

* Look up the company '\<name>, \<city>' in North Data and summarize its register entry, status, and key financial indicators.
* Use North Data power search to find active companies of a given industry within 25 km of a city and list name, city, and legal form.