Request

Endpoint

The endpoint is located here.
The endpoint expects POST requests. Regarding content-types, the endpoint expects the following:

Allow: POST, OPTIONS
Content-Type: application/json
Vary: Accept

For test purpose the endpoint also includes a graphical interface.

Request objects

The request object requires two main elements: - The authentication key (auth_key) to verify the access - Information about the object and retrofitting measures.

Value-set for the request

Field	Required	Type	Allowed Values	Example
efficiency_factor_cat	True	dictionary	{"before": "(A to H", "after": "A to H"}	{"before": "H", "after": "B"}
measures	True	comma separated list with string items	front_door new_windows heating_system roof facade_insulation solar_power_system battery_storage wallbox solar_heating_subitem domestic_ventilation_subitem insulation_top_ceiling_subitem insulation_basement_ceiling_subitem	["front_door", "new_windows"]
limit	False	integer	Positive, full integer from 1 (min) to 10 (max)	5
zip_code	True	string	5-digit string	"28865"

Request example

Example of a JSON request content:

{
  "search_terms": [
    "front_door",
    "new_windows",
    "heating_system"
  ],
  "zip_code": "28865",
  "limit": 2,
  "efficiency_factor_cat": {
    "before": "H",
    "after": "B"
  }
} 

Example of a json request content as CURL:

curl --request POST 
--url https://api.subsidies.fa-dev-ueberseehub.de/api/funding 
--header 'Authorization: Basic yourToken' 
--header 'Content-Type: application/json'
--data '{
"search_terms": [
  "front_door",
  "new_windows"
  "heating_system"
],
"zip_code": "28865",
"limit": 2,
"efficiency_factor_cat": {
  "before": "H",
  "after": "B"
  }
}'