KlarApis: German Company Data API

Access up-to-date German company registry information with a simple, free-to-use REST API. Search by company name or ID.

Open Data Source

Utilizes publicly available German company registry data from sources like OffeneRegister.de.

API Key Secured

Secure access using unique API keys, ensuring controlled usage.

Simple REST API

Easy-to-integrate GET endpoints for company search by name or ID.

Overview

KlarApis provides a straightforward way to query German company data. This documentation will guide you through obtaining an API key, authenticating your requests, and using the available endpoints.

Getting an API Key

To use KlarApis, you need an API key.

Currently, API keys are generated upon request. Please contact admin@klarapis.example with your project details to receive your unique API key.

(In a future version, an automated registration portal might be available.)

Authentication

All API requests must be authenticated using an API key.

Include your API key in the Authorization header of your request, prefixed with ApiKey.

Format:

Authorization: ApiKey <your_api_key>

Replace <your_api_key> with the actual API key provided to you.

API Endpoints

GET
/companies

Search for companies by name or ID.

Query Parameters:

name (string, optional): Substring to search in company names.
Min 3 characters
id (string, optional): Substring to search in company IDs.
Min 3 characters

At least one parameter (name or id) must be provided. If both are provided, results will match both criteria.

Example Request (by name):

curl -X GET "https://your-api-domain.cloudfunctions.net/companies?name=Mus" \
  -H "Authorization: ApiKey <your_api_key>"

Example Request (by ID):

curl -X GET "https://your-api-domain.cloudfunctions.net/companies?id=123" \
  -H "Authorization: ApiKey <your_api_key>"

Example Response (
200 OK
):

[
  {
    "id": "123456789",
    "name": "Mustercompany GmbH",
    "address": "Example Street 1, 12345 Berlin",
    // ... other fields
  },
  // ... more results (up to 50)
]

Results are limited to 50 per request.

Rate Limiting

To ensure fair usage, API requests are rate-limited per API key.

The current rate limit is X requests per minute (placeholder - please refer to specific limits provided with your API key).

If you exceed the rate limit, you will receive a 429 Too Many Requests error.

Error Codes

The API uses standard HTTP status codes to indicate the success or failure of a request.

400 Bad Request

The request was malformed, e.g., a query parameter is missing or too short.

{
  "error": "Query must be at least 3 characters."
}

401 Unauthorized

The API key is missing from the Authorization header.

{
  "error": "Missing API key"
}

403 Forbidden

The API key provided is invalid or does not have permission to access the resource.

{
  "error": "Invalid API key"
}

429 Too Many Requests

You have exceeded the rate limit for your API key.

500 Internal Server Error

An unexpected error occurred on the server.

Ready to get started?

Obtain your API key and start integrating powerful German company search into your applications today.

Request API Key