Skip to content
Scrappa Get API key
ZVG-Portal API 1 credit/request

ZVG-Portal Auction Search API Documentation

GET https://scrappa.co/api/zvg-portal/v1/search

ZVG-Portal Auction Search API searches the public foreclosure auctions (Zwangsversteigerung) of the German courts. Sale auctions only: the portal has no rent, bedroom, bathroom, photo or coordinate data, so the API has none either. Requests with listing_type, bedrooms, bathrooms, min_area or max_area return a 422 with the reason.

The land parameter is required. Hamburg (hh) and Mecklenburg-Vorpommern (mv) have no auctions on the portal and return an empty list.

The appraised value (verkehrswert) is free text on the portal. The API returns the text in raw, the first amount in amount and every amount in amounts. The price filter and the price sorts use the first amount. A cancelled auction (cancelled: true, no zvg_id) has no object, address or value, so it never matches a type, price or address filter. Auctions without a value come last in price sorts.

Paging is exact: the portal returns all auctions of a land at once and the API cuts the page after filtering and sorting. A page past the last page returns an empty list with the true page number and totals. filtered_out counts the auctions removed by the filters. Large lands (Nordrhein-Westfalen, Bayern) can take several seconds.

Documents are returned as links with name and size. The files are not fetched.

ZVG-Portal Auction Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zvg-portal/v1/search
Auth header
x-api-key
Cost
1 credit/request
land = example
Response preview
200 OK
{
    "data": {
        "listings": [
            {
                "url": "https://www.zvg-portal.de/index.php?button=showZvg&zvg_id=4812&land_abk=hb",
                "land": "hb",
                "court": "Bremen",
                "zvg_id": 4812,
                "address": {
                    "city": "Bremerhaven",
                    "text": "Gnesener Stra\u00dfe 18, 27576 Bremerhaven",
                    "street": "Gnesener Stra\u00dfe 18",
                    "district": null,
                    "postal_code": "27576"
...

Parameters

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

Runnable path

1 required parameter needed before sending a request.

16 optional filters available.

land string Required

Land code from the reference route, e.g. be, by, hb, nw. Example: hb.

Example value example
court string Optional

court_id of an Amtsgericht in that land, from the locations or reference route. Example: H1101.

Example value example
object_type string Optional

One or more object type ids from the reference route (repeat the parameter or comma-separate). Example: 5,6.

Example value example
procedure_type integer Optional

Procedure type id from the reference route. Example: 0 (Zwangsvollstreckung).

Example value 10
plz string Optional

Postal code or its first digits. Example: 28.

Example value example
city string Optional

City name. Example: Bremerhaven.

Example value example
district string Optional

District name (Ortsteil). Example: Hastedt.

Example value example
street string Optional

Street name. Example: Gnesener.

Example value example
house_number string Optional

House number. Example: 18.

Example value example
case_number string Optional

Case number as 0030 K 0026/2025, K 26/2025 or 26/2025.

Example value example
date_from string Optional

First auction day, YYYY-MM-DD. Other formats return a 422. Example: 2026-11-01.

Example value 2026-06-15
date_to string Optional

Last auction day, YYYY-MM-DD. Example: 2026-11-30.

Example value 2026-06-15
min_price integer Optional

Minimum appraised value in EUR (first amount).

Example value 10
max_price integer Optional

Maximum appraised value in EUR (first amount).

Example value 10
sort string Optional

auction_date (default), updated, case_number, price_asc or price_desc. Example: price_asc.

Example value relevance
page integer Optional

One-based page number (default 1). Example: 2.

Example value 1
per_page integer Optional

Results per page, 1 to 100 (default 25). Example: 10.

Example value 10

Response Schema

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

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "listings": [
            {
                "url": "https://www.zvg-portal.de/index.php?button=showZvg&zvg_id=4812&land_abk=hb",
                "land": "hb",
                "court": "Bremen",
                "zvg_id": 4812,
                "address": {
                    "city": "Bremerhaven",
                    "text": "Gnesener Stra\u00dfe 18, 27576 Bremerhaven",
                    "street": "Gnesener Stra\u00dfe 18",
                    "district": null,
                    "postal_code": "27576"
                },
                "cancelled": false,
                "updated_at": "2026-08-13T11:29:00+02:00",
                "attachments": [
                    {
                        "url": "https://www.zvg-portal.de/index.php?button=showAnhang&land_abk=hb&file_id=8320&zvg_id=4812",
                        "kind": null,
                        "name": "Amtliche Bekanntmachung",
                        "file_id": 8320,
                        "size_kb": 62.42,
                        "size_text": "62.42 kB"
                    }
                ],
                "case_number": "0011 b K 0078/2025",
                "object_type": "Eigentumswohnung (1 bis 2 Zimmer), 2-Zimmer-Wohnung",
                "auction_date": "2026-11-09T09:30:00+01:00",
                "verkehrswert": {
                    "raw": "6.000,00 \u20ac",
                    "amount": 6000,
                    "amounts": [
                        6000
                    ],
                    "currency": "EUR"
                },
                "auction_date_text": "Montag, 09. November 2026, 09:30 Uhr"
            },
            {
                "url": "https://www.zvg-portal.de/index.php?button=showZvg&zvg_id=4816&land_abk=hb",
                "land": "hb",
                "court": "Bremen",
                "zvg_id": 4816,
                "address": {
                    "city": "Bremen",
                    "text": "Gro\u00dfbeerenstra\u00dfe 23, 25, Loignystra\u00dfe, 28211 Bremen, Schwachhausen",
                    "street": "Gro\u00dfbeerenstra\u00dfe 23, 25, Loignystra\u00dfe",
                    "district": "Schwachhausen",
                    "postal_code": "28211"
                },
                "cancelled": false,
                "updated_at": "2026-09-01T09:25:00+02:00",
                "attachments": [
                    {
                        "url": "https://www.zvg-portal.de/index.php?button=showAnhang&land_abk=hb&file_id=8331&zvg_id=4816",
                        "kind": null,
                        "name": "Amtliche Bekanntmachung",
                        "file_id": 8331,
                        "size_kb": 101.85,
                        "size_text": "101.85 kB"
                    }
                ],
                "case_number": "0026 K 0059/2024",
                "object_type": "Sonstiges",
                "auction_date": "2026-11-11T09:30:00+01:00",
                "verkehrswert": {
                    "raw": "223.000,--",
                    "amount": 223000,
                    "amounts": [
                        223000
                    ],
                    "currency": "EUR"
                },
                "auction_date_text": "Mittwoch, 11. November 2026, 09:30 Uhr"
            }
        ],
        "search_metadata": {
            "page": 1,
            "per_page": 2,
            "total_pages": 8,
            "filtered_out": 0,
            "has_next_page": true,
            "total_results": 15,
            "upstream_total": 15,
            "dropped_invalid": 0
        },
        "search_parameters": {
            "plz": null,
            "city": null,
            "land": "hb",
            "page": 1,
            "sort": "auction_date",
            "court": null,
            "street": null,
            "date_to": null,
            "district": null,
            "per_page": 2,
            "date_from": null,
            "max_price": null,
            "min_price": null,
            "case_number": null,
            "object_type": null,
            "house_number": null,
            "procedure_type": null
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "search"
    },
    "success": true
}

Errors

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

422

Validation Error

A required parameter or a value is invalid. This response is not billable.

{
    "errors": {
        "field": [
            "The field is invalid."
        ]
    },
    "message": "The request validation failed"
}
503

Upstream Unavailable

ZVG-Portal could not be reached. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "ZVG-Portal could not be reached. Please retry shortly."
    },
    "success": false
}
503

Unexpected Upstream Data

ZVG-Portal returned data in an unexpected shape. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "INVALID_UPSTREAM_SHAPE",
        "message": "ZVG-Portal returned data in an unexpected shape. Please retry shortly."
    },
    "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.