logo
API docs by Redocly

Buyers Aware API (1.0.0)

Download OpenAPI specification:Download

Buyers Aware API

API for Buyers Aware to assess the flood and fire risk to individual residential structures in Hurricane Harvey-impacted areas in Texas.

External Partners

APIs to assess the flood and fire risk.

Neighborhood Profile

Returns geojson feature collection containing parcel geometries and risk details contained within a bounding box.
Note:Returns a large dataset. Use this endpoint with caution as the response may be large and could impact performance of UI.

Request Body schema: application/json
bbox
Array of numbers (LatLong) = 2 items [ items <float > = 2 items [ items <float > ] ]

Responses

Request samples

Content type
application/json
{
  • "bbox": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "features": [
    ]
}

Risks By Parcel

Returns risk details for a given parcel using parcel uid.

Request Body schema: application/json
id
number <float>

Parcel UID

Responses

Request samples

Content type
application/json
{
  • "id": 897057
}

Response samples

Content type
application/json
{
  • "address": "1850 W 43rd St, Houston, TX 77018",
  • "coordinates": [
    ],
  • "fire": {
    },
  • "flood": {
    },
  • "raw": {
    }
}

Risks By Coordinates

Returns risk details for a given coordinate.

Request Body schema: application/json
address
string

The address of the location

coordinates
Array of numbers <float> (LatLong) = 2 items [ items <float > ]

Array containing latitude and longitude coordinates

Responses

Request samples

Content type
application/json
{
  • "address": "1850 W 43rd St, Houston, TX 77018",
  • "coordinates": [
    ]
}

Response samples

Content type
application/json
{
  • "address": "1850 W 43rd St, Houston, TX 77018",
  • "coordinates": [
    ],
  • "fire": {
    },
  • "flood": {
    },
  • "raw": {
    }
}

Download Risk Report

Returns a formatted PDF with a detailed risk report for a give coordinate.

Request Body schema: application/json
address
string

The address of the location

coordinates
Array of numbers <float> (LatLong) = 2 items [ items <float > ]

Array containing latitude and longitude coordinates

Responses

Request samples

Content type
application/json
{
  • "address": "1850 W 43rd St, Houston, TX 77018",
  • "coordinates": [
    ]
}

Response samples

Content type
application/json
{
  • "msg": "No matching data for this coordinate",
  • "error": "Exception Message"
}