Search

GET

https://api.hellodata.ai/property_report/search

GET

/property_report/search

1 import requests
2 
3 url = "https://api.hellodata.ai/property_report/search"
4 
5 headers = {"x-api-key": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

200Retrieved

1 {
2   "data": [
3     {
4       "id": 1.1,
5       "user_id": "string",
6       "name": "string",
7       "subject": {
8         "id": "52907745-7672-470e-a803-a2f8feb52944",
9         "building_name": "The Main Building",
10         "building_name_alias": [
11           "The Main Building",
12           "Main Building",
13           "Main"
14         ],
15         "street_address": "123 Main St",
16         "street_address_alias": [
17           "123 Main St",
18           "125, Main Street"
19         ],
20         "city": "San Francisco",
21         "state": "CA",
22         "zip_code": "94103",
23         "id_alias": [
24           "52907745-7672-470e-a803-a2f8feb52944"
25         ],
26         "lat": 40.7128,
27         "lon": -74.006,
28         "number_units": 314,
29         "year_built": 2020,
30         "number_stories": 60,
31         "created_on": "2023-11-01"
32       },
33       "tags": [
34         "string"
35       ]
36     }
37   ]
38 }

Search property reports in the organization, limited results for autocomplete.

Authentication

x-api-keystring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

qstringOptional

The search query string

limitdoubleOptional

The maximum number of results to return

Response

datalist of objects

metaany or null