ImmobilienScout24 Austria Facets API Documentation

GET https://scrappa.co/api/immoscout24-at/facets

Scrappa's `GET /api/immoscout24-at/facets` endpoint returns the total number of listings for a filter set and the count per facet value, without returning the listings themselves.

## Facet blocks

The response has 22 blocks, for example property type and subtype, condition, building age, outdoor space, facilities, lift, furnishing, parking, private and developer listings, and the place hierarchy. Use it to build filter menus with live counts or to track market size cheaply.</p>

Run this endpoint

ImmobilienScout24 Austria Facets API Documentation 1 credit/request

Get API key Open Playground

Request preview

GET

https://scrappa.co/api/immoscout24-at/facets

Auth header: x-api-key
Cost: 1 credit/request

Response preview

200 OK

{
    "data": {
        "totalHits": 3881,
        "aggregations": {
            "conditionAge": {
                "NEWBUILDING": 2715,
                "OLDBUILDING": 607
            },
            "areaOutdoorSpaces": {
                "BALCONY": 1622,
                "TERRACE": 1007
            }
        }
    },
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

This endpoint has no required query parameters.

37 optional filters available.

transfer_type


                                        string

Optional

Deal type. One of: BUY, RENT, LEASE, LEASEHOLD, TEMPORARY_RENT. Defaults to RENT. Several values are comma separated.

Example value


                                        example

estate_type


                                        string

Optional

Property type. One of: APARTMENT, HOUSE, OFFICE, PROPERTY, INDUSTRIAL, RETAIL, PARKING_PLACE, INVESTMENTPROPERTY, MISCELLANEOUS, GASTRONOMY, AGRICULTURE_AND_TIMBER, HOTEL, ROOM, LEISUREFACILITY. Defaults to APARTMENT. Several values are comma separated.

Example value


                                        example

estate_detail_type


                                        string

Optional

Property subtype such as PENTHOUSE, LOFT, MAISONETTE or VILLA. One of: AGRICULTURE_HOLDING, APARTMENT, APARTMENTHOUSE, BAR, BARN, BED_AND_BREAKFAST, BOOTBERTH, BUNGALOW, CAFE, CARPORT, DOCTORS_OFFICE, DUPLEX, END_TERRACE_HOUSE, EXHIBITION_SPACE, FARM, FARMHOUSE, FIELD, FLOOR_APARTMENT, FUNFAIR, GARAGE, GASSTATION, GASTRONOMY, GROUND_FLOOR, HALF_BASEMENT, HEALTHCARE, HORSE_STABLE, HOTEL, HUNTING_GROUND, INDUSTRIAL, LAND, LOFT, MAISONETTE, MID_TERRACE_HOUSE, MISCELLANEOUS, MISCELLANEOUS_AGRICULTURE_AND_TIMBER, MISCELLANEOUS_GASTRONOMY, MISCELLANEOUS_HOTEL, MISCELLANEOUS_HOUSE, MISCELLANEOUS_INDUSTRIAL, MISCELLANEOUS_INVESTEMENTPROPERTY, MISCELLANEOUS_RETAIL, MULTI_FAMILY_HOUSE, OFFICE, OFFICE_BUILDING, OPEN_AREA, PARKING_SPACE, PARKINGHOUSE, PENTHOUSE, PRODUCTION, RESTAURANT, RETAIL_SHOP, RETAIL_STORE, ROOF_STOREY, ROUGH_ATTIC, SEMIDETACHED_HOUSE, SHARED_OFFICE_SPACE, SHOP, SHOPPING_CENTER, SINGLE_FAMILY_HOUSE, SINGLE_GARAGE, SPECIAL_OFFICE, SPORTSAREA, SUPERMARKET, TERRACE_HOUSE, TERRACED_FLAT, TOWN_HOUSE, UNDERGROUND_PARKING_PLACE, VILLA, VINEYARD, WAREHOUSE, WORKSHOP. Several values are comma separated.

Example value


                                        example

use_type


                                        string

Optional

One of: RESIDENTIAL, COMMERCIAL. Defaults to RESIDENTIAL.

Example value


                                        example

region


                                        string

Optional

Region id from the locations or autocomplete endpoint, for example 009001 (Vienna) or 009001022 (Vienna, 22nd district). An id the portal does not know is rejected without charge.

Example value

US

zip_code


                                        string

Optional

Four digit Austrian postcode.

Example value


                                        example

keywords


                                        string

Optional

Free-text keywords.

Example value


                                        running shoes

price_from


                                        number

Optional

Minimum price in euro (monthly for rent).

Example value

price_to


                                        number

Optional

Maximum price in euro (monthly for rent).

Example value

rooms_from


                                        number

Optional

Minimum number of rooms.

Example value

rooms_to


                                        number

Optional

Maximum number of rooms.

Example value

area_from


                                        number

Optional

Minimum living area in square meters.

Example value

area_to


                                        number

Optional

Maximum living area in square meters.

Example value

plot_area_from


                                        number

Optional

Minimum plot area in square meters.

Example value

plot_area_to


                                        number

Optional

Maximum plot area in square meters.

Example value

price_per_sqm_from


                                        number

Optional

Minimum price per square meter.

Example value

price_per_sqm_to


                                        number

Optional

Maximum price per square meter.

Example value

condition_type


                                        string

Optional

Condition. One of: DEMOLITION, FIRST_TIME_USE, FIRST_TIME_USE_AFTER_REFURBISHMENT, FRAMING, FULLY_REFURBISHED, FULLY_RENOVATED, GUTTED, MINT_CONDITION, MODERNIZED, NEED_OF_RENOVATION, NEED_TO_DISCUSS, PARTLY_REFURBISHED, PROJECTPHASE, REFURBISHED, WELL_KEPT. Several values are comma separated.

Example value


                                        example

condition_age


                                        string

Optional

One of: NEWBUILDING, OLDBUILDING.

Example value


                                        example

outdoor_spaces


                                        string

Optional

Outdoor space. One of: BALCONY, GARDEN, LOGGIA, TERRACE. Several values are comma separated.

Example value


                                        example

facilities


                                        string

Optional

Facilities. One of: AIR_CONDITIONING, ATTIC, BIKE_ROOM, CABLE_DUCTS, CELLAR, CELLAR_PARTIAL, CRANE, EV_CHARGING_STATION, FIREPLACE, GARDEN, GUEST_TERRACE, GUEST_TOILET, HOLIDAY_PROPERTY_PHONE, LIBRARY, LIFTING_PLATTFORM, PARCEL_DELIVERY_BOX, PHOTOVOLTAIC_SYSTEM, RAMP, SAUNA, SHUTTER, SMART_HOME_SYSTEM, SPORTS_FACILITIES, STOREROOM, SWIMMING_POOL, WASHING_DRYING_ROOM, WELLNESS_AREA, WINTER_GARDEN. Several values are comma separated.

Example value


                                        example

furnishing


                                        string

Optional

One of: FULL, PART.

Example value


                                        example

lift


                                        string

Optional

One of: LIFT, FREIGHT_LIFT.

Example value


                                        example

accessibility


                                        string

Optional

One of: HANDICAPPED_ACCESSIBLE, SENIOR_CARE, SUITABLE_FOR_WHEELCHAIRS. Several values are comma separated.

Example value


                                        example

bathroom


                                        string

Optional

One of: BATHTUBE, BIDET, SHOWER, URINAL, WINDOW. Several values are comma separated.

Example value


                                        example

construction_method


                                        string

Optional

One of: MASSIVE, PREFABRICATED, WOOD. Several values are comma separated.

Example value


                                        example

parking_spaces


                                        number

Optional

Minimum number of parking spaces.

Example value

transit_line_types


                                        string

Optional

Public transport nearby. One of: BUS, CABLE_CAR, FERRY, REGIONAL_TRAIN, SUBWAY, TRAM, URBAN_TRAIN. Several values are comma separated.

Example value


                                        example

has_commission


                                        boolean

Optional

Set false for listings without agent commission.

Example value


                                        true

is_private_insertion


                                        boolean

Optional

Set true for private listings only.

Example value


                                        true

is_developer_project


                                        boolean

Optional

Set true for new-build projects only.

Example value


                                        true

is_investment_property


                                        boolean

Optional

Set true for investment properties only.

Example value


                                        true

is_forced_sale


                                        boolean

Optional

Set true for forced sales only.

Example value


                                        true

is_shortterm_rentable


                                        boolean

Optional

Set true for short-term rentals only.

Example value


                                        true

is_suitable_as_holiday_home


                                        boolean

Optional

Set true for holiday homes only.

Example value


                                        true

requires_financial_contribution


                                        boolean

Optional

Set true for listings that need a financial contribution.

Example value


                                        true

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Open in Playground

Example response fields

Scan these fields before integrating.

data meta success

JSON Response

200 OK

{
    "data": {
        "totalHits": 3881,
        "aggregations": {
            "conditionAge": {
                "NEWBUILDING": 2715,
                "OLDBUILDING": 607
            },
            "areaOutdoorSpaces": {
                "BALCONY": 1622,
                "TERRACE": 1007
            }
        }
    },
    "meta": {
        "attempts": 1,
        "billable": true,
        "duration_ms": 640
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

404

Not Found

The requested listing, agency or place does not exist. Non-billable and not retryable.

{
    "meta": {
        "billable": false,
        "retryable": false
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested ImmobilienScout24 Austria resource was not found.",
        "failure_type": "not_found"
    },
    "success": false
}

422

Validation Error

A query parameter failed validation: a missing required value, an unsupported filter value or a number outside the documented range. Every filter value is checked before a request is made, so a typo is never answered with a plausible but unfiltered result. Non-billable.

{
    "errors": {
        "estate_type": [
            "The estate_type field contains an unsupported value: FOO."
        ]
    },
    "message": "The request validation failed"
}

503

Request Rejected

ImmobilienScout24 Austria answered with an application error, for example a region it does not know. Non-billable and not retryable: the same request fails the same way. Published as 503; branch on `meta.retryable` rather than on the status code.

{
    "meta": {
        "billable": false,
        "retryable": false
    },
    "error": {
        "code": "UPSTREAM_REJECTED",
        "message": "ImmobilienScout24 Austria could not accept this request. Please check the filters and retry.",
        "failure_type": "invalid_request"
    },
    "success": false
}

503

Temporarily Unavailable

ImmobilienScout24 Austria could not be reached. Every attempt is made again on a fresh route before this is returned, so it is always retryable. The `failure_type` is one of `upstream_unreachable`, `transport_error`, `edge_blocked`, `rate_limited` or `attempts_exhausted`. Non-billable; a later request is worth making.

{
    "meta": {
        "billable": false,
        "retryable": true
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The ImmobilienScout24 Austria API is temporarily unavailable. Please retry.",
        "failure_type": "transport_error"
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.

Get API key Open Playground

ImmobilienScout24 Austria Facets API Documentation

Endpoint

Parameters

Response Schema

Errors

Not Found

Validation Error

Request Rejected

Temporarily Unavailable

Generate Code with AI

Try It Live