# CleanedWeb

- Documentation hub for people and agents: https://cleanedweb.com/docs/

> CleanedWeb provides maintained canonical property data with source-advertisement provenance, stable property identifiers, observed changes, and delivery-safe schemas.

## Authoritative machine interfaces

- [Runtime capabilities](https://app.cleanedweb.com/v1/capabilities): Check contract version, currently ready markets, supported filters, event types, freshness definitions, limits, and published Unit costs before planning work.
- [OpenAPI 3.1](https://cleanedweb.com/openapi.json): Public contract for authenticated property operations and request/response schemas.
- [Property schema](https://cleanedweb.com/schemas/property-profile-v2.json): Global canonical maintained property profile.
- [Property event schema](https://cleanedweb.com/schemas/property-event-v1.json): Finalized observed property events.
- [Error schema](https://cleanedweb.com/schemas/error-v1.json): Stable error envelope for documented property operations.
- [Field catalog](https://cleanedweb.com/schemas/property-profile-field-catalog-v2.json): Field semantics, units, omission behavior, canonical identity, and provenance boundaries.
- [Search request example](https://cleanedweb.com/examples/search-request.json)
- [Search response example](https://cleanedweb.com/examples/search-response.json)
- [Property profile example](https://cleanedweb.com/examples/property-profile-v2.json)
- [Webhook event example](https://cleanedweb.com/examples/webhook-event.json)

## Integration guides

- [AI agent integration](https://cleanedweb.com/docs/ai-agents.md): Discovery, authentication, search, validation, freshness, and safe retries.
- [MCP status and adapter guide](https://cleanedweb.com/docs/mcp.md): Current transport status, bounded tool mapping, output schemas, resources, credential isolation, and metering.
- [Signed webhooks](https://cleanedweb.com/docs/webhooks.md): Events, raw-body verification, duplicates, retries, rotation, and replay.
- [Errors and recovery](https://cleanedweb.com/docs/errors.md): Stable codes, response boundaries, and retry decisions.
- [Data contract](https://cleanedweb.com/docs/data-contract.md): Canonical identity, missing values, units, freshness, contact data, and provenance.
- [Security](https://cleanedweb.com/docs/security.md): Credential boundaries, rotation, secret handling, workspace isolation, and explicit non-claims.
- [Operations](https://cleanedweb.com/docs/operations.md): Runtime readiness, limits, retries, receipts, freshness, and escalation evidence.
- [Versioning](https://cleanedweb.com/docs/versioning.md): Compatibility, deprecation, migration, and agent behavior.
- [Workflows](https://cleanedweb.com/docs/workflows.md): Deterministic search, recovery, property-history, and webhook procedures.
- [Reference clients](https://cleanedweb.com/docs/reference-clients.md): Safe Python and TypeScript-compatible client behavior.
- [Arazzo workflows](https://cleanedweb.com/arazzo.json): Machine-readable bounded-search and property-history workflows.
- [AsyncAPI webhooks](https://cleanedweb.com/asyncapi.json): Machine-readable signed event-delivery contract.
- [Contract changelog](https://cleanedweb.com/changelog.json): Versioned, machine-readable contract history.
- [Consolidated agent documentation](https://cleanedweb.com/llms-full.txt): Self-contained machine-readable integration reference.

## Important boundaries

- API base URL: `https://app.cleanedweb.com`.
- `GET /v1/capabilities` is public. Browser property operations use the signed-in workspace session cookie.
- API-key authentication and `https://app.cleanedweb.com/mcp` are release-gated. Use them only when `machine_access.enabled` is true at runtime.
- Data is the latest maintained serving snapshot, not live scraping at request time. Read freshness from runtime metadata.
- For exact count-only questions, use `cleanedweb_count_properties` or `POST /v1/properties/count`; do not run property search merely to count and discard records.
- Do not infer availability, entitlement, or cost from marketing pages or static coverage. Use capabilities, authenticated market metadata, and workspace receipts.