Immowelt · Schema

apiRequest

Request wrapper for Data

Real EstateMarketplaceGermanyAustriaProperty Listings

Properties

Name Type Description
data object
metadata object
media object
contact object
View JSON Schema on GitHub

JSON Schema

immowelt-api-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/immowelt/json-schema/immowelt-api-request-schema.json",
  "title": "apiRequest",
  "description": "Request wrapper for Data",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/immowelt-import-listings-openapi.yml#/components/schemas/apiRequest",
  "type": "object",
  "required": [
    "data",
    "metadata"
  ],
  "additionalProperties": false,
  "properties": {
    "data": {
      "$ref": "#/$defs/data"
    },
    "metadata": {
      "$ref": "#/$defs/metadata"
    },
    "media": {
      "$ref": "#/$defs/mediaRequest"
    },
    "contact": {
      "$ref": "#/$defs/contact"
    }
  },
  "$defs": {
    "accounting": {
      "type": "object",
      "properties": {
        "accounting": {
          "type": "string",
          "description": "How often the costs are paid and how: - FIXED: fixed amount paid each time unit - REAL_USAGE: amount calculated on real usage paid each time unit - ADJUSTMENT: fixed amount paid each time unit and regular\n  (yearly) adjustment based on real usage",
          "enum": [
            "FIXED",
            "REAL_USAGE",
            "ADJUSTMENT"
          ]
        }
      }
    },
    "conditions": {
      "type": "object",
      "description": "Condition information of the property.",
      "additionalProperties": false,
      "properties": {
        "buildState": {
          "type": "string",
          "enum": [
            "FIRST_TIME_USE",
            "FIRST_TIME_USE_AFTER_REFURBISHMENT",
            "MINT_CONDITION",
            "MODERNISED",
            "REFURBISHED",
            "FULLY_RENOVATED",
            "PARTLY_RENOVATED",
            "NEED_OF_RENOVATION",
            "WELL_KEPT",
            "NEGOTIABLE",
            "RIPE_FOR_DEMOLITION",
            "PROJECTED",
            "NO_INFORMATION",
            "RESTRUCTURED",
            "TO_RESTORE",
            "TO_REFURBISH"
          ],
          "description": "What is the current condition of the property? - FIRST_TIME_USE: never been inhabited before - FIRST_TIME_USE_AFTER_REFURBISHMENT: never been inhabited since\n  last refurbishment\n- MINT_CONDITION: perfect shape - MODERNISED: property architecture has been modernised - REFURBISHED: property is now as new - FULLY_RENOVATED: All the property is renovated - PARTLY_RENOVATED: some parts of the property have been renovated - NEED_OF_RENOVATION: the property needs to be renovated? - WELL_KEPT: good shape. - NEGOTIABLE: the property is not very well kept but it can be used - RIPE_FOR_DEMOLITION: Property to be demolished - PROJECTED: Not yet built. A project state. - NO_INFORMATION: Same as if you don't provide any data in this field. - RESTRUCTURED: redesigned, overhauled - TO_RESTORE: property needs restoration. - TO_REFURBISH: property needs refurbishment."
        },
        "ageState": {
          "type": "string",
          "enum": [
            "OLD",
            "NEW"
          ],
          "description": "the age of the building: OLD is defined as built before 1945. NEW is defined as built within the last 5 years."
        },
        "lastModernisation": {
          "type": "integer",
          "description": "last year of modernisation"
        },
        "constructionStyle": {
          "description": "General construction style of tbe building",
          "type": "string",
          "enum": [
            "PREFABRICATED",
            "SOLID",
            "SOLID_PREFABRICATED",
            "TIMBERHOUSE",
            "WOOD_PREFABRICATED",
            "UNSPECIFIED"
          ]
        },
        "yearOfConstruction": {
          "type": "integer",
          "nullable": false,
          "minimum": 1000,
          "maximum": 3000,
          "description": "year of construction"
        }
      }
    },
    "contact": {
      "type": "object",
      "nullable": false,
      "additionalProperties": false,
      "properties": {
        "salutation": {
          "type": "string",
          "maxLength": 10,
          "description": "Listing contact salutation.",
          "enum": [
            "Mr",
            "Mrs",
            "Miss",
            "Ms",
            "Mx",
            "Sir",
            "Dame",
            "Dr",
            "Cllr",
            "Lady",
            "Lord"
          ]
        },
        "firstName": {
          "type": "string",
          "maxLength": 255,
          "description": "Listing contact firstName."
        },
        "lastName": {
          "type": "string",
          "maxLength": 255,
          "description": "Listing contact lastName."
        },
        "name": {
          "type": "string",
          "maxLength": 255,
          "description": "Listing contact name or customer's default name."
        },
        "emailAddress": {
          "type": "string",
          "maxLength": 320,
          "description": "Listing contact email address or customer's default email address."
        },
        "phoneNumber": {
          "type": "string",
          "maxLength": 36,
          "description": "Listing contact phone number or customer's default phone number."
        },
        "mobilePhoneNumber": {
          "type": "string",
          "maxLength": 36,
          "description": "Listing contact mobile phone number or customer's default mobile phone number."
        },
        "imageURL": {
          "type": "string",
          "maxLength": 2048,
          "description": "This imageURL field defined for imageURLofcontact. phone number."
        },
        "userHomepage": {
          "type": "string",
          "maxLength": 2048,
          "description": "URL of the user's homepage or website"
        },
        "postalCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 12,
          "pattern": "^[a-zA-Z0-9\\s-]{3,12}$",
          "description": "Postal code of the contact person"
        },
        "city": {
          "type": "string",
          "maxLength": 128,
          "description": "City of the contact person"
        },
        "street": {
          "type": "string",
          "maxLength": 512,
          "description": "Street of the contact person"
        },
        "houseNumber": {
          "type": "string",
          "maxLength": 64,
          "description": "House number of the contact person"
        },
        "country": {
          "type": "string",
          "maxLength": 64,
          "description": "Country of the contact person"
        },
        "preferredContactType": {
          "type": "string",
          "enum": [
            "ANONYMOUS",
            "BY_PHONE",
            "BY_EMAIL",
            "OWN_WEBSITE"
          ],
          "description": "Preferred method of contact"
        },
        "contactNote": {
          "description": "Contact note in multiple languages",
          "allOf": [
            {
              "$ref": "#/$defs/multiLingualText"
            }
          ]
        },
        "displayedInformation": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "mainContactPerson": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "name": {
                  "type": "boolean",
                  "description": "Display name of main contact person"
                },
                "phone": {
                  "type": "boolean",
                  "description": "Display phone of main contact person"
                },
                "mobilePhone": {
                  "type": "boolean",
                  "description": "Display mobile phone of main contact person"
                },
                "email": {
                  "type": "boolean",
                  "description": "Display email of main contact person"
                },
                "address": {
                  "type": "boolean",
                  "description": "Display address of main contact person"
                },
                "companyName": {
                  "type": "boolean",
                  "description": "Display company name of main contact person"
                },
                "fax": {
                  "type": "boolean",
                  "description": "Display fax of main contact person"
                }
              }
            },
            "additionalContactPerson": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "name": {
                  "type": "boolean",
                  "description": "Display name of additional contact person"
                },
                "phone": {
                  "type": "boolean",
                  "description": "Display phone of additional contact person"
                },
                "mobilePhone": {
                  "type": "boolean",
                  "description": "Display mobile phone of additional contact person"
                },
                "email": {
                  "type": "boolean",
                  "description": "Display email of additional contact person"
                },
                "address": {
                  "type": "boolean",
                  "description": "Display address of additional contact person"
                },
                "companyName": {
                  "type": "boolean",
                  "description": "Display company name of additional contact person"
                },
                "fax": {
                  "type": "boolean",
                  "description": "Display fax of additional contact person"
                }
              }
            }
          }
        }
      }
    },
    "countrySpecific": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "de": {
          "type": "object",
          "additionalProperties": false
        },
        "fr": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "business": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "isBusinessSold": {
                  "description": "Is the business run inside the property sold ?",
                  "type": "boolean"
                },
                "businessType": {
                  "description": "main type of the business",
                  "type": "string",
                  "enum": [
                    "FOOD",
                    "TRANSPORT",
                    "GASTRONOMY_HOTEL",
                    "LOCAL_SHOP",
                    "WELLNESS_HEALTHCARE",
                    "HOUSE_EQUIPMENT",
                    "COMPUTER_TELECOM",
                    "LEISURE",
                    "FASHION",
                    "HEALTH",
                    "LOCAL"
                  ]
                },
                "businessSubType": {
                  "description": "subtype of the business",
                  "type": "string",
                  "enum": [
                    "MEAT_SHOP",
                    "BAKERY",
                    "CHOCOLATES_CANDIES",
                    "GREENGROCERY",
                    "GROCERY",
                    "DAIRY",
                    "FISH_STORE",
                    "CATERING",
                    "WINE",
                    "MINI_MARKET",
                    "SUPERMARKET",
                    "DRIVING_SCHOOL",
                    "CAR_MOTORCYCLE_DEALER",
                    "GARAGE_SERVICE_STATION",
                    "CAFE_BAR_PUB",
                    "CAMPING",
                    "CREPERIE",
                    "ICECREAM",
                    "HOTEL",
                    "PIZZERIA",
                    "RESTAURANT",
                    "FASTFOOD",
                    "TEAROOM",
                    "GIFT_SHOP",
                    "FLORIST",
                    "HABERDASHERY",
                    "KIOSK",
                    "HAIRDRESSING",
                    "BEAUTY",
                    "PERFUMERY",
                    "FURNISHING",
                    "HOUSEHOLD_APPLIANCES",
                    "COMPUTER_SHOP_OFFICE_SUPPLY",
                    "PHONES",
                    "TRAVEL_AGENCY",
                    "ARTS_MUSIC",
                    "SPORTS_CLUB",
                    "CLUB_DISCOTHEQUE",
                    "ARTS_GALLERY",
                    "COMPUTER_SHOP",
                    "BOOKS",
                    "TOYS",
                    "JEWELLERY",
                    "SHOES",
                    "LEATHER",
                    "CLOTHES",
                    "TAXI_AMBULANCE",
                    "DENTAL",
                    "PHYSIOTHERAPIST",
                    "RETIREMENT_HOME",
                    "OPTIC",
                    "PHARMACY",
                    "REAL_ESTATE",
                    "PETS",
                    "DIY",
                    "SHOE_REPAIR",
                    "RELOCATION",
                    "ELECTRICITY",
                    "GARDENER",
                    "LAUNDROMAT",
                    "CARPENTRY",
                    "PHOTO",
                    "PLUMBING_HEATING",
                    "LAUNDRY",
                    "LOCKSMITH",
                    "GLASSMAKING"
                  ]
                },
                "revenue": {
                  "description": "total revenue of the business in the current year",
                  "type": "number"
                },
                "revenueOneYearAgo": {
                  "description": "total revenue of the business one year ago",
                  "type": "number"
                },
                "revenueTwoYearsAgo": {
                  "description": "total revenue of the business two years ago",
                  "type": "number"
                },
                "revenueDetails": {
                  "description": "additional comment about the revenue of the business",
                  "type": "string"
                },
                "netIncome": {
                  "description": "net income of the business in the current year",
                  "type": "number"
                },
                "netIncomeOneYearAgo": {
                  "description": "net income of the business one year ago",
                  "type": "number"
                },
                "netIncomeTwoYearsAgo": {
                  "description": "net income of the business two years ago",
                  "type": "number"
                },
                "isPartOfNetwork": {
                  "description": "the business is part of a bigger network",
                  "type": "boolean"
                },
                "downPayment": {
                  "description": "down payment for the purchase of the business in euros",
                  "type": "number"
                },
                "isNoNuisance": {
                  "description": "the business must not inconvenience neighbours",
                  "type": "boolean"
                },
                "isDivisible": {
                  "description": "parts of the business can be sold or rent. parts can be listed or not.",
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    },
    "currency": {
      "type": "string",
      "description": "the currency of all prices defined below. the currency must be entered as ISO 4217 currency code. Please refer to https://www.iso.org/iso-4217-currency-codes.html Last checked: October 1st, 2021 Here are the alphabetic three-letter country codes: - AED: UAE Dirham - AFN: Afghani - ALL: Lek - AMD: Armenian Dram - ANG: Netherlands Antillean Guilder - AOA: Kwanza - ARS: Argentine Peso - AUD: Australian Dollar - AWG: Aruban Florin - AZN: Azerbaijan Manat - BAM: Convertible Mark - BBD: Barbados Dollar - BDT: Taka - BGN: Bulgarian Lev - BHD: Bahraini Dinar - BIF: Burundi Franc - BMD: Bermudian Dollar - BND: Brunei Dollar - BOB: Boliviano - BOV: Mvdol - BRL: Brazilian Real - BSD: Bahamian Dollar - BTN: Ngultrum - BWP: Pula - BYN: Belarusian Ruble - BZD: Belize Dollar - CAD: Canadian Dollar - CDF: Congolese Franc - CHE: WIR Euro - CHF: Swiss Franc - CHW: WIR Franc - CLF: Unidad de Fomento - CLP: Chilean Peso - CNY: Yuan Renminbi - COP: Colombian Peso - COU: Unidad de Valor Real - CRC: Costa Rican Colon - CUC: Peso Convertible - CUP: Cuban Peso - CVE: Cabo Verde Escudo - CZK: Czech Koruna - DJF: Djibouti Franc - DKK: Danish Krone - DOP: Dominican Peso - DZD: Algerian Dinar - EGP: Egyptian Pound - ERN: Nakfa - ETB: Ethiopian Birr - EUR: Euro - FJD: Fiji Dollar - FKP: Falkland Islands Pound - GBP: Pound Sterling - GEL: Lari - GHS: Ghana Cedi - GIP: Gibraltar Pound - GMD: Dalasi - GNF: Guinean Franc - GTQ: Quetzal - GYD: Guyana Dollar - HKD: Hong Kong Dollar - HNL: Lempira - HRK: Kuna - HTG: Gourde - HUF: Forint - IDR: Rupiah - ILS: New Israeli Sheqel - INR: Indian Rupee - IQD: Iraqi Dinar - IRR: Iranian Rial - ISK: Iceland Krona - JMD: Jamaican Dollar - JOD: Jordanian Dinar - JPY: Yen - KES: Kenyan Shilling - KGS: Som - KHR: Riel - KMF: Comorian Franc - KPW: North Korean Won - KRW: Won - KWD: Kuwaiti Dinar - KYD: Cayman Islands Dollar - KZT: Tenge - LAK: Lao Kip - LBP: Lebanese Pound - LKR: Sri Lanka Rupee - LRD: Liberian Dollar - LSL: Loti - LYD: Libyan Dinar - MAD: Moroccan Dirham - MDL: Moldovan Leu - MGA: Malagasy Ariary - MKD: Denar - MMK: Kyat - MNT: Tugrik - MOP: Pataca - MRU: Ouguiya - MUR: Mauritius Rupee - MVR: Rufiyaa - MWK: Malawi Kwacha - MXN: Mexican Peso - MXV: Mexican Unidad de Inversion (UDI) - MYR: Malaysian Ringgit - MZN: Mozambique Metical - NAD: Namibia Dollar - NGN: Naira - NIO: Cordoba Oro - NOK: Norwegian Krone - NPR: Nepalese Rupee - NZD: New Zealand Dollar - OMR: Rial Omani - PAB: Balboa - PEN: Sol - PGK: Kina - PHP: Philippine Peso - PKR: Pakistan Rupee - PLN: Zloty - PYG: Guarani - QAR: Qatari Rial - RON: Romanian Leu - RSD: Serbian Dinar - RUB: Russian Ruble - RWF: Rwanda Franc - SAR: Saudi Riyal - SBD: Solomon Islands Dollar - SCR: Seychelles Rupee - SDG: Sudanese Pound - SEK: Swedish Krona - SGD: Singapore Dollar - SHP: Saint Helena Pound - SLL: Leone - SOS: Somali Shilling - SRD: Surinam Dollar - SSP: South Sudanese Pound - STN: Dobra - SVC: El Salvador Colon - SYP: Syrian Pound - SZL: Lilangeni - THB: Baht - TJS: Somoni - TMT: Turkmenistan New Manat - TND: Tunisian Dinar - TOP: Pa'anga - TRY: Turkish Lira - TTD: Trinidad and Tobago Dollar - TWD: New Taiwan Dollar - TZS: Tanzanian Shilling - UAH: Hryvnia - UGX: Uganda Shilling - USD: US Dollar - USN: US Dollar (Next day) - UYI: Uruguay Peso en Unidades Indexadas (UI) - UYU: Peso Uruguayo - UYW: Unidad Previsional - UZS: Uzbekistan Sum - VED: Bolívar Soberano - VES: Bolívar Soberano - VND: Dong - VUV: Vatu - WST: Tala - XAF: CFA Franc BEAC - XAG: Silver - XAU: Gold - XBA: Bond Markets Unit European Composite Unit (EURCO) - XBB: Bond Markets Unit European Monetary Unit (E.M.U.-6) - XBC: Bond Markets Unit European Unit of Account 9 (E.U.A.-9) - XBD: Bond Markets Unit European Unit of Account 17 (E.U.A.-17) - XCD: East Caribbean Dollar - XDR: SDR (Special Drawing Right) - XOF: CFA Franc BCEAO - XPD: Palladium - XPF: CFP Franc - XPT: Platinum - XSU: Sucre - XTS: Codes specifically reserved for testing purposes - XUA: ADB Unit of Account - XXX: The codes assigned for transactions where no currency is involved - YER: Yemeni Rial - ZAR: Rand - ZMW: Zambian Kwacha - ZWL: Zimbabwe Dollar",
      "default": "EUR",
      "enum": [
        "AED",
        "AFN",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BOV",
        "BRL",
        "BSD",
        "BTN",
        "BWP",
        "BYN",
        "BZD",
        "CAD",
        "CDF",
        "CHE",
        "CHF",
        "CHW",
        "CLF",
        "CLP",
        "CNY",
        "COP",
        "COU",
        "CRC",
        "CUC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EGP",
        "ERN",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "INR",
        "IQD",
        "IRR",
        "ISK",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KPW",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRU",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MXV",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SDG",
        "SEK",
        "SGD",
        "SHP",
        "SLL",
        "SOS",
        "SRD",
        "SSP",
        "STN",
        "SVC",
        "SYP",
        "SZL",
        "THB",
        "TJS",
        "TMT",
        "TND",
        "TOP",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "USN",
        "UYI",
        "UYU",
        "UYW",
        "UZS",
        "VED",
        "VES",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XAG",
        "XAU",
        "XBA",
        "XBB",
        "XBC",
        "XBD",
        "XCD",
        "XDR",
        "XOF",
        "XPD",
        "XPF",
        "XPT",
        "XSU",
        "XTS",
        "XUA",
        "XXX",
        "YER",
        "ZAR",
        "ZMW",
        "ZWL"
      ]
    },
    "data": {
      "type": "object",
      "required": [
        "estateType",
        "prices",
        "location",
        "distributionType"
      ],
      "additionalProperties": false,
      "properties": {
        "estateType": {
          "$ref": "#/$defs/estateType"
        },
        "estateSubType": {
          "$ref": "#/$defs/estateSubType"
        },
        "distributionType": {
          "$ref": "#/$defs/distributionType"
        },
        "location": {
          "$ref": "#/$defs/location"
        },
        "prices": {
          "$ref": "#/$defs/prices"
        },
        "spaces": {
          "$ref": "#/$defs/spaces"
        },
        "conditions": {
          "$ref": "#/$defs/conditions"
        },
        "energy": {
          "$ref": "#/$defs/energy"
        },
        "features": {
          "$ref": "#/$defs/features"
        },
        "structure": {
          "$ref": "#/$defs/structure"
        },
        "texts": {
          "$ref": "#/$defs/texts"
        },
        "management": {
          "$ref": "#/$defs/management"
        },
        "countrySpecific": {
          "$ref": "#/$defs/countrySpecific"
        },
        "contact": {
          "$ref": "#/$defs/contact"
        },
        "links": {
          "$ref": "#/$defs/links"
        }
      }
    },
    "distributionType": {
      "type": "string",
      "nullable": false,
      "minLength": 1,
      "enum": [
        "BUY",
        "RENT",
        "COMPULSORY_AUCTION",
        "BUY_AUCTION"
      ],
      "description": "the distribution type of the property.\n- BUY: regular type of property for sale\n  de: Kauf\n- RENT: regular type of property for rent\n  de: Miete\n- COMPULSORY_AUCTION: auction ordered by the courts\n  de: Zwangsversteigerung\n- BUY_AUCTION: bids for the property can be submitted within a\n  limited time period. The seller can accept, reject or negotiate\n  the bid. Most important difference to a classic auction: the\n  highest bid does not necessarily have to win.\n  de: Bieterverfahren"
    },
    "energy": {
      "type": "object",
      "description": "Energy and heating information of the property.",
      "additionalProperties": false,
      "properties": {
        "energyType": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "heatMethod": {
              "type": "string",
              "enum": [
                "CENTRAL",
                "INDIVIDUAL",
                "STOREY"
              ],
              "description": "heating method, per storey/floor or central in building."
            },
            "heatForm": {
              "description": "via which medium the heat is emitted",
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "air": {
                  "type": "boolean",
                  "description": "(warm) air heater does not use a medium to store its heat. Air is sucked in, heated and directly passed on to the rooms to be heated. fr: aerotherme"
                },
                "radiator": {
                  "type": "boolean",
                  "description": "radiators are connected to heating circuit through which hot water flows to distribute the heat in the rooms."
                },
                "stove": {
                  "type": "boolean",
                  "description": "stove that can be fired with wood, oil, coal"
                },
                "underfloor": {
                  "type": "boolean",
                  "description": "pipes are laid in the floor through which warm water flows and heats the floor and thus also the rooms."
                },
                "wallCeiling": {
                  "type": "boolean",
                  "description": "heating elements are mounted on the wall or ceiling"
                }
              }
            },
            "energySource": {
              "description": "Raw materials, substances and sources used for the production of heat. Multiple answers are possible",
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "coal": {
                  "type": "boolean"
                },
                "districtHeating": {
                  "type": "boolean",
                  "description": "system for distributing heat generated in a centralized location"
                },
                "electric": {
                  "type": "boolean"
                },
                "gas": {
                  "type": "boolean"
                },
                "geothermal": {
                  "type": "boolean",
                  "description": "thermal energy from within the earth"
                },
                "liquidGas": {
                  "type": "boolean"
                },
                "oil": {
                  "type": "boolean"
                },
                "solarHeat": {
                  "type": "boolean"
                },
                "solarPower": {
                  "type": "boolean"
                },
                "wind": {
                  "type": "boolean"
                },
                "wood": {
                  "type": "boolean"
                },
                "woodPellet": {
                  "type": "boolean"
                }
              }
            },
            "energyGeneration": {
              "description": "energyGeneration is the way energy sources are used. e.g. coal, gas, oil are burned (FOSSILBURNING), electric + geothermal are used with HEATPUMP.",
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "fossilburning": {
                  "type": "boolean"
                },
                "heatpump": {
                  "type": "boolean"
                },
                "combinedHeatAndPowerPlant": {
                  "type": "boolean"
                }
              }
            },
            "maxElectricalPower": {
              "type": "integer",
              "description": "maximum electric power available for the property, expressed in kVA"
            }
          }
        },
        "countrySpecific": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "de": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "energyCertificates": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "certificateType"
                    ],
                    "additionalProperties": false,
                    "properties": {
                      "nameOfCertificate": {
                        "type": "string",
                        "description": "en: the name of the certificate de: Bezeichnung des Energieausweis"
                      },
                      "certificateType": {
                        "type": "string",
                        "enum": [
                          "ENEV2008",
                          "ENEV2014",
                          "ENEV2026",
                          "NOT_AVAILABLE",
                          "NOT_NECESSARY",
                          "AT_VISIT"
                        ],
                        "description": "en: Year according to ENEV: Values: \"ENEV2008\" = before 1.5.2014, \"ENEV2014\" = from 1.5.2014, \"ENEV2026\" = from 2026 onwards, \"NOT_NECESSARY\" e.g. for monument protection, \"AT_VISIT\" will be shown when visiting of the real estate de: Energieausweistyp\n"
                      },
                      "certificateBasedOn": {
                        "type": "string",
                        "enum": [
                          "NEED",
                          "CONSUMPTION"
                        ],
                        "description": "en: certificate is based on demand (de Bedarf) or consumption (de Verbrauch) de: \"Energieausweisart\", basiert der Energieausweis auf dem Bedarf (\"NEED\") oder Verbrauch (\"CONSUMPTION\")\n"
                      },
                      "isResidentialBuilding": {
                        "type": "boolean",
                        "description": "en: building is for residential use only, meaning space for commercial use below 10% de: Wohngebäude, bei Nicht-Wohngebäude ist dieser Wert false zu setzen"
                      },
                      "primaryEnergySource": {
                        "type": "string",
                        "enum": [
                          "NO_INFORMATION",
                          "SOLAR",
                          "WIND",
                          "COAL",
                          "GAS",
                          "OIL",
                          "WOOD",
                          "DISTRICT_HEATING",
                          "ELECTRICITY"
                        ],
                        "description": "en: primary energy carrier according to the certificate de: \"Wesentliche Energieträger\" laut Energieausweis\n"
                      },
                      "efficiencyClass": {
                        "type": "string",
                        "enum": [
                          "A_PLUS",
                          "A",
                          "B",
                          "C",
                          "D",
                          "E",
                          "F",
                          "G",
                          "H"
                        ],
                        "description": "en: Energy Efficiency Classification according to ENEV de: \"Energieeffizienzklasse\" laut Energieausweis\n"
                      },
                      "releaseDate": {
                        "type": "string",
                        "format": "date",
                        "description": "en: release date of the certificate. The date is an ISO 8601 formatted string de: Ausstellungsdatum"
                      },
                      "validUntil": {
                        "type": "string",
                        "format": "date",
                        "description": "en: certificate valid until date. The date is an ISO 8601 formatted string de: gültig bis"
                      },
                      "y

# --- truncated at 32 KB (207 KB total) ---
# Full source: https://artifacts.apis.io/immowelt/json-schema/immowelt-api-request-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/immowelt-api-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.