property-radar 0.2.0

A safe, typed Python client for the PropertyRadar API

Property Radar Python Client

An unofficial, typed Python client for the PropertyRadar API.

Important: PropertyRadar documents its API for end users and restricts how its data may be used or redistributed. This library is not affiliated with or endorsed by PropertyRadar. Review the vendor terms and obtain any needed partner approval before using it in a product for third parties.

Status

Version 0.2.0 covers all 37 operations in official API 5.2.0.0 and adds an immutable, fingerprinted transaction-history contract with a strict typed parser. Releases are built once and published through the configured PyPI Trusted Publisher.

Installation

pip install property-radar

Safe Quickstart

from property_radar import PropertyRadarClient

criteria = [{"name": "RadarID", "value": ["P0000000"]}]

with PropertyRadarClient(api_key="your-api-key") as client:  # pragma: allowlist secret
    preview = client.properties.search(criteria=criteria)

Preview-capable endpoints send Purchase=0 by default. Persistent list, import, automation, and webhook operations require allow_mutations=True. Paid requests require both allow_charges=True on the client and purchase=True on the method call.

Typed Transaction Evidence

client.properties.transactions() remains the raw, backward-compatible envelope method. Version 0.2.0 adds client.properties.transaction_history() for immutable records and typed billing evidence.

The provider documents transaction Grantor and Grantee as scalar display strings, so the library preserves each whole value and reports party boundaries as unknown. Structured current-owner identities can be composed from the dedicated property-persons endpoint with PROPERTY_PERSON_IDENTITY_FIELDS; they remain separate from any unsupported person-to-transaction linkage.

Authentication

Pass the token explicitly or set PROPERTY_RADAR_API_KEY. The library does not load .env files and never needs an API credential for its test suite.

Development

uv sync --all-extras --locked
uv run ruff format --check .
uv run ruff check .
uv run mypy
uv run pytest
uv run mkdocs build --strict --clean
uv build
uv run twine check dist/*

See CONTRIBUTING.md and the development guide.

License

This client is licensed under the MIT License. PropertyRadar data and service access remain governed by PropertyRadar's own agreements.