Comparative market analysis and appraisal artifacts — sales CMA, rental CMA and statement-of-information retrieval by appraisal share identifier (standard and extended), appraisal listing and insights, agent, office and logo imagery, and CMA event posting.
{"swagger":"2.0","info":{"description":"Pricefinder API provides access to property, sale and listing searches as well as suburb statistics and SSO to the Pricefinder website capabilities.","version":"1.13.1","title":"PriceFinder API v1.13.1","contact":{"name":"Pricefinder"},"license":{"name":"Terms and Conditions","url":"https://www.domain.com.au/group/api-terms-and-conditions/"}},"basePath":"/v1","tags":[{"name":"subscriptions"},{"name":"references"},{"name":"sso"},{"name":"properties"},{"name":"postcodes"},{"name":"images"},{"name":"suburbs"},{"name":"sales"},{"name":"rentals"},{"name":"listings"},{"name":"spatial"},{"name":"names"},{"name":"suggest"},{"name":"events"},{"name":"appraisals"},{"name":"stubs"},{"name":"streets"},{"name":"features"},{"name":"oauth2"}],"paths":{"/appraisals":{"get":{"tags":["appraisals"],"description":"","operationId":"appraisals","produces":["application/json"],"parameters":[{"name":"agentId","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"date_end","in":"query","description":"The default range value is 30 days. date format 'now', 'today-xxd' or 'year-month-day'","required":false,"type":"string","default":"now","format":"date-time","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"date_start","in":"query","description":"The default range value is 30 days. date format 'now', 'today-xxd' or 'year-month-day'","required":false,"type":"string","default":"today-30d","format":"date-time","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"limit","in":"query","description":"The limit must be greater than '0'. Otherwise, the default value '10' will be used","required":false,"type":"integer","default":100,"format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"page","in":"query","description":"The default value is '1', less than '1' will be ignored","required":false,"type":"integer","default":1,"format":"int32","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"propertyId","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"sort","in":"query","description":"The limit must be greater than '0'. Otherwise, the default value '10' will be used","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi","format":"-?\\w+","enum":["date","-date"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"type","in":"query","required":false,"type":"string","enum":["RENTAL_CMA","SALES_CMA","SOI"],"pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Appraisals"},"headers":{}}}}},"/appraisals/agent/image/{agentId}":{"get":{"tags":["appraisals"],"description":"","operationId":"agentImage","produces":["image/gif","image/jpeg","image/png"],"parameters":[{"name":"agentId","in":"path","required":true,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"height","in":"query","required":false,"type":"integer","format":"int32","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"width","in":"query","required":false,"type":"integer","format":"int32","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"default":{"description":"successful operation"}}}},"/appraisals/insights":{"get":{"tags":["appraisals"],"description":"","operationId":"getInsights","produces":["application/json"],"parameters":[{"name":"shareId","in":"query","description":"Provide multiple values in new lines (at least one required).","required":true,"type":"array","items":{"type":"string","format":"uuid"},"collectionFormat":"multi","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"agentId","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AppraisalInsightsView"},"headers":{}}}}},"/appraisals/logo/image/{userId}":{"get":{"tags":["appraisals"],"description":"","operationId":"userLogo","produces":["image/gif","image/jpeg","image/png"],"parameters":[{"name":"userId","in":"path","required":true,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"height","in":"query","required":false,"type":"integer","format":"int32","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"width","in":"query","required":false,"type":"integer","format":"int32","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"default":{"description":"successful operation"}}}},"/appraisals/office/image/{userId}":{"get":{"tags":["appraisals"],"description":"","operationId":"image","produces":["image/gif","image/jpeg","image/png"],"parameters":[{"name":"userId","in":"path","required":true,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"height","in":"query","required":false,"type":"integer","format":"int32","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"width","in":"query","required":false,"type":"integer","format":"int32","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"default":{"description":"successful operation"}}}},"/appraisals/rentalcma/{appraisalShareId}":{"get":{"tags":["appraisals"],"description":"","operationId":"rentalCma","produces":["application/json"],"parameters":[{"name":"appraisalShareId","in":"path","required":true,"type":"string","format":"uuid","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RentalCMACommon"},"headers":{}}}}},"/appraisals/rentalcma/{appraisalShareId}/extended":{"get":{"tags":["appraisals"],"description":"","operationId":"rentalCma","produces":["application/json"],"parameters":[{"name":"appraisalShareId","in":"path","required":true,"type":"string","format":"uuid","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RentalCMADetailed"},"headers":{}}}}},"/appraisals/salescma/{appraisalShareId}":{"get":{"tags":["appraisals"],"description":"","operationId":"salesCma","produces":["application/json"],"parameters":[{"name":"appraisalShareId","in":"path","required":true,"type":"string","format":"uuid","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SalesCMACommon"},"headers":{}}}}},"/appraisals/salescma/{appraisalShareId}/extended":{"get":{"tags":["appraisals"],"description":"","operationId":"salesCma","produces":["application/json"],"parameters":[{"name":"appraisalShareId","in":"path","required":true,"type":"string","format":"uuid","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SalesCMADetailed"},"headers":{}}}}},"/appraisals/soi/{appraisalShareId}":{"get":{"tags":["appraisals"],"description":"","operationId":"soi","produces":["application/json"],"parameters":[{"name":"appraisalShareId","in":"path","required":true,"type":"string","format":"uuid","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SOICommon"},"headers":{}}}}},"/appraisals/soi/{appraisalShareId}/extended":{"get":{"tags":["appraisals"],"description":"","operationId":"soi","produces":["application/json"],"parameters":[{"name":"appraisalShareId","in":"path","required":true,"type":"string","format":"uuid","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SOIDetailed"},"headers":{}}}}},"/events/cmaEvent/{cmaId}":{"post":{"tags":["events"],"description":"","operationId":"saveEvent","produces":["application/json"],"parameters":[{"name":"cmaId","in":"path","required":true,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EventParameters"}}],"responses":{"default":{"description":"successful operation"}}}},"/eventsubscriptions/currentuser":{"get":{"tags":["subscriptions"],"description":"","operationId":"userEventsSubscription","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PropertyEventSubscription"}},"headers":{}}}}},"/eventsubscriptions/properties":{"post":{"tags":["subscriptions"],"summary":"","description":"Subscribe to property event alerts (currently only available through email notifications) for those properties.<br><b>Note: This endpoint is NOT additive</b> <br>i.e. Multiple calls to this endpoint on the same property will keep overwriting the subscription with the eventTypes passed in the latest request.<br><b>Example :</b> <br> <ul><li>Subscribe to property X for 'ForSale' event</li><li>Subscribe to property X for 'ForRent' event</li><li>After these 2 calls X is only subscribed for 'ForRent'</li></ul>","operationId":"propertiesEventsSubscribe","consumes":["application/json"],"produces":["application/json","application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EventSubcriptionParameters"}},{"name":"propertyIds","in":"query","description":"The available eventTypes are <b>ForSale</b>, <b>ForRent</b> and <b>Sold</b>. They are case sensitive.","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"default":{"description":"successful operation"}}}},"/eventsubscriptions/property/{propertyId}":{"get":{"tags":["subscriptions"],"description":"","operationId":"propertyEventSubscription","produces":["application/json"],"parameters":[{"name":"propertyId","in":"path","required":true,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"The request has succeeded with event subscriptions available","schema":{"$ref":"#/definitions/PropertyEventSubscription"}},"204":{"description":"The request has succeeded but no events subscribed"},"404":{"description":"Property not found","schema":{"$ref":"#/definitions/Error"}}}},"post":{"tags":["subscriptions"],"summary":"","description":"Subscribe to property event alerts (currently only available through email notifications) for this property.<br><b>Note: This endpoint is NOT additive</b> <br>i.e. Multiple calls to this endpoint on the same property will keep overwriting the subscription with the eventTypes passed in the latest request.<br><b>Example :</b> <br> <ul><li>Subscribe to property X for 'ForSale' event</li><li>Subscribe to property X for 'ForRent' event</li><li>After these 2 calls X is only subscribed for 'ForRent'</li></ul>","operationId":"propertyEventsSubscribe","consumes":["application/json"],"produces":["application/json","application/json"],"parameters":[{"name":"propertyId","in":"path","required":true,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"in":"body","name":"body","description":"The available eventTypes are <b>ForSale</b>, <b>ForRent</b> and <b>Sold</b>. They are case sensitive.","required":false,"schema":{"$ref":"#/definitions/EventSubcriptionParameters"}}],"responses":{"default":{"description":"successful operation"}}},"delete":{"tags":["subscriptions"],"description":"","operationId":"propertyEventsUnSubscribe","produces":["application/json"],"parameters":[{"name":"propertyId","in":"path","required":true,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"default":{"description":"successful operation"}}}},"/features":{"get":{"tags":["features"],"description":"","operationId":"getFeatures","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserFeatures"},"headers":{}}}}},"/images/{id}":{"get":{"tags":["images"],"description":"You can access this method in an image tag by appending your access_token to the query string\n ie /v1/image/1?access_token=123abc","operationId":"image","produces":["image/gif","image/jpeg","image/png"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"height","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"width","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"default":{"description":"successful operation"}}}},"/listings/{listingId}":{"get":{"tags":["listings"],"description":"","operationId":"listing","produces":["application/json"],"parameters":[{"name":"listingId","in":"path","required":true,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtendedListing"},"headers":{}}}}},"/names":{"get":{"tags":["names"],"description":"Search for sales by owner and vendor name, as well as properties by owner name. The surname parameter can also be used to search for company/entity name.\n \n Required Parameters:\n <ul>\n <li>Each request requires a state or a suburb_id.</li>\n <li>Each request requires a surname/</li>\n <li>If a suburb id is not supplied, then a given name is required.</li>\n <ul>","operationId":"names","produces":["application/json"],"parameters":[{"name":"area_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"area_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"baths_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"baths_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"beds_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"beds_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"car_parks_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"car_parks_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"given_name","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"limit","in":"query","required":false,"type":"integer","default":100,"format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"match_method","in":"query","required":false,"type":"string","default":"startswith","enum":["startswith","exact"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_area","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_baths","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_beds","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_car_parks","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_area","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_baths","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_beds","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_car_parks","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"postcode","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"property_id","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"property_type","in":"query","required":false,"type":"string","enum":["house","unit","vacant","commercial","industrial","land","rural","retail","office","other"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"state","in":"query","required":false,"type":"string","enum":["QLD","NSW","VIC","WA","NT","ACT","SA","TAS"],"pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"suburb_id","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"surname","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NameSearchResults"},"headers":{}}}}},"/names/properties":{"get":{"tags":["names"],"description":"Search for properties by owner name. The surname parameter can also be used to search for company/entity name.\n \n Required Parameters:\n <ul>\n <li>Each request requires a state or a suburb_id.</li>\n <li>Each request requires a surname/</li>\n <li>If a suburb id is not supplied, then a given name is required.</li>\n <ul>","operationId":"namesProperties","produces":["application/json"],"parameters":[{"name":"area_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"area_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"baths_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"baths_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"beds_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"beds_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"car_parks_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"car_parks_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"given_name","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"limit","in":"query","required":false,"type":"integer","default":100,"format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"match_method","in":"query","required":false,"type":"string","default":"startswith","enum":["startswith","exact"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_area","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_baths","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_beds","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_car_parks","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_area","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_baths","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_beds","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_car_parks","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"postcode","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"property_id","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"property_type","in":"query","required":false,"type":"string","enum":["house","unit","vacant","commercial","industrial","land","rural","retail","office","other"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"state","in":"query","required":false,"type":"string","enum":["QLD","NSW","VIC","WA","NT","ACT","SA","TAS"],"pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"suburb_id","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"surname","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NameSearchResults"},"headers":{}}}}},"/names/sales":{"get":{"tags":["names"],"description":"Search for sales by owner and vendor name. The surname parameter can also be used to search for company/entity name.\n \n Required Parameters:\n <ul>\n <li>Each request requires a state or a suburb_id.</li>\n <li>Each request requires a surname/</li>\n <li>If a suburb id is not supplied, then a given name is required.</li>\n <ul>","operationId":"namesSales","produces":["application/json"],"parameters":[{"name":"area_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"area_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"baths_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"baths_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"beds_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"beds_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"car_parks_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"car_parks_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"given_name","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"limit","in":"query","required":false,"type":"integer","default":100,"format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"match_method","in":"query","required":false,"type":"string","default":"startswith","enum":["startswith","exact"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_area","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_baths","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_beds","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_car_parks","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_area","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_baths","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_beds","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_car_parks","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"postcode","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"property_id","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"property_type","in":"query","required":false,"type":"string","enum":["house","unit","vacant","commercial","industrial","land","rural","retail","office","other"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"state","in":"query","required":false,"type":"string","enum":["QLD","NSW","VIC","WA","NT","ACT","SA","TAS"],"pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"suburb_id","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"surname","in":"query","required":false,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NameSearchResults"},"headers":{}}}}},"/postcodes/{postcode}/listings":{"get":{"tags":["postcodes"],"description":"","operationId":"listings","produces":["application/json"],"parameters":[{"name":"postcode","in":"path","required":true,"type":"string","pds":{"hidden":false,"extra":false,"enumerate":false,"deprecated":false}},{"name":"area_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"area_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"baths_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"baths_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"beds_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"beds_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"car_parks_gt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"car_parks_lt","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"date_end","in":"query","required":false,"type":"string","default":"now","format":"date-time","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"date_start","in":"query","required":false,"type":"string","default":"today-90d","format":"date-time","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"historic","in":"query","required":false,"type":"boolean","default":false,"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"limit","in":"query","required":false,"type":"integer","default":100,"format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"matchlevel_max","in":"query","required":false,"type":"string","enum":["suburb","street","property"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"matchlevel_min","in":"query","required":false,"type":"string","enum":["suburb","street","property"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_area","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_baths","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_beds","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_car_parks","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"max_price","in":"query","required":false,"type":"number","format":"double","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_area","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_baths","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_beds","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_car_parks","in":"query","required":false,"type":"integer","format":"int64","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"min_price","in":"query","required":false,"type":"number","format":"double","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":false}},{"name":"price_gt","in":"query","required":false,"type":"number","format":"double","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"price_lt","in":"query","required":false,"type":"number","format":"double","pds":{"hidden":false,"extra":true,"enumerate":false,"deprecated":true}},{"name":"property_type","in":"query","required":false,"type":"string","enum":["house","unit","vacant","commercial","industrial","land","rural","retail","office","other"],"pds":{"hidden":false,"extra":true,"enumerate":false,"deprecate
# --- truncated at 32 KB (299 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pricefinder/refs/heads/main/openapi/pricefinder-api-swagger.json