{ "openapi": "3.0.1", "info": { "title": "ZVG-Portal Scraper — German Judicial Property Auctions", "description": "Extract forced-auction (Zwangsversteigerung) property listings from ZVG-Portal.de, the official German court-auction calendar shared by the Bund and all 16 Länder. Get case numbers, courts, property addresses, market value (Verkehrswert), auction dates, and official notice/appraisal PDFs.", "version": "0.1", "x-build-id": "9lJGRVeqmapjdMY8P" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/studio-amba~zvg-portal-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-studio-amba-zvg-portal-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/studio-amba~zvg-portal-scraper/runs": { "post": { "operationId": "runs-sync-studio-amba-zvg-portal-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/studio-amba~zvg-portal-scraper/run-sync": { "post": { "operationId": "run-sync-studio-amba-zvg-portal-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "bundesland": { "title": "State (Bundesland)", "enum": [ "nw", "by", "be", "br", "hb", "he", "ni", "rp", "sl", "sn", "st", "sh", "th", "bw", "hh", "mv", "alle" ], "type": "string", "description": "2-letter German state code, e.g. \"nw\" (Nordrhein-Westfalen), \"by\" (Bayern), \"be\" (Berlin). Use \"alle\" to loop over all 14 states that publish through this portal (Hamburg \"hh\" and Mecklenburg-Vorpommern \"mv\" always return 0 — they use a separate regional system and are skipped automatically in \"alle\" mode).", "default": "nw" }, "gerichtId": { "title": "Court (Amtsgericht) ID", "minimum": 0, "type": "integer", "description": "Filter to a single Amtsgericht by its internal ger_id. Leave at 0 (default) to search every court in the selected state(s).", "default": 0 }, "vonWert": { "title": "Minimum market value (EUR)", "minimum": 0, "type": "integer", "description": "Only return lots with a Verkehrswert (market value) at or above this amount." }, "bisWert": { "title": "Maximum market value (EUR)", "minimum": 0, "type": "integer", "description": "Only return lots with a Verkehrswert (market value) at or below this amount." }, "includeCancelled": { "title": "Include cancelled auctions", "type": "boolean", "description": "Include auctions marked \"wurde aufgehoben\" (cancelled). These carry no address, value, or detail link — not useful as leads. Default: skip them.", "default": false }, "scrapeDetails": { "title": "Scrape full details (court name, description, PDFs)", "type": "boolean", "description": "Fetch each listing's detail page for the real court (Amtsgericht) name, full description, land register (Grundbuch), auction venue address, and links to the official notice/appraisal PDFs. Adds one HTTP request per listing. Recommended — the search results list alone doesn't expose the court name.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of active (non-cancelled) auction listings to return.", "default": 200 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "ZVG-Portal.de has no anti-bot protection (verified) — proxy is not required for success, but recommended for large multi-state runs to be a good citizen." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }