Skip to main content
GET
List the H3 cells of the flagged purchases of a place
This route serves the lean set under /v3/deals/cells. See The lean dataset for the tier rules.

Authorizations

Authorization
string
header
required

API key from the developer console (starts with zpka_). Create one at https://developers.investorlift.com/get-a-key. The same key works on POST /mcp.

Query Parameters

lat
number

Point latitude, with lng: the centre of a radius. One of lat with lng, property_id, zip, or bbox is required.

Required range: -90 <= x <= 90
lng
number

Point longitude, with lat.

Required range: -180 <= x <= 180
radius_miles
number

The radius in miles around the point or the parcel, 0.25 to 20 (default 1).

Required range: 0.25 <= x <= 20
property_id
string

A parcel of the place index: the centre of a radius. The API resolves it to its point.

Pattern: ^[0-9a-f]{32}$
zip
string[]

A place as a list of 5-digit ZIPs (comma list or repeated key), at most 20.

Minimum array length: 1
Pattern: ^\d{5}$
bbox
string

Viewport as west,south,east,north (WGS84 degrees), the diagonal at most 40 mi.

from
string<date>

Keep deals dated on or after this date, YYYY-MM-DD.

to
string<date>

Keep deals dated on or before this date, YYYY-MM-DD.

price_min
integer

Keep deals priced at or above this, whole US dollars. An unpriced deal leaves.

Required range: 0 <= x <= 9007199254740991
price_max
integer

Keep deals priced at or below this, whole US dollars. An unpriced deal leaves.

Required range: 0 <= x <= 9007199254740991
segment
string[]

Keep these segments of the parcel (comma list or repeated key): SFR, CONDO_TH or OTHER.

Minimum array length: 1
Required string length: 1 - 20
doc_class
string[]

Keep these classes of the deed (comma list or repeated key): ECONOMIC, DISTRESSED or another class of the build.

Minimum array length: 1
Required string length: 1 - 20
tag
string[]

Keep deals whose buyer carries any of these tags (comma list or repeated key), for example investor, ibuyer, builder, bank.

Minimum array length: 1
Required string length: 1 - 40
buyer
enum<string>

Keep the deals of one buyer kind. Default: both.

Available options:
registry,
deed_name
repeat
enum<string>

True keeps the deals of a buyer that bought another parcel in the 12 months before, false the others.

Available options:
true,
false
resold
enum<string>

True keeps the deals whose parcel was sold again within 12 months, false the others.

Available options:
true,
false
clean
enum<string>

True keeps the clean purchases alone, the deeds with no hard reason.

Available options:
true,
false
auction
enum<string>

True keeps the purchases at a foreclosure auction: a trustee sale or a sheriff sale that passed the five tests of the build. False keeps the others.

Available options:
true,
false
reo
enum<string>

True keeps the purchases from a lender, a servicer or an agency after a take-back (REO). False keeps the others.

Available options:
true,
false
res
enum<string>
default:8

The H3 resolution of the cells: 7 (about 5 square km each) or 8 (about 0.7 square km). Default 8.

Available options:
7,
8

Response

The flagged purchases of the place as H3 cells.

The flagged purchases of the place as H3 cells.

data
object
required

The flagged purchases of the place as H3 cells with counts, for a map at a low zoom.

meta
object
required

Response metadata of the lean family: when the API produced it, and the publishes behind the rows.