setle-docs

Calculation API

Energetic calculations

Get energy efficiency indications

This endpoint returns an energy efficiency indication for the provided parameters. As this is a synchronous endpoint, the result will be available immediately and returned in the response. Important: Setle does not take any responsibility with regard to the accuracy of this indication.

POST /calculations?calculation_type="ENERGY_EFFICIENCY"

Request body

{
  "year_built": "number",
  "eco_facilities": "string[]",
  "estate_roof_type": "string",
  "habitable_space_m2": "number",
  "outer_wall_insulation_type": "string",
  "roof_insulation_type": "string",
  "window_type": "string",
  "ventilation_type": "string",
  "heating_device": "string",
  "ground_floor_type": "string",
  "ground_floor_insulation_type": "string",
  "estate_type": "string",
  "sanitary_heating_device": "string",
  "heating_type": "string"
}

Response body

{
  "id": "string",
  "calculation_status": "string",
  "calculation_type": "string",
  "metadata": {}
}

Response code

201 Created

Fetching calculations

This endpoint can be used to fetch a list of all calculations that are visible to you.

GET /calculations

Response body

[
  {
    "id": "string",
    "calculation_status": "string",
    "calculation_type": "string",
    "metadata": {}
  }
]

Response code

200 OK

Fetching single calculation

This endpoint returns more information about a specific calculation.

GET /calculations/{calculation_id}

Response body

{
  "id": "string",
  "calculation_status": "string",
  "calculation_type": "string",
  "metadata": {}
}

Response code

200 OK