{ "opencollection": "1.0.0", "info": { "name": "PriceFinder API v1.13.1", "version": "1.13.1" }, "items": [ { "info": { "name": "appraisals", "type": "folder" }, "items": [ { "info": { "name": "appraisals", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals", "params": [ { "name": "agentId", "value": "", "type": "query" }, { "name": "date_end", "value": "", "type": "query", "description": "The default range value is 30 days. date format 'now', 'today-xxd' or 'year-month-day'" }, { "name": "date_start", "value": "", "type": "query", "description": "The default range value is 30 days. date format 'now', 'today-xxd' or 'year-month-day'" }, { "name": "limit", "value": "", "type": "query", "description": "The limit must be greater than '0'. Otherwise, the default value '10' will be used" }, { "name": "page", "value": "", "type": "query", "description": "The default value is '1', less than '1' will be ignored" }, { "name": "propertyId", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "The limit must be greater than '0'. Otherwise, the default value '10' will be used" }, { "name": "type", "value": "", "type": "query" } ] } }, { "info": { "name": "agentImage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/agent/image/:agentId", "params": [ { "name": "agentId", "value": "", "type": "path" }, { "name": "height", "value": "", "type": "query" }, { "name": "width", "value": "", "type": "query" } ] } }, { "info": { "name": "getInsights", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/insights", "params": [ { "name": "shareId", "value": "", "type": "query", "description": "Provide multiple values in new lines (at least one required)." }, { "name": "agentId", "value": "", "type": "query" } ] } }, { "info": { "name": "userLogo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/logo/image/:userId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "height", "value": "", "type": "query" }, { "name": "width", "value": "", "type": "query" } ] } }, { "info": { "name": "image", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/office/image/:userId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "height", "value": "", "type": "query" }, { "name": "width", "value": "", "type": "query" } ] } }, { "info": { "name": "rentalCma", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/rentalcma/:appraisalShareId", "params": [ { "name": "appraisalShareId", "value": "", "type": "path" } ] } }, { "info": { "name": "rentalCma", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/rentalcma/:appraisalShareId/extended", "params": [ { "name": "appraisalShareId", "value": "", "type": "path" } ] } }, { "info": { "name": "salesCma", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/salescma/:appraisalShareId", "params": [ { "name": "appraisalShareId", "value": "", "type": "path" } ] } }, { "info": { "name": "salesCma", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/salescma/:appraisalShareId/extended", "params": [ { "name": "appraisalShareId", "value": "", "type": "path" } ] } }, { "info": { "name": "soi", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/soi/:appraisalShareId", "params": [ { "name": "appraisalShareId", "value": "", "type": "path" } ] } }, { "info": { "name": "soi", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/appraisals/soi/:appraisalShareId/extended", "params": [ { "name": "appraisalShareId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "events", "type": "folder" }, "items": [ { "info": { "name": "saveEvent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/events/cmaEvent/:cmaId", "params": [ { "name": "cmaId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "subscriptions", "type": "folder" }, "items": [ { "info": { "name": "userEventsSubscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/eventsubscriptions/currentuser" } }, { "info": { "name": "propertiesEventsSubscribe", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/eventsubscriptions/properties", "params": [ { "name": "propertyIds", "value": "", "type": "query", "description": "The available eventTypes are ForSale, ForRent and Sold. They are case sensitive." } ] }, "docs": "Subscribe to property event alerts (currently only available through email notifications) for those properties.
Note: This endpoint is NOT additive
i.e. Multiple calls to this endpoint on the same property will keep overwriting the subscription with the eventTypes passed in the latest request.
Example :