The Developer Studio provides you with a comprehensive overview of all currently available APIs and serves as a guide throughout the integration process. In the Products section, you will find all published APIs. There, you can select individual APIs to explore their implemented endpoints and corresponding technical specifications. For each API and endpoint, you will find: A short description An outline of potential use cases Notes on limitations or additional considerations In addition to the documentation, you can also download: YAML or JSON files for each endpoint version A Postman collection (where available) Additional annex materials containing further details

Business relationship with Prohyp

To use most APIs, you need an active partnership agreement with Prohyp. Setting up the partnership is simple: For Brokers: Please use the “Become a partner now” function on our website www.prohyp.de. For referrers: If you work in the construction or real estate industry—for example, as a property developer or estate agent—please use our contact form on our website www.interhyp.de.

We follow OAuth 2.0, a widely used standard. OAuth stands for ""Open Authorization"" and describes an authorization protocol based on access tokens. The access tokens are in ""JSON Web Token (JWT)"" format with an expiry date, which must be passed in the header (""Authorization""). Tokens can be created at the Authorization API. We also use API Keys for authentication at each of our APIs - including the Authorization API itself. The appropriate API key for the development environment in question must be passed in the header (Api-Key) of every call. The required API key and client credentials for calling this API can be generated in the Interhyp Developer Studio. We aim to make access to our APIs as simple and consistent as possible. However, a few older APIs still require a different authentication method. You will find details about these exceptions in the respective API documentation.

Certain prerequisites apply to the use of our APIs, the most current version of which can be found in the Terms of Use section. Please read these carefully. If you do not agree with the terms, integration and use of our APIs will unfortunately not be possible. Before activating the APIs, you will be provided with the terms of use again - with a request to confirm them. If you have any questions, please contact am@prohyp.de.

Availability of deprecated APIs

Sometimes new features or technologies differ so significantly that they cannot be integrated into an existing API. In such cases, we release a new version of the API. To use the new functionality, you will need to switch to this updated version. The previous version will continue to be available for a transitional period to give you sufficient time to plan and implement your technical migration. APIs that are deprecated are clearly marked as DEPRECATED in the API documentation and will be deactivated at a defined point in time. We strongly recommend no longer implementing deprecated APIs and instead using the current version.

Pagination

Our APIs use cursor-based pagination to ensure high performance and minimize network traffic. Pagination is mandatory for all endpoints that may return large data sets. All responses include the result set along with the corresponding pagination metadata.

Cursor

A cursor is a randomly generated string that refers to an element in the result list. If this element is deleted, the cursor loses its validity.

Note

Cursors must not be stored client-side or regarded as permanently valid.

Supported parameters

• before / after – mark the beginning and end of the current page respectively
• limit – maximum number of results (may be fewer due to filtering)
• previous – link to the previous page (absent = first page)
• next – link to the next page (absent = last page)

The absence of the next link marks the end of the result list.

Extensible Enums & Tolerant Reader Pattern

Our APIs use extensible enums.

• Fields marked with x-extensible-enum list the currently supported values.
• This list may change over time.

Client implementations must therefore support the Tolerant Reader Pattern:

• Unknown enum values must not cause errors.
• Unsupported values that are sent will be ignored by the server and interpreted as null.

Using Postman Collections and Environments

To support you in getting started with our APIs, we provide Postman Collections for selected APIs. These collections are optional tools that help you explore API endpoints, test requests, and understand example calls. Where available, the Postman Collections can be downloaded directly from the respective API description. In addition, we offer Postman Environments in the Dashboard. These make it easy to adapt your API tests to different environments by centrally managing environment-specific variables such as base URLs or authentication parameters.

If you have any questions during the integration or operation of our APIs that cannot be answered by the API documentation or the provided example files (such as Postman Collections for sample API calls), please feel free to contact am@prohyp.de.