Open Houses
Bases: CollectionResourceClient
Access Spark RESO open house records.
get_for_property(property_key, open_house_id, *, query=None, select=None, timeout_seconds=None)
Retrieve a specific open house record for a property.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
property_key
|
str
|
Listing key for the property. |
required |
open_house_id
|
str
|
Open house identifier. |
required |
query
|
ODataQueryOptions | None
|
Optional base query configuration. |
None
|
select
|
Sequence[str] | None
|
Optional field selection. |
None
|
timeout_seconds
|
float | None
|
Optional per-request timeout override. |
None
|
Returns:
| Type | Description |
|---|---|
JsonPayload
|
The decoded Spark payload. |
list_for_property(property_key, *, query=None, select=None, top=None, skip=None, count=None, order_by=None, filter_expression=None, timeout_seconds=None)
List all open houses for a specific property.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
property_key
|
str
|
Listing key for the property. |
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 |
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. |