Post Property

POST

https://api.hellodata.ai/property

POST

/property

1 import requests
2 
3 url = "https://api.hellodata.ai/property"
4 
5 payload = { "property": {
6         "street_address": "123 Main St",
7         "city": "New York",
8         "state": "NY",
9         "zip_code": "01234",
10         "lat": 40.7128,
11         "lon": -74.006,
12         "is_single_family": False,
13         "is_condo": False,
14         "is_apartment": True,
15         "number_units": 100,
16         "year_built": 2020,
17         "number_stories": 10,
18         "building_amenities": ["24_hour_maintenance"],
19         "unit_amenities": ["air_conditioning"],
20         "avg_quality": 0.8,
21         "units": [
22             {
23                 "bed": 2,
24                 "bath": 1,
25                 "name": "1A",
26                 "sqft": 1000
27             }
28         ]
29     } }
30 headers = {
31     "x-api-key": "<apiKey>",
32     "Content-Type": "application/json"
33 }
34 
35 response = requests.post(url, json=payload, headers=headers)
36 
37 print(response.json())

Try it

1 {
2   "id": "id"
3 }

Insert a new property in the database. For example a new development.

Headers

x-api-keystringRequired

Request

This endpoint expects an object.

propertyobjectRequired

PropertyReportPropertyInsert object is a very simplified version of the PropertyReportPropertyAttributes object used when creating a new Property object. It is used to validate the request body of a POST

Response

The property details.

idstring

Headers

Request

Response

Errors