GET

Api Root

API Documentation

Welcome to the Heat Pumps Info API documentation. This API allows users to access the heat pump catalog and associated projects through a RESTful interface.

How to Use the API

The API can be accessed using standard HTTP methods. Here are some common actions:

  • GET: Retrieve data from the server (e.g., list of products or projects).
  • OPTIONS: Retrieve allowed methods for a resource.
  • Download Formats: You can specify the format of the data you want to receive, such as JSON or Excel (XLSX).

Available Endpoints

Endpoint Description
/api/products/ Access the list of heat pump products.
/api/projects/ Access the list of projects related to heat pumps.

Example Requests

To download an Excel file of the products, you can use the following URL:

GET /api/products/?format=xlsx

This request will return an Excel file containing the product data.

Response Format

The API responds with data in various formats based on the requested format. For JSON, you may receive a response like:

{
"products": "http://grosswaermepumpen.info/api/products/",
"projects": "http://grosswaermepumpen.info/api/projects/"
}
GET /en-us/api/?format=api
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "products": "https://grosswaermepumpen-info.de/en-us/api/products/?format=api",
    "projects": "https://grosswaermepumpen-info.de/en-us/api/projects/?format=api"
}