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

ZVG-Portal Locations API Documentation

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

ZVG-Portal Locations API finds German lands and Amtsgerichte by name and returns the land code and court id that the search and court routes need. The portal has no city or postal code suggest, so use the city and plz search filters for those. Without q the route lists all lands.

ZVG-Portal Locations API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zvg-portal/v1/locations
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "land": null,
        "query": "bremen",
        "total": 3,
        "locations": [
            {
                "land": "hb",
                "name": "Bremen",
                "type": "land",
                "court_id": null,
                "court_count": 3
            },
            {
...

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.

2 optional filters available.

q string Optional

Text to match in a land or court name. Example: bremen.

Example value coffee shops
land string Optional

Land code to list only that land and its courts. Example: be.

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": {
        "land": null,
        "query": "bremen",
        "total": 3,
        "locations": [
            {
                "land": "hb",
                "name": "Bremen",
                "type": "land",
                "court_id": null,
                "court_count": 3
            },
            {
                "land": "hb",
                "name": "Amtsgericht Bremen",
                "type": "court",
                "court_id": "H1101",
                "court_count": null
            },
            {
                "land": "hb",
                "name": "Amtsgericht Bremen-Blumenthal",
                "type": "court",
                "court_id": "H1103",
                "court_count": null
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "locations"
    },
    "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": "locations"
    },
    "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": "locations"
    },
    "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.