# ZVG-Portal Reference API Documentation

<p><strong>ZVG-Portal Reference API</strong> lists the filter values: the 16 lands with their courts, the object types (<code>object_type</code> ids), the procedure types (<code>procedure_type</code> ids) and the sort options. The sample is shortened.</p>

- **Documentation:** [https://scrappa.co/docs/zvg-portal-api/zvg_portal_reference](https://scrappa.co/docs/zvg-portal-api/zvg_portal_reference)
- **API group:** ZVG-Portal API
- **Endpoint:** `GET https://scrappa.co/api/zvg-portal/v1/reference`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Example response

```json
{
    "data": {
        "lands": [
            {
                "land": "bw",
                "name": "Baden-W\u00fcrttemberg",
                "courts": [
                    {
                        "name": "Amtsgericht Biberach",
                        "court_id": "B2402"
                    },
                    {
                        "name": "Amtsgericht Calw",
                        "court_id": "B2701"
                    }
                ]
            }
        ],
        "sorts": [
            {
                "id": "updated",
                "label": "Last update (newest first)"
            },
            {
                "id": "auction_date",
                "label": "Auction date (soonest first)"
            },
            {
                "id": "case_number",
                "label": "Case number"
            },
            {
                "id": "price_asc",
                "label": "Appraised value (lowest first)"
            },
            {
                "id": "price_desc",
                "label": "Appraised value (highest first)"
            }
        ],
        "object_types": [
            {
                "id": 1,
                "label": "Reihenhaus"
            },
            {
                "id": 2,
                "label": "Doppelhaush\u00e4lfte"
            },
            {
                "id": 3,
                "label": "Einfamilienhaus"
            }
        ],
        "procedure_types": [
            {
                "id": -1,
                "label": "Zwangsversteigerung zum Zwecke der Aufhebung der Gemeinschaft"
            },
            {
                "id": 0,
                "label": "Versteigerung im Wege der Zwangsvollstreckung"
            },
            {
                "id": 1,
                "label": "Zwangsversteigerung auf Antrag des Insolvenzverwalters"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "reference"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter or a value is invalid. This response is not billable. |
| 503 | Upstream Unavailable | ZVG-Portal could not be reached. This response is not billable and is retryable. |
| 503 | Unexpected Upstream Data | ZVG-Portal returned data in an unexpected shape. This response is not billable and is retryable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)