Properties

Bases: CollectionResourceClient

Access Spark RESO property data and replication helpers.

get_by_listing_key(listing_key, *, query=None, select=None, expand=None, timeout_seconds=None)

Retrieve a single property by ListingKey.

Parameters:

Name	Type	Description	Default
listing_key	str	Property listing key.	required
query	ODataQueryOptions | None	Optional base query configuration.	None
select	Sequence[str] | None	Optional field selection.	None
expand	Sequence[str | PropertyExpansion] | None	Optional property expansions.	None
timeout_seconds	float | None	Optional per-request timeout override.	None

Returns:

Type	Description
JsonPayload	The decoded property payload.

iter_listing_keys(*, top=1000, timeout_seconds=None)

Iterate over all currently accessible property listing keys.

Parameters:

Name	Type	Description	Default
top	int	Number of records to request per page.	1000
timeout_seconds	float | None	Optional per-request timeout override.	None

Yields:

Type	Description
str	Listing keys returned by Spark.

iter_recently_modified_properties(window, *, top=1000, select=None, order_by=None, expand=None, additional_filter=None, timeout_seconds=None)

Iterate over properties modified inside a replication window.

Parameters:

Name	Type	Description	Default
window	ReplicationWindow	Replication window used to build the timestamp filter.	required
top	int	Number of records to request per page.	1000
select	Sequence[str] | None	Optional field selection.	None
order_by	Sequence[str] | None	Optional sort expressions.	None
expand	Sequence[str | PropertyExpansion] | None	Optional property expansions.	None
additional_filter	str | None	Optional extra filter expression.	None
timeout_seconds	float | None	Optional per-request timeout override.	None

Yields:

Type	Description
ODataPage[dict[str, Any]]	Parsed OData pages.

iter_replication_pages(*, query=None, select=None, top=1000, order_by=None, filter_expression=None, expand=None, timeout_seconds=None)

Iterate over property pages for an initial replication sync.

Parameters:

Name	Type	Description	Default
query	ODataQueryOptions | None	Optional base query configuration.	None
select	Sequence[str] | None	Optional field selection.	None
top	int	Number of records to request per page.	1000
order_by	Sequence[str] | None	Optional sort expressions.	None
filter_expression	str | None	Optional extra filter expression.	None
expand	Sequence[str | PropertyExpansion] | None	Optional property expansions.	None
timeout_seconds	float | None	Optional per-request timeout override.	None

Yields:

Type	Description
ODataPage[dict[str, Any]]	Parsed OData pages.

list_by_address(*, unparsed_address, city, state_or_province=None, postal_code=None, query=None, select=None, top=None, skip=None, count=None, order_by=None, filter_expression=None, expand=None, timeout_seconds=None)

List properties by a strict address match.

Parameters:

Name	Type	Description	Default
unparsed_address	str	Exact UnparsedAddress value to match.	required
city	str	Exact City value to match.	required
state_or_province	str | None	Optional exact StateOrProvince value.	None
postal_code	str | None	Optional postal code or ZIP value. When provided, the first five characters are used in a startswith(PostalCode, ...) filter.	None
query	ODataQueryOptions | None	Optional base query configuration.	None
select	Sequence[str] | None	Optional field selection.	None
top	int | None	Optional page size.	None
skip	int | None	Optional offset.	None
count	bool | None	Optional flag for @odata.count.	None
order_by	Sequence[str] | None	Optional sort expressions.	None
filter_expression	str | None	Optional extra OData filter expression that will be combined with the strict address filter using and.	None
expand	Sequence[str | PropertyExpansion] | None	Optional property expansions.	None
timeout_seconds	float | None	Optional per-request timeout override.	None

Returns:

Type	Description
JsonPayload	The decoded collection payload.

Raises:

Type	Description
ValidationError	If a required address field is blank.

list_by_parcel(*, parcel_number, query=None, select=None, top=None, skip=None, count=None, order_by=None, filter_expression=None, expand=None, timeout_seconds=None)

List properties by exact ParcelNumber equality.

Parameters:

Name	Type	Description	Default
parcel_number	str	Exact ParcelNumber value to match.	required
query	ODataQueryOptions | None	Optional base query configuration.	None
select	Sequence[str] | None	Optional field selection.	None
top	int | None	Optional page size.	None
skip	int | None	Optional offset.	None
count	bool | None	Optional flag for @odata.count.	None
order_by	Sequence[str] | None	Optional sort expressions.	None
filter_expression	str | None	Optional extra OData filter expression that will be combined with the exact parcel filter using and.	None
expand	Sequence[str | PropertyExpansion] | None	Optional property expansions.	None
timeout_seconds	float | None	Optional per-request timeout override.	None

Returns:

Type	Description
JsonPayload	The decoded collection payload.

Raises:

Type	Description
ValidationError	If parcel_number is blank.

list_with_expansions(*, expansions, query=None, select=None, top=None, skip=None, count=None, order_by=None, filter_expression=None, timeout_seconds=None)

List properties and include related entities via $expand.

Parameters:

Name	Type	Description	Default
expansions	Sequence[str | PropertyExpansion]	Expansions to include.	required
query	ODataQueryOptions | None	Optional base query configuration.	None
select	Sequence[str] | None	Optional field selection.	None
top	int | None	Optional page size.	None
skip	int | None	Optional offset.	None
count	bool | None	Optional flag for @odata.count.	None
order_by	Sequence[str] | None	Optional sort expressions.	None
filter_expression	str | None	Optional OData filter expression.	None
timeout_seconds	float | None	Optional per-request timeout override.	None

Returns:

Type	Description
JsonPayload	The decoded collection payload.