The OpenRegister API follows a structured versioning approach to ensure a consistent developer experience while allowing for innovation and improvements.

​
Available Versions

We currently offer the following API versions:

  • Public API - Available for early adopters to test and provide feedback (currently active)
  • Private Stable API - Our established API available to existing partners (will be phased out in favor of the Public API)

​
Version Specification

API versions are specified in the first path segment of the URL:

https://api.openregister.de/v0/search/company

Where:

  • v0 - Designates the Public API

​
Versioning Approach

We use a major version number in the URL path to represent significant API iterations:

  • Major version changes (v0 → v1) may introduce breaking changes
  • Within a major version, we try to maintain backward compatibility

​
Stability and Changes

Public API

  • Production-ready with full support
  • New features may be added without changing the version

Private Stable API

  • Fully stable interface with guaranteed backward compatibility
  • Changes are only made with advance notice to existing partners
  • Will be phased out in favor of the Public GA API

​
Deprecation Policy

When an API version needs to be deprecated:

  1. We will announce deprecation at least 6 months in advance
  2. Deprecated versions will remain functional for at least 12 months
  3. After the deprecation period, the API version may be decommissioned