# Zvg Portal — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and browse foreclosure auction listings across all German federal states via the official ZVG Portal. Retrieve paginated auction results, filter by state or court, and fetch full property details including valuations, auction dates, venue information, and document links.

**Category:** Real Estate | **Website:** [zvg-portal.de/](https://zvg-portal.de/) | **Docs:** [parse.bot/marketplace/74f52348-023c-42ed-ac93-9d933725534f/zvg-portal-de-api](https://parse.bot/marketplace/74f52348-023c-42ed-ac93-9d933725534f/zvg-portal-de-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/zvg-portal/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get auction detail

Retrieve full details for a specific auction including property description, valuation, auction venue, attached documents, and court information. Requires the zvg_id and land_abk pair from search_auctions results. Returns variable fields depending on the auction; common fields include Objekt/Lage, Beschreibung, Verkehrswert, Termin, Ort der Versteigerung, and a documents array.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `land_abk` | string | Yes | State abbreviation matching the auction's origin state (from search_auctions results[*].land_abk). |
| `zvg_id` | string | Yes | Unique auction ID from search_auctions results[*].zvg_id. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zvg-portal/get-auction-detail \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"land_abk":"<string>","zvg_id":"<string>"}'
```

### Get courts

Retrieve all German states and their district courts with IDs. Use court IDs as the ger_id parameter in search_auctions to filter results by court. Returns a list of state entries, each containing the state's code, full name, and an array of courts with id and name fields.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zvg-portal/get-courts \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Search auctions

Search for foreclosure auctions in a specific German state. Results are sorted by auction date and paginated (~20 per page). Supports filtering by auction type and court. Each result carries a zvg_id and land_abk pair needed to fetch full details. The total_count field reflects the full matching set server-side.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `all_results` | boolean | No | If true, attempts to retrieve all results at once instead of paginating. |
| `art` | string | No | Auction type filter. |
| `ger_id` | string | No | Court ID from get_courts endpoint (e.g. 'R3101' for Aachen). '0' returns all courts in the state. |
| `land_abk` | string | Yes | Two-letter German state abbreviation. |
| `page` | integer | No | Page number for pagination (1-based). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/zvg-portal/search-auctions \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"all_results":"<boolean>","art":"<string>","ger_id":"<string>","land_abk":"<string>","page":"<integer>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.