Updating and Adding property records
Note:
before adding or updating a property record. It is recommended you confirm the formatting of the property address. If you are not validating address formats we recommend using our format address endpoint first.
The /property/update
route can be used interchangably between adding or updating a property record. If an address is found, it appends to that data.
Important
Roperty strongly reccomends utilizing Address Verfication /address/format
before using /property/update
to ensure the property address is in valid US format and help keep Roperty's data clean and accessible.
Paramaters​
house_number
- required​
address
- required​
city
- optional​
state
- required​
zipcode
- required​
latitude
- optional​
longitude
- optional​
classification
- required​
json_data
- required​
The primary storage of data for the property encoded as a JSON string.
Important
json_data
is really up to the contributor to store any type of information like sales price, history, tax records, etc... Be mindful of any sensitive information. We will also provide future guidelines on the information to be entered here.
history
- optional json_data
field​
When included in json_data
, history
property should be formatted as an array of associative arrays with date
, type
, and description
as follows:
"history" => [
[
"date" => '2022-04-21',
"type" => 'listed',
"description" => 'Property listed for $123,456'
],
[
"date" => '2020-08-05',
"type" => 'sold',
"description" => 'Property sold for $110,000'
],
]
Code Example​
- NodeJS
var axios = require('axios');
const BEARER_TOKEN = 'SET_ME';
var data = qs.stringify({
'house_number': '808',
'address': '808 awesome st',
'city': 'kansas city',
'state': 'mo',
'zipcode': '12345',
'latitude': '38.897957',
'lognitude': '-77.036560',
'json_data': '{"estimate_list_sell_price":220800,"last_list_or_sold_price":null,"last_sold_date":"2022-04-14","classification":"single_family","lot_size_ft":7540,"acreage":null,"building_size":1152,"beds":"3","baths":"2","year_built":"1988","heating":"gas","cooling":"central","type":"single family","garage_size":null,"roof":"composition","interior_features":null,"appliances":"dishwasher, refrigerator","parking":"garage - attached, off-street, on-street,","annual_tax":"$1,905","available":"off-market"",amenities_included":null,"basement":"finished",","neighborhood_median":185000,"open_houses":[],"history":[{"date":"2017-03-20","type":"sold","description":"sold --"}]}'
});
var config = {
method: 'put',
url: 'https://api.roperty.org/api/v1/property/update',
headers: {
'Authorization': 'Bearer ' + BEARER_TOKEN
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});