Statistic

Returns a list of resources identified by the following URL. A list of geo hierarchy elements. These contain the number of published real estates in the specified region and its direct subregions. For each real estate type the number is shown separateley. This list can be narrowed further by specifying real estate types, channel, customer number, and username.

https://rest.immobilienscout24.de/restapi/api/search/v1.0/statistic?geocode={geocode}&realestatetypes={realestatetypes}&customernumber={customernumber}&username={username}&channel={channel}

Supported media types

  • XML (Accept: application/xml)
  • JSON (Accept: application/json)

Authorization requirements

  • At least a System Key is required for this operation. See Authentication via Two-legged OAuth for further details.

Request

Path Parameters

  • none

Query Parameters

  • geocode (deprecated) - One GeoCodeId (same as in Region Search in encoded form like 1276009039 for the region "Stade (Kreis)". Only GeoCodeIds are valid for which subregions exist in is24's GIS.
  • shapeid - One Shape-ID that is available at the IS24 Shape Service.

Exactly one of the paramters geocode or shapeid is required. If both are provided, the geocode will be ignored.

Valid examples for Germany: 1 (Continent) or 1276 (Country) or 1276009 (Region) or 1276009039 (City).

Invalid example: Quarter 1276009039002 "Ahlerstedt", because it has no GIS-subregions. (In rural areas in Germany a GIS-City is a Landkreis and a GIS-Quarter is a Kleinstadt.)

  • realestatetypes - Optional. The real estate types for the request. This parameter is optional, the standard     value is all real estate types.
  • customernumber - Optional. Filter real estates by the publishing customer using her Immobilien Scout             customer number.
  • username - Optional. Filter real estates by the publishing customer using his Immobilien Scout login     user name.
  • channel - Optional. Filter real estates by channel (is24, hp or group-id) where it is published. See         Search_by_Channels.

Response

The following section includes the HTTP status code, a short description and examples for the response body content of a successful processed request.
Error responses as well as other simple message responses are described in detail within the common message responses.

  • Status 200 OK - The requested operation was successful.

Header

No special headers.

Body

XML

GET https://rest.immobilienscout24.de/restapi/api/search/v1.0/statistic?shapeid=1100000004&realestatetypes=specialpurpose,housebuy

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:geoPathHierarchyElementsStatistic xmlns:shortlist="http://rest.immobilienscout24.de/schema/search/shortlist/1.0" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
    <parent>
        <id>1100000004</id>
        <geoPath>/de/berlin/berlin/charlottenburg-wilmersdorf</geoPath>
        <gacLabel>Berlin - Charlottenburg-Wilmersdorf</gacLabel>
        <seoLabel>Charlottenburg-Wilmersdorf (Berlin)</seoLabel>
        <type>borough</type>
        <statistics>
            <GeoHierarchyStatistic realEstateType="SPECIAL_PURPOSE" count="2"/>
            <GeoHierarchyStatistic realEstateType="HOUSE_BUY" count="26"/>
        </statistics>
    </parent>
    <children>
        <geoPathHierarchyElement>
            <id>110000000401</id>
            <geoPath>/de/berlin/berlin/charlottenburg-wilmersdorf/charlottenburg</geoPath>
            <gacLabel>Berlin - Charlottenburg</gacLabel>
            <seoLabel>Charlottenburg (Berlin)</seoLabel>
            <type>quarter</type>
            <statistics>
                <GeoHierarchyStatistic realEstateType="SPECIAL_PURPOSE" count="2"/>
                <GeoHierarchyStatistic realEstateType="HOUSE_BUY" count="3"/>
            </statistics>
        </geoPathHierarchyElement>
        <geoPathHierarchyElement>
            <id>110000000406</id>
            <geoPath>/de/berlin/berlin/charlottenburg-wilmersdorf/charlottenburg-nord</geoPath>
            <gacLabel>Berlin - Charlottenburg-Nord</gacLabel>
            <seoLabel>Charlottenburg-Nord (Berlin)</seoLabel>
            <type>quarter</type>
            <statistics>
                <GeoHierarchyStatistic realEstateType="SPECIAL_PURPOSE" count="0"/>
                <GeoHierarchyStatistic realEstateType="HOUSE_BUY" count="0"/>
            </statistics>
        </geoPathHierarchyElement>
        <geoPathHierarchyElement>
            <id>110000000404</id>
            <geoPath>/de/berlin/berlin/charlottenburg-wilmersdorf/grunewald</geoPath>
            <gacLabel>Berlin - Grunewald</gacLabel>
            <seoLabel>Grunewald (Berlin)</seoLabel>
            <type>quarter</type>
            <statistics>
                <GeoHierarchyStatistic realEstateType="SPECIAL_PURPOSE" count="0"/>
                <GeoHierarchyStatistic realEstateType="HOUSE_BUY" count="5"/>
            </statistics>
        </geoPathHierarchyElement>
        <geoPathHierarchyElement>
            <id>110000000407</id>
            <geoPath>/de/berlin/berlin/charlottenburg-wilmersdorf/halensee</geoPath>
            <gacLabel>Berlin - Halensee</gacLabel>
            <seoLabel>Halensee (Berlin)</seoLabel>
            <type>quarter</type>
            <statistics>
                <GeoHierarchyStatistic realEstateType="SPECIAL_PURPOSE" count="0"/>
                <GeoHierarchyStatistic realEstateType="HOUSE_BUY" count="0"/>
            </statistics>
        </geoPathHierarchyElement>
        <geoPathHierarchyElement>
            <id>110000000403</id>
            <geoPath>/de/berlin/berlin/charlottenburg-wilmersdorf/schmargendorf</geoPath>
            <gacLabel>Berlin - Schmargendorf</gacLabel>
            <seoLabel>Schmargendorf (Berlin)</seoLabel>
            <type>quarter</type>
            <statistics>
                <GeoHierarchyStatistic realEstateType="SPECIAL_PURPOSE" count="0"/>
                <GeoHierarchyStatistic realEstateType="HOUSE_BUY" count="2"/>
            </statistics>
        </geoPathHierarchyElement>
        <geoPathHierarchyElement>
            <id>110000000405</id>
            <geoPath>/de/berlin/berlin/charlottenburg-wilmersdorf/westend</geoPath>
            <gacLabel>Berlin - Westend</gacLabel>
            <seoLabel>Westend (Berlin)</seoLabel>
            <type>quarter</type>
            <statistics>
                <GeoHierarchyStatistic realEstateType="SPECIAL_PURPOSE" count="0"/>
                <GeoHierarchyStatistic realEstateType="HOUSE_BUY" count="7"/>
            </statistics>
        </geoPathHierarchyElement>
        <geoPathHierarchyElement>
            <id>110000000402</id>
            <geoPath>/de/berlin/berlin/charlottenburg-wilmersdorf/wilmersdorf</geoPath>
            <gacLabel>Berlin - Wilmersdorf</gacLabel>
            <seoLabel>Wilmersdorf (Berlin)</seoLabel>
            <type>quarter</type>
            <statistics>
                <GeoHierarchyStatistic realEstateType="SPECIAL_PURPOSE" count="0"/>
                <GeoHierarchyStatistic realEstateType="HOUSE_BUY" count="9"/>
            </statistics>
        </geoPathHierarchyElement>
    </children>
</common:geoPathHierarchyElementsStatistic>

JSON

GET https://rest.immobilienscout24.de/restapi/api/search/v1.0/statistic?shapeid=1100000004&realestatetypes=specialpurpose,housebuy

{
    "common.geoPathHierarchyElementsStatistic": {
        "parent": {
            "id": "1100000004",
            "geoPath": "/de/berlin/berlin/charlottenburg-wilmersdorf",
            "gacLabel": "Berlin - Charlottenburg-Wilmersdorf",
            "seoLabel": "Charlottenburg-Wilmersdorf (Berlin)",
            "type": "borough",
            "statistics": {
                "GeoHierarchyStatistic": [
                    {
                        "@realEstateType": "SPECIAL_PURPOSE",
                        "@count": "2"
                    },
                    {
                        "@realEstateType": "HOUSE_BUY",
                        "@count": "26"
                    }
                ]
            }
        },
        "children": {
            "geoPathHierarchyElement": [
                {
                    "id": "110000000401",
                    "geoPath": "/de/berlin/berlin/charlottenburg-wilmersdorf/charlottenburg",
                    "gacLabel": "Berlin - Charlottenburg",
                    "seoLabel": "Charlottenburg (Berlin)",
                    "type": "quarter",
                    "statistics": {
                        "GeoHierarchyStatistic": [
                            {
                                "@realEstateType": "SPECIAL_PURPOSE",
                                "@count": "2"
                            },
                            {
                                "@realEstateType": "HOUSE_BUY",
                                "@count": "3"
                            }
                        ]
                    }
                },
                {
                    "id": "110000000406",
                    "geoPath": "/de/berlin/berlin/charlottenburg-wilmersdorf/charlottenburg-nord",
                    "gacLabel": "Berlin - Charlottenburg-Nord",
                    "seoLabel": "Charlottenburg-Nord (Berlin)",
                    "type": "quarter",
                    "statistics": {
                        "GeoHierarchyStatistic": [
                            {
                                "@realEstateType": "SPECIAL_PURPOSE",
                                "@count": "0"
                            },
                            {
                                "@realEstateType": "HOUSE_BUY",
                                "@count": "0"
                            }
                        ]
                    }
                },
                {
                    "id": "110000000404",
                    "geoPath": "/de/berlin/berlin/charlottenburg-wilmersdorf/grunewald",
                    "gacLabel": "Berlin - Grunewald",
                    "seoLabel": "Grunewald (Berlin)",
                    "type": "quarter",
                    "statistics": {
                        "GeoHierarchyStatistic": [
                            {
                                "@realEstateType": "SPECIAL_PURPOSE",
                                "@count": "0"
                            },
                            {
                                "@realEstateType": "HOUSE_BUY",
                                "@count": "5"
                            }
                        ]
                    }
                },
                {
                    "id": "110000000407",
                    "geoPath": "/de/berlin/berlin/charlottenburg-wilmersdorf/halensee",
                    "gacLabel": "Berlin - Halensee",
                    "seoLabel": "Halensee (Berlin)",
                    "type": "quarter",
                    "statistics": {
                        "GeoHierarchyStatistic": [
                            {
                                "@realEstateType": "SPECIAL_PURPOSE",
                                "@count": "0"
                            },
                            {
                                "@realEstateType": "HOUSE_BUY",
                                "@count": "0"
                            }
                        ]
                    }
                },
                {
                    "id": "110000000403",
                    "geoPath": "/de/berlin/berlin/charlottenburg-wilmersdorf/schmargendorf",
                    "gacLabel": "Berlin - Schmargendorf",
                    "seoLabel": "Schmargendorf (Berlin)",
                    "type": "quarter",
                    "statistics": {
                        "GeoHierarchyStatistic": [
                            {
                                "@realEstateType": "SPECIAL_PURPOSE",
                                "@count": "0"
                            },
                            {
                                "@realEstateType": "HOUSE_BUY",
                                "@count": "2"
                            }
                        ]
                    }
                },
                {
                    "id": "110000000405",
                    "geoPath": "/de/berlin/berlin/charlottenburg-wilmersdorf/westend",
                    "gacLabel": "Berlin - Westend",
                    "seoLabel": "Westend (Berlin)",
                    "type": "quarter",
                    "statistics": {
                        "GeoHierarchyStatistic": [
                            {
                                "@realEstateType": "SPECIAL_PURPOSE",
                                "@count": "0"
                            },
                            {
                                "@realEstateType": "HOUSE_BUY",
                                "@count": "7"
                            }
                        ]
                    }
                },
                {
                    "id": "110000000402",
                    "geoPath": "/de/berlin/berlin/charlottenburg-wilmersdorf/wilmersdorf",
                    "gacLabel": "Berlin - Wilmersdorf",
                    "seoLabel": "Wilmersdorf (Berlin)",
                    "type": "quarter",
                    "statistics": {
                        "GeoHierarchyStatistic": [
                            {
                                "@realEstateType": "SPECIAL_PURPOSE",
                                "@count": "0"
                            },
                            {
                                "@realEstateType": "HOUSE_BUY",
                                "@count": "9"
                            }
                        ]
                    }
                }
            ]
        }
    }
}