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

ZVG-Portal Court API Documentation

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

ZVG-Portal Court API returns the profile of one Amtsgericht, the agency of an auction, with all its current foreclosure auctions. The profile holds the court id, name, land and the number of auctions. The auctions use the same item shape, sort and paging as the search route. Get the court_id from the locations or reference route.

ZVG-Portal Court API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zvg-portal/v1/court
Auth header
x-api-key
Cost
1 credit/request
court = example
Response preview
200 OK
{
    "data": {
        "court": {
            "land": "hb",
            "name": "Amtsgericht Bremen",
            "court_id": "H1101",
            "land_name": "Bremen",
            "total_auctions": 15
        },
        "listings": [
            {
                "url": "https://www.zvg-portal.de/index.php?button=showZvg&zvg_id=4812&land_abk=hb",
                "land": "hb",
                "court": "Bremen",
...

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.

3 optional filters available.

court string Required

court_id of the Amtsgericht. Example: H1101.

Example value example
sort string Optional

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

Example value relevance
page integer Optional

One-based page number (default 1).

Example value 1
per_page integer Optional

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

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": {
        "court": {
            "land": "hb",
            "name": "Amtsgericht Bremen",
            "court_id": "H1101",
            "land_name": "Bremen",
            "total_auctions": 15
        },
        "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": "court"
    },
    "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": "court"
    },
    "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": "court"
    },
    "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.