- Previous: Arrange Viewing
- Up: Introduction
- Next: Local Info Graphs
Arrange Appraisals
Description: Allows developers to build their own Appraisal engine like the one on Zoopla by making three separate API calls to find a property and contact the agent for a valuation.
For testing purposes, we have blacklisted zoopla_developer@mashery.com
Input parameters (step 1)
1st Access URI: https://api.zoopla.co.uk/api/v1/postcode_properties
The 1st method uses the input parameter to detail which properties are within the postcode sector of interest.
Key name | Description |
---|---|
postcode | The name of the post town that the property is located within. |
Generated output
Key name | Description |
---|---|
property_id | The Zoopla unique property identifier for this property. |
full_address | The full address of the property, including door numbers. |
result_count | Total number of results in this data set. |
Input parameters (step 2)
2nd Access URI: https://api.zoopla.co.uk/api/v1/property_appraisal_branches
The 2nd method uses the property_id parameter to detail which Agents are within reasonable distance to provide an appraisal for the property.
Key name | Description |
---|---|
property_id | The Zoopla unique property identifier for this property. Taken from 1st call |
Generated output
Key name | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
property_id | The Zoopla unique property identifier for this property. |
||||||||||||
full_address | Each listing in the result set is contained with an agent element with the following key/value pairs:
|
||||||||||||
result_count | Total number of results in this data set. |
Input parameters (step 3)
3rd Access URI: https://api.zoopla.co.uk/api/v1/arrange_appraisal
The 3rd method requires the below parameters to be passed for a successful appraisal request to an Agent.
Key name | Description |
---|---|
branch_id | A specific branch_id to request the appraisal service(s) from. Taken from 2nd call. |
property_id | The Zoopla unique property identifier for this property. Taken from 1st call. |
name | Name of the customer. |
E-mail address which the agent can contact the customer on. | |
phone | Phone number on which the agent can contact the customer. |
phone_type | The type of phone number provided, defaults to "mobile":
|
best_time_to_call | The best time for the agent to call the phone number provided, defaults to "anytime":
|
message (optional) | A free-form message to be sent to the agent along with the other details, defaults to a blank message. |
type_of_enquiry | The nature of the appraisal enquiry can be one of the following
|
session_id (optional) | A session identifier provided by the get_session_id API method call, although this is optional. |
Generated output
The following output parameters are generated.
Key name | Description |
---|---|
success | Either "1" or "0" to indicate whether the request was successful. If a value of "0" is returned there will also be an "error" parameter generated. |
error | The error which cause the request to be unsuccessful, which can be one of the following values:
|
- Previous: Arrange Viewing
- Up: Introduction
- Next: Local Info Graphs