Client
property_radar.PropertyRadarClient
Synchronous facade exposing PropertyRadar resource clients.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
api_key
|
str | None
|
Bearer token. Falls back to |
None
|
token_provider
|
Callable[[], str] | None
|
Callback returning a current bearer token. Mutually
exclusive with |
None
|
base_url
|
str
|
Absolute HTTPS PropertyRadar API origin without embedded credentials, a query, or a fragment. |
DEFAULT_BASE_URL
|
timeout
|
float | Timeout
|
Request timeout passed to HTTPX. |
DEFAULT_TIMEOUT
|
allow_mutations
|
bool
|
Enable persistent list/import/automation/webhook calls. |
False
|
allow_charges
|
bool
|
Enable invocations that explicitly request purchases. |
False
|
max_retries
|
int
|
Retry count for operations classified as safe. |
2
|
http_client
|
Client | None
|
Optional injected HTTPX client, primarily for custom transports and tests. The caller retains its lifecycle. |
None
|
accounts: AccountsResource
property
Return the lazily constructed account resource.
automations: AutomationsResource
property
Return the lazily constructed automation resource.
documents: DocumentsResource
property
Return the lazily constructed document resource.
imports: ImportsResource
property
Return the lazily constructed import resource.
integrations: IntegrationsResource
property
Return the lazily constructed integration resource.
lists: ListsResource
property
Return the lazily constructed list resource.
persons: PersonsResource
property
Return the lazily constructed person resource.
properties: PropertiesResource
property
Return the lazily constructed property resource.
suggestions: SuggestionsResource
property
Return the lazily constructed suggestion resource.
__init__(*, api_key: str | None = None, token_provider: Callable[[], str] | None = None, base_url: str = DEFAULT_BASE_URL, timeout: float | httpx.Timeout = DEFAULT_TIMEOUT, allow_mutations: bool = False, allow_charges: bool = False, max_retries: int = 2, http_client: httpx.Client | None = None) -> None
Initialize the facade and its shared transport.
__enter__() -> PropertyRadarClient
Return this client for context-managed use.
__exit__(*_: object) -> None
Close the internally owned HTTP connection pool.
__repr__() -> str
Return a credential-free representation.
close() -> None
Close the internally owned HTTP connection pool.