ZVG-Portal Reference API lists the filter values: the 16 lands with their courts, the object types (object_type ids), the procedure types (procedure_type ids) and the sort options. The sample is shortened.
Run this endpoint
Endpoint
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"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
Handle these documented responses before retrying or showing customer-facing failures.
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"
}Upstream Unavailable
ZVG-Portal could not be reached. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "reference"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "ZVG-Portal could not be reached. Please retry shortly."
},
"success": false
}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": "reference"
},
"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.