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

ZVG-Portal Listing API Documentation

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

ZVG-Portal Listing API returns the full record of one foreclosure auction: case number, last update, procedure type, land registry entry (Grundbuch), object type, address, description, appraised value, auction date and time, auction venue, court name and website, and the document links (notice, expert report, expose, photos as PDF).

area_m2 and year_built are read from the free description text when it names them (living area and Baujahr). Most auctions do not, so both are often null. The portal has no coordinates, photos, rent or agent data. An unknown zvg_id returns a not billable 404.

ZVG-Portal Listing API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zvg-portal/v1/listing
Auth header
x-api-key
Cost
1 credit/request
zvg_id = 1234567890 land = example
Response preview
200 OK
{
    "data": {
        "url": "https://www.zvg-portal.de/index.php?button=showZvg&zvg_id=4812&land_abk=hb",
        "land": "hb",
        "court": {
            "name": "Amtsgericht Bremerhaven",
            "website": "http://www.amtsgericht-bremerhaven.bremen.de/"
        },
        "zvg_id": 4812,
        "address": {
            "city": "Bremerhaven",
            "text": "Gnesener Stra\u00dfe 18, 27576 Bremerhaven",
            "street": "Gnesener Stra\u00dfe 18",
            "district": null,
...

Parameters

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

Runnable path

2 required parameters needed before sending a request.

zvg_id integer Required

The zvg_id of a search item. Example: 4812.

Example value 1234567890
land string Required

The land of that search item. Example: hb.

Example value example

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": {
        "url": "https://www.zvg-portal.de/index.php?button=showZvg&zvg_id=4812&land_abk=hb",
        "land": "hb",
        "court": {
            "name": "Amtsgericht Bremerhaven",
            "website": "http://www.amtsgericht-bremerhaven.bremen.de/"
        },
        "zvg_id": 4812,
        "address": {
            "city": "Bremerhaven",
            "text": "Gnesener Stra\u00dfe 18, 27576 Bremerhaven",
            "street": "Gnesener Stra\u00dfe 18",
            "district": null,
            "postal_code": "27576"
        },
        "area_m2": 41,
        "updated_at": "2026-08-13T11:29:00+02:00",
        "year_built": 1899,
        "attachments": [
            {
                "url": "https://www.zvg-portal.de/index.php?button=showAnhang&land_abk=hb&file_id=8320&zvg_id=4812",
                "kind": "amtliche Bekanntmachung",
                "name": "amtliche_Bekanntmachung1.pdf",
                "file_id": 8320,
                "size_kb": 62.42,
                "size_text": "62.42 kB"
            },
            {
                "url": "https://www.zvg-portal.de/index.php?button=showAnhang&land_abk=hb&file_id=8321&zvg_id=4812",
                "kind": "Foto",
                "name": "Kontoverbindung-Sicherheitsleistung",
                "file_id": 8321,
                "size_kb": 109.03,
                "size_text": "109.03 kB"
            }
        ],
        "case_number": "0011 b K 0078/2025",
        "description": "2-Zimmer-Wohnung mit Keller; Baujahr: 1899; Wohnfl\u00e4che: ca. 41 m\u00b2, Nutzfl\u00e4che: ca. 10 m\u00b2; das Objekt ist in einem desolaten Zustand; es gibt Feuchtigkeitssch\u00e4den, Putzsch\u00e4den an der Fassade und keine Brandschutzt\u00fcren sowie richtige Wohnungst\u00fcren; die Sanit\u00e4r- und Elektroinstallationen sind \u00fcberaltert; eine Innenbesichtigung fand jedoch nicht statt. F\u00fcr eine Zuschlagserteilung ist die Zustimmung des Verwalters erforderlich.",
        "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_venue": "Amtsgericht Bremerhaven, Nordstr. 10, Saal 100",
        "land_registry": "Lehe-West Blatt 6982",
        "procedure_type": "Versteigerung im Wege der Zwangsvollstreckung",
        "auction_date_text": "Montag, 09. November 2026, 09:30 Uhr"
    },
    "meta": {
        "billable": true,
        "endpoint_family": "listing"
    },
    "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"
}
404

Not Found

The auction does not exist or was removed. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "listing"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
503

Upstream Unavailable

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

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "listing"
    },
    "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": "listing"
    },
    "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.