{ "openapi": "3.0.1", "info": { "title": "German Foreclosure Auctions — Zwangsversteigerung", "description": "Court-ordered property auctions from Germany's official portal (zvg-portal.de), all 16 states. Auction date and time, court, file number, property type, full address, market value and the 50%/70% marks. Cancelled dates included. Around 3,400 live proceedings; run it as a monitor.", "version": "0.1", "x-build-id": "RNj518VHnkodcxDVG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/us0r~zwangsversteigerungen-de/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-us0r-zwangsversteigerungen-de", "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/us0r~zwangsversteigerungen-de/runs": { "post": { "operationId": "runs-sync-us0r-zwangsversteigerungen-de", "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/us0r~zwangsversteigerungen-de/run-sync": { "post": { "operationId": "run-sync-us0r-zwangsversteigerungen-de", "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": { "bundeslaender": { "title": "Federal states (Bundesländer)", "type": "array", "description": "Which states to cover. Leave empty for all 16. Note that Hamburg, Mecklenburg-Vorpommern and Schleswig-Holstein publish almost nothing on this portal.", "items": { "type": "string", "enum": [ "bw", "by", "be", "br", "hb", "hh", "he", "mv", "ni", "nw", "rp", "sl", "sn", "st", "sh", "th" ], "enumTitles": [ "Baden-Württemberg", "Bayern (Bavaria)", "Berlin", "Brandenburg", "Bremen", "Hamburg", "Hessen (Hesse)", "Mecklenburg-Vorpommern", "Niedersachsen (Lower Saxony)", "Nordrhein-Westfalen (North Rhine-Westphalia)", "Rheinland-Pfalz", "Saarland", "Sachsen (Saxony)", "Sachsen-Anhalt", "Schleswig-Holstein", "Thüringen (Thuringia)" ] }, "default": [] }, "objektKategorien": { "title": "Property categories", "type": "array", "description": "Keep only these kinds of property. Courts type the property type as free text, so the Actor sorts it into robust buckets — 'Haus' also matches misspellings like 'Einfamillienhaus'. Leave empty for everything.", "items": { "type": "string", "enum": [ "Haus", "Wohnung", "Grundstück", "Gewerbe", "Stellplatz", "Teileigentum" ], "enumTitles": [ "House (Haus)", "Apartment (Eigentumswohnung)", "Land / plot (Grundstück)", "Commercial (Gewerbe)", "Garage / parking (Stellplatz)", "Part-ownership, cellar, hobby room (Teileigentum)" ] }, "default": [] }, "verfahrensarten": { "title": "Type of proceeding", "type": "array", "description": "Restrict to certain proceedings. Setting this also forces the Actor to determine the type for every entry.", "items": { "type": "string", "enum": [ "0", "-1", "1", "2", "5", "8", "3", "4", "7", "6" ], "enumTitles": [ "Foreclosure by enforcement (Zwangsvollstreckung)", "Partition auction (Teilungsversteigerung)", "Filed by the insolvency administrator", "Filed by the heir", "Withdrawal of apartment ownership", "Other", "Ships and vessels", "Aircraft", "Public notice proceedings (Aufgebotsverfahren)", "Submarine cables" ] }, "default": [] }, "verkehrswertMin": { "title": "Minimum market value (EUR)", "type": "integer", "description": "Skip properties valued below this. Entries without a stated value are skipped as well when this is set." }, "verkehrswertMax": { "title": "Maximum market value (EUR)", "type": "integer", "description": "Skip properties valued above this." }, "plzPraefix": { "title": "Postcode prefixes", "type": "array", "description": "Keep only postcodes starting with one of these, e.g. \"80\" for Munich or \"1\" for all of eastern Berlin and Brandenburg.", "default": [], "items": { "type": "string" } }, "ort": { "title": "Filter by place or street", "type": "string", "description": "Only keep entries whose town, district or street contains this text (case-insensitive)." }, "terminInnerhalbTagen": { "title": "Auction within the next N days", "minimum": 1, "type": "integer", "description": "Keep only auctions scheduled within this many days. Leave empty for all — the median auction is about 48 days out, the furthest over four years." }, "ohneAufgehobeneTermine": { "title": "Skip cancelled auctions", "type": "boolean", "description": "About 5% of entries are cancelled auction dates. They carry no property data — but they are news if you are watching a debtor.", "default": false }, "nurAufgehobeneTermine": { "title": "Only cancelled auctions", "type": "boolean", "description": "The inverse: return nothing but cancellations.", "default": false }, "verfahrensartErmitteln": { "title": "Determine the type of proceeding", "type": "boolean", "description": "The portal does not show the type in the result list, so the Actor asks for it separately. Costs about 5 extra requests per state and matters: the 50%/70% value marks (§§ 74a, 85a ZVG) do not apply to partition auctions, which are 22% of cases in NRW and 42% in Bavaria.", "default": true }, "nurNeue": { "title": "Only new or changed entries", "type": "boolean", "description": "Remembers what previous runs returned and skips anything the court has not touched since. Turn this on for monitoring so you are not charged for the same entry twice.", "default": false }, "maxErgebnisse": { "title": "Maximum results", "minimum": 0, "type": "integer", "description": "Stop after this many entries. Set 0 for no limit — that is what you want for a real run; the default of 50 only keeps the first trial run short. All of Germany is about 3,400 entries.", "default": 50 }, "statusSpeicher": { "title": "State store name", "type": "string", "description": "Named key-value store holding what has already been seen. Use different names to run several independent monitors.", "default": "zvg-gesehen" }, "pauseSekunden": { "title": "Delay between requests", "minimum": 0, "maximum": 10, "type": "number", "description": "Seconds to wait before each request to the portal.", "default": 0.2 } } }, "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 } } } } } } } } } }