Resources

Accounts

property_radar.resources.AccountsResource

Bases: BaseResource

Access PropertyRadar account resources.

members()

Return the members and invitations visible to the account.

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope containing account members.

status_labels(*, layout=None)

Return the account's configured property status labels.

Parameters:

Name	Type	Description	Default
layout	Literal['edit', 'menu', 'compact'] | None	Vendor response layout. When omitted, PropertyRadar uses its documented menu default.	None

Returns:

Type	Description
StatusLabelsResponse	The PropertyRadar response envelope containing status labels.

Documents

property_radar.resources.DocumentsResource

Bases: BaseResource

Access PropertyRadar recorded-document resources.

get(document_id, *, fields=None, radar_id=None, dry_run=None, purchase=False)

Return one recorded document in preview or purchased form.

Parameters:

Name	Type	Description	Default
document_id	str	PropertyRadar document identifier.	required
fields	Sequence[str] | None	Fields or fieldsets to return. Values are encoded as one comma-delimited Fields query parameter.	None
radar_id	str | None	Optional property identifier used to scope the document.	None
dry_run	bool | None	Optional vendor DryRun flag.	None
purchase	bool	Whether to purchase the returned record. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope for the document.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.

Properties

property_radar.resources.PropertiesResource

Bases: BaseResource

Access PropertyRadar property resources.

get(radar_id, *, fields=None, purchase=False)

Return one property in preview or purchased form.

Parameters:

Name	Type	Description	Default
radar_id	str	Unique PropertyRadar property identifier.	required
fields	Sequence[str] | None	Fields or fieldsets to return. Values are encoded as one comma-delimited Fields query parameter.	None
purchase	bool	Whether to purchase the returned record. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope for the property.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.

search(*, criteria, fields=None, limit=None, sort=None, start=None, purchase=False)

Search properties with a generic PropertyRadar criteria body.

Parameters:

Name	Type	Description	Default
criteria	Sequence[Criterion]	PropertyRadar criteria objects placed under the vendor Criteria request-body key.	required
fields	Sequence[str] | None	Fields or fieldsets to return. Values are encoded as one comma-delimited Fields query parameter.	None
limit	int | None	Maximum records to return for this page.	None
sort	str | None	Vendor sort expression.	None
start	int | None	Zero-based record offset.	None
purchase	bool	Whether to purchase the returned records. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope for the search page.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.

iter_search(*, criteria, fields=None, page_size=500, max_results=500, sort=None, start=0, purchase=False)

Yield property search records across deterministic offset pages.

Iteration stops at max_results by default, when PropertyRadar reports that all results have been read, or when a page proves the end of an uncounted result set. An error from any page is propagated instead of returning partial success silently.

Parameters:

Name	Type	Description	Default
criteria	Sequence[Criterion]	PropertyRadar criteria objects.	required
fields	Sequence[str] | None	Fields or fieldsets to return.	None
page_size	int	Positive page size. Defaults to the vendor's documented maximum page size.	500
max_results	int | None	Maximum records yielded across all pages. Defaults to one maximum-size page. Pass None only for an explicitly unbounded non-purchased iteration.	500
sort	str | None	Vendor sort expression.	None
start	int	Non-negative initial record offset.	0
purchase	bool	Whether every fetched page should be purchased. The client must also be configured with allow_charges=True.	False

Yields:

Type	Description
JSONDict	Property dictionaries from each response page.

Raises:

Type	Description
ValueError	If pagination bounds are invalid or a purchased iteration is explicitly unbounded.
InvalidResponseError	If pagination metadata or records have an unexpected shape.
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.
PropertyRadarError	If any requested page fails.

persons(radar_id, *, fields=None, purchase=False)

Return people associated with a property.

Parameters:

Name	Type	Description	Default
radar_id	str	Unique PropertyRadar property identifier.	required
fields	Sequence[str] | None	Fields or fieldsets to return as comma-delimited Fields.	None
purchase	bool	Whether to purchase the returned records. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope containing people.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.

evictions(radar_id, *, fields=None, limit=None, start=None, purchase=False)

Return eviction filings associated with a property.

Parameters:

Name	Type	Description	Default
radar_id	str	Unique PropertyRadar property identifier.	required
fields	Sequence[str] | None	Fields to return as comma-delimited Fields.	None
limit	int | None	Maximum eviction records to return.	None
start	int | None	Zero-based record offset.	None
purchase	bool	Whether to purchase the returned records. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope containing eviction filings.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.

comparable_sales(radar_id, *, fields=None, limit=None, p_type=None, beds=None, baths=None, units=None, sq_ft=None, lot_size=None, year_built=None, transfer_type=None, purchase=False)

Return comparable property sales.

Parameters:

Name	Type	Description	Default
radar_id	str	Unique PropertyRadar property identifier.	required
fields	Sequence[str] | None	Fields to return as comma-delimited Fields.	None
limit	int | None	Maximum comparable records to return.	None
p_type	Sequence[str] | None	Property types encoded as comma-delimited PType.	None
beds	int | None	Bedroom comparison filter.	None
baths	str | None	Vendor bathroom comparison expression.	None
units	int | None	Unit-count comparison filter.	None
sq_ft	int | None	Square-footage comparison filter.	None
lot_size	int | None	Lot-size comparison filter.	None
year_built	str | None	Vendor year-built comparison expression.	None
transfer_type	Sequence[str] | None	Sale transfer types encoded as comma-delimited TransferType.	None
purchase	bool	Whether to purchase the returned records. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope containing comparable sales.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.

comparable_listings(radar_id, *, fields=None, limit=None, p_type=None, beds=None, baths=None, units=None, sq_ft=None, lot_size=None, year_built=None, listing_type=None, purchase=False)

Return comparable properties currently listed for sale.

Parameters:

Name	Type	Description	Default
radar_id	str	Unique PropertyRadar property identifier.	required
fields	Sequence[str] | None	Fields to return as comma-delimited Fields.	None
limit	int | None	Maximum comparable records to return.	None
p_type	Sequence[str] | None	Property types encoded as comma-delimited PType.	None
beds	int | None	Bedroom comparison filter.	None
baths	str | None	Vendor bathroom comparison expression.	None
units	int | None	Unit-count comparison filter.	None
sq_ft	int | None	Square-footage comparison filter.	None
lot_size	int | None	Lot-size comparison filter.	None
year_built	str | None	Vendor year-built comparison expression.	None
listing_type	Sequence[str] | None	Listing types encoded as comma-delimited ListingType.	None
purchase	bool	Whether to purchase the returned records. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope containing comparable
ResponseEnvelope	listings.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.

parcels(radar_id, *, purchase=False)

Return parcel records associated with a property.

Parameters:

Name	Type	Description	Default
radar_id	str	Unique PropertyRadar property identifier.	required
purchase	bool	Whether to purchase the returned records. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope containing parcels.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.

transactions(radar_id, *, fields=None, filter_by=None, purchase=False)

Return recorded transactions associated with a property.

Parameters:

Name	Type	Description	Default
radar_id	str	Unique PropertyRadar property identifier.	required
fields	Sequence[str] | None	Fields to return as comma-delimited Fields.	None
filter_by	Literal['CurrentOwner', 'All'] | None	Limit results to the current owner or return all transactions. When omitted, PropertyRadar uses All.	None
purchase	bool	Whether to purchase the returned records. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope containing transactions.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.

transaction_history(radar_id, *, filter_by=None, purchase=False, property_persons=None)

Return strictly parsed transaction history without changing raw calls.

The method requests the exact public transaction field catalog and supplies the known purchase flag to the billing parser. For structured current-owner evidence, first call :meth:persons with PROPERTY_PERSON_IDENTITY_FIELDS and pass that raw envelope as property_persons. The parser verifies every returned RadarID and keeps current owners separate from unlinked transaction parties.

Parameters:

Name	Type	Description	Default
radar_id	str	Unique PropertyRadar property identifier.	required
filter_by	Literal['CurrentOwner', 'All'] | None	Limit results to the current owner or return all transactions. When omitted, PropertyRadar uses All.	None
purchase	bool	Whether to purchase the transaction records. The client must also be configured with allow_charges=True.	False
property_persons	Mapping[str, object] | None	Optional raw dedicated property-person response for the same radar_id.	None

Returns:

Type	Description
TransactionHistory	Immutable typed transaction history and billing evidence.

Raises:

Type	Description
TypeError	If purchase is not exactly a boolean. This is rejected before any network request.
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.
InvalidResponseError	If the provider response or optional composition violates the bound public contract.

buyer_transfer_match(*, criteria, purchase=False)

Return one typed Buyer-criterion linkage to an exact property.

The method builds the bounded public criteria, requests only the immutable property identity/location field catalog, limits the search to one exact RadarID, and strictly parses the response. A returned linkage means that PropertyRadar matched the documented Buyer Name (Grantee) criterion; it does not invent exact-name semantics or parse scalar transaction-party displays.

Parameters:

Name	Type	Description	Default
criteria	BuyerTransferMatchCriteria	Exact buyer, property, geography, and transfer windows.	required
purchase	bool	Whether to purchase the returned property record. The client must also be configured with allow_charges=True.	False

Returns:

Type	Description
BuyerTransferMatchResult	Immutable linkage, property location, and billing evidence.

Raises:

Type	Description
TypeError	If purchase is not exactly a boolean. This is rejected before any network request.
ChargeNotAllowedError	If purchase is true without the client-level charge opt-in.
InvalidResponseError	If the response violates the public contract.

Persons

property_radar.resources.PersonsResource

Bases: BaseResource

Access PropertyRadar person resources.

bankruptcies(person_key, *, fields=None, limit=100, start=0, purchase=False)

Return bankruptcy records for a person.

Parameters:

Name	Type	Description	Default
person_key	str	Vendor identifier for the person.	required
fields	Sequence[str] | None	Fields to include or suppress, encoded as one comma-delimited query value.	None
limit	int	Maximum number of records to return.	100
start	int	Zero-based result offset.	0
purchase	bool	Whether to purchase returned records. The default is a non-billable preview.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ChargeNotAllowedError	If a purchase is requested without enabling charges on the client.

divorces(person_key, *, fields=None, limit=100, start=0, purchase=False)

Return divorce records for a person.

Parameters:

Name	Type	Description	Default
person_key	str	Vendor identifier for the person.	required
fields	Sequence[str] | None	Fields to include or suppress, encoded as one comma-delimited query value.	None
limit	int	Maximum number of records to return.	100
start	int	Zero-based result offset.	0
purchase	bool	Whether to purchase returned records. The default is a non-billable preview.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ChargeNotAllowedError	If a purchase is requested without enabling charges on the client.

liens(person_key, *, fields=None, limit=500, purchase=False)

Return lien records for a person.

Parameters:

Name	Type	Description	Default
person_key	str	Vendor identifier for the person.	required
fields	Sequence[str] | None	Fields to include or suppress, encoded as one comma-delimited query value.	None
limit	int	Maximum number of records to return.	500
purchase	bool	Whether to purchase returned records. The default is a non-billable preview.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ChargeNotAllowedError	If a purchase is requested without enabling charges on the client.

probates(person_key, *, fields=None, limit=100, start=0, purchase=False)

Return probate records for a person.

Parameters:

Name	Type	Description	Default
person_key	str	Vendor identifier for the person.	required
fields	Sequence[str] | None	Fields to include or suppress, encoded as one comma-delimited query value.	None
limit	int	Maximum number of records to return.	100
start	int	Zero-based result offset.	0
purchase	bool	Whether to purchase returned records. The default is a non-billable preview.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ChargeNotAllowedError	If a purchase is requested without enabling charges on the client.

relatives(person_key, *, purchase=False)

Return relatives for a person.

Parameters:

Name	Type	Description	Default
person_key	str	Vendor identifier for the person.	required
purchase	bool	Whether to purchase returned records. The default is a non-billable preview.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ChargeNotAllowedError	If a purchase is requested without enabling charges on the client.

phone(person_key, *, purchase=False)

Preview or purchase a phone lookup for a person.

Parameters:

Name	Type	Description	Default
person_key	str	Vendor identifier for the person.	required
purchase	bool	Whether to purchase the lookup. The default is a non-billable preview.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ChargeNotAllowedError	If a purchase is requested without enabling charges on the client.

email(person_key, *, purchase=False)

Preview or purchase an email lookup for a person.

Parameters:

Name	Type	Description	Default
person_key	str	Vendor identifier for the person.	required
purchase	bool	Whether to purchase the lookup. The default is a non-billable preview.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ChargeNotAllowedError	If a purchase is requested without enabling charges on the client.

Suggestions

property_radar.resources.SuggestionsResource

Bases: BaseResource

Access PropertyRadar suggestion resources.

site_addresses(suggestion_input=None, *, criteria=(), limit=255, start=0)

Return site-address suggestions.

Parameters:

Name	Type	Description	Default
suggestion_input	str | None	Partial address text used to filter suggestions.	None
criteria	Sequence[Criterion]	Optional PropertyRadar criteria restricting suggestions.	()
limit	int	Maximum number of suggestions to return.	255
start	int	Zero-based result offset.	0

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

counties(suggestion_input=None, *, criteria=())

Return county and FIPS suggestions.

Parameters:

Name	Type	Description	Default
suggestion_input	str | None	Partial county text used to filter suggestions.	None
criteria	Sequence[Criterion]	Optional PropertyRadar criteria restricting suggestions.	()

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Lists

property_radar.resources.ListsResource

Bases: BaseResource

Access PropertyRadar saved-list resources.

all(*, fields=None, list_type=None, is_monitored=None, import_type=None, group_name=None, display_order=None, limit=1000, sort='TotalCount', direction='desc')

Return the account's saved lists.

Parameters:

Name	Type	Description	Default
fields	Sequence[str] | None	Vendor fields to include or suppress.	None
list_type	ListType | None	Dynamic, static, or import list filter.	None
is_monitored	bool | None	Filter by monitoring state.	None
import_type	ImportType | None	Property- or person-focused import filter.	None
group_name	str | None	List-group name filter.	None
display_order	int | None	Display-order filter.	None
limit	int	Maximum number of lists to return.	1000
sort	str	Vendor field used to sort results.	'TotalCount'
direction	SortDirection	Ascending or descending sort direction.	'desc'

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

create(*, list_name, criteria=None, list_type=None, is_monitored=None, import_source=None, import_match_threshold=None, import_type=None, import_contact_options=None, group_name=None)

Create a saved list.

Parameters:

Name	Type	Description	Default
list_name	str	Display name for the list.	required
criteria	Sequence[Criterion] | None	Criteria used to populate a dynamic or static list.	None
list_type	ListType | None	Dynamic, static, or import list type.	None
is_monitored	bool | None	Whether monitoring and automations are enabled.	None
import_source	ImportSource | None	Source used to populate an import list.	None
import_match_threshold	int | None	Match threshold for an import list.	None
import_type	ImportType | None	Property- or person-focused import type.	None
import_contact_options	Mapping[str, bool] | None	Vendor import-contact option mapping.	None
group_name	str | None	List-group name.	None

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
MutationNotAllowedError	If persistent mutations are disabled.

get(list_id)

Return one saved list.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar list identifier.	required

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

update(list_id, *, list_name=None, is_monitored=None, import_match_threshold=None, import_type=None, import_contact_options=None, display_order=None)

Update the supplied fields on a saved list.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar list identifier.	required
list_name	str | None	Replacement display name.	None
is_monitored	bool | None	Replacement monitoring state.	None
import_match_threshold	int | None	Replacement import match threshold.	None
import_type	ImportType | None	Replacement property- or person-focused import type.	None
import_contact_options	Mapping[str, bool] | None	Replacement import-contact option mapping.	None
display_order	int | None	Replacement display order.	None

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
MutationNotAllowedError	If persistent mutations are disabled.

delete(list_id)

Delete a saved list.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar list identifier.	required

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
MutationNotAllowedError	If persistent mutations are disabled.

items(list_id, *, start=0, limit=1000, interest_levels=None, status_level=None, has_photos=None, has_notes=None, has_analysis=None, has_docs=None, property_types=None, last_transfer_record_dates=None, added_since=None, most_recent_calls=None, most_recent_texts=None, most_recent_voicemails=None, most_recent_direct_mail=None, most_recent_emails=None)

Return properties saved to a list.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar list identifier.	required
start	int	Zero-based result offset.	0
limit	int	Maximum number of items to return.	1000
interest_levels	Sequence[int] | None	Interest levels, serialized comma-delimited.	None
status_level	int | None	Account-specific saved status level.	None
has_photos	bool | None	Filter by saved photos.	None
has_notes	bool | None	Filter by saved notes.	None
has_analysis	bool | None	Filter by saved analysis.	None
has_docs	bool | None	Filter by saved documents.	None
property_types	Sequence[str] | None	Property types, serialized comma-delimited.	None
last_transfer_record_dates	Sequence[str] | None	Relative-date filters.	None
added_since	str | None	Date or timestamp after which the item was added.	None
most_recent_calls	Sequence[str] | None	Most-recent-call relative-date filters.	None
most_recent_texts	Sequence[str] | None	Most-recent-text relative-date filters.	None
most_recent_voicemails	Sequence[str] | None	Most-recent-voicemail relative-date filters.	None
most_recent_direct_mail	Sequence[str] | None	Most-recent-mail relative-date filters.	None
most_recent_emails	Sequence[str] | None	Most-recent-email relative-date filters.	None

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Note

Relative-date and activity arrays use repeated query keys, matching the official OpenAPI default. InterestLevel and PType are comma-delimited because the contract marks them explode: false.

add_items(list_id, *, criteria)

Add properties matching criteria to a saved list.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar list identifier.	required
criteria	Sequence[Criterion]	Criteria selecting the properties to add.	required

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
MutationNotAllowedError	If persistent mutations are disabled.

delete_item(list_id, radar_id)

Delete one property from a saved list.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar list identifier.	required
radar_id	str	Unique PropertyRadar property identifier.	required

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
MutationNotAllowedError	If persistent mutations are disabled.

Imports

property_radar.resources.ImportsResource

Bases: BaseResource

Access PropertyRadar list-import resources.

items(list_id, *, fields=None, limit=100, sort='ListImportItemID', direction='asc', start=0, match_score=None, property_status=None, person_status=None)

Return imported items and their match status.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar import-list identifier.	required
fields	Sequence[str] | None	Vendor fields to include or suppress.	None
limit	int	Maximum number of items to return.	100
sort	str	Vendor field used to sort results.	'ListImportItemID'
direction	SortDirection	Ascending or descending sort direction.	'asc'
start	int	Zero-based result offset.	0
match_score	int | None	Match-score filter.	None
property_status	PropertyStatus | None	Property matching-status filter.	None
person_status	PersonStatus | None	Person matching-status filter.	None

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

match(list_id, import_items, *, fields=None, purchase=False)

Add and match imported records against PropertyRadar data.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar import-list identifier.	required
import_items	Sequence[ImportItem]	Synthetic or caller-owned records to import and match.	required
fields	Sequence[str] | None	Vendor fields to include or suppress.	None
purchase	bool	Whether to purchase the matched records. Defaults to a non-billable cost preview.	False

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ChargeNotAllowedError	If purchase is true but charges are disabled.
MutationNotAllowedError	If persistent mutations are disabled.

update_match(list_id, list_import_item_id, *, person_key=None, radar_id=None)

Update the selected person or property for an imported item.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar import-list identifier.	required
list_import_item_id	int	Unique imported-item identifier.	required
person_key	str | None	Replacement PropertyRadar person key.	None
radar_id	str | None	Replacement PropertyRadar property identifier.	None

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
MutationNotAllowedError	If persistent mutations are disabled.

delete_match(list_id, list_import_item_id)

Delete one imported match from a list.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar import-list identifier.	required
list_import_item_id	int	Unique imported-item identifier.	required

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
MutationNotAllowedError	If persistent mutations are disabled.

Automations

property_radar.resources.AutomationsResource

Bases: BaseResource

Access PropertyRadar saved-list automations.

get(list_id)

Return the automation configuration for a list.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar list identifier.	required

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

update(list_id, *, confirm_full_replacement=False, is_enabled=None, triggers=None, daily_email_member_ids=None, immediate_email_member_ids=None, export_to_webhook_ids=None, direct_mail_order_id=None, email_marketing_order_id=None, mobile_notification_member_ids=None, set_interest_level=None, set_status_level=None, add_to_lists=None, remove_from_lists=None, purchase_phone=None, purchase_email=None)

Fully replace the automation configuration for a list.

PropertyRadar treats this PUT as a full replacement, not a partial update. Fetch the current configuration, modify it, and pass every value that must be retained. Omitted arguments are absent from the replacement body and may therefore clear existing vendor configuration.

Parameters:

Name	Type	Description	Default
list_id	int	Unique PropertyRadar list identifier.	required
confirm_full_replacement	bool	Must be exactly true to acknowledge that omitted settings can be cleared.	False
is_enabled	bool | None	Whether the replacement automation is enabled.	None
triggers	AutomationTriggers | None	Events that trigger the replacement automation.	None
daily_email_member_ids	str | None	Comma-delimited daily-email member IDs.	None
immediate_email_member_ids	str | None	Comma-delimited immediate-email IDs.	None
export_to_webhook_ids	str | None	Comma-delimited webhook IDs.	None
direct_mail_order_id	str | None	Direct-mail order identifier.	None
email_marketing_order_id	str | None	Email-marketing order identifier.	None
mobile_notification_member_ids	str | None	Comma-delimited mobile member IDs.	None
set_interest_level	int | None	Interest level assigned by the automation.	None
set_status_level	int | None	Status level assigned by the automation.	None
add_to_lists	str | None	Comma-delimited destination list IDs.	None
remove_from_lists	str | None	Comma-delimited list IDs to remove from.	None
purchase_phone	bool | None	Whether triggered records purchase phone data.	None
purchase_email	bool | None	Whether triggered records purchase email data.	None

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ChargeNotAllowedError	If a purchase flag is true but charges are disabled.
ConfigurationError	If full replacement is not acknowledged or no replacement fields are supplied.
MutationNotAllowedError	If persistent mutations are disabled.

Integrations

property_radar.resources.IntegrationsResource

Bases: BaseResource

Access PropertyRadar integration resources.

webhooks(*, fields=None, limit=100, sort='WebhookID', direction='asc', start=0)

Return active webhook integrations.

Parameters:

Name	Type	Description	Default
fields	Sequence[str] | None	Vendor fields to include or suppress.	None
limit	int	Maximum number of webhooks to return.	100
sort	str	Vendor field used to sort results.	'WebhookID'
direction	SortDirection	Ascending or descending sort direction.	'asc'
start	int	Zero-based result offset.	0

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

create_webhook(*, hook_url, webhook_name, secret=None, list_ids=None)

Register a webhook integration.

Parameters:

Name	Type	Description	Default
hook_url	str	HTTPS destination called by PropertyRadar.	required
webhook_name	str	Display name for the webhook.	required
secret	str | None	Optional bearer secret sent only in the request body.	None
list_ids	Sequence[int] | None	Lists for which automations should be created.	None

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
ConfigurationError	If hook_url is not an absolute HTTPS URL without embedded credentials.
MutationNotAllowedError	If persistent mutations are disabled.

Note

The secret is passed directly to the guarded transport and is never retained on this resource or included in its representation.

delete_webhook(webhook_id)

Delete a webhook integration.

Parameters:

Name	Type	Description	Default
webhook_id	int	Unique PropertyRadar webhook identifier.	required

Returns:

Type	Description
ResponseEnvelope	The PropertyRadar response envelope.

Raises:

Type	Description
MutationNotAllowedError	If persistent mutations are disabled.