Saved Searches
A Saved Search persists a Property Search query server-side so you can re-run it and receive only what changed. This is how you keep a synced copy of a list without diffing full result sets yourself.
Retrieving, listing, and deleting saved searches use separate endpoints, and tracking a bare list of property IDs works differently again — see Track a list of IDs.
POST/v1/PropertyPortfolio/SavedSearch/Create
Create a saved search
Request attributes
- Name
search_name- Type
- string
- Description
A name for the saved search.
- Name
search_query- Type
- string
- Description
The Property Search query to persist.
- Name
list_size- Type
- integer
- Description
Expected size of the resulting list.
- Name
meta_data- Type
- object
- Description
Arbitrary metadata to store alongside the search, for your own filtering later.
Request
POST
/v1/PropertyPortfolio/SavedSearch/Createcurl -X POST https://api.realestateapi.com/v1/PropertyPortfolio/SavedSearch/Create \
-H "x-api-key: $REALESTATEAPI_KEY" \
-H "Content-Type: application/json" \
-d '{"search_name": "Austin absentee owners", "search_query": "{\"city\":\"Austin\",\"state\":\"TX\"}"}'
The full response schema for this endpoint — every field and enum — lives in the canonical reference. That content has not been ported to this site yet.