Skip to main content
GET
Get how one organization of the lean set fits one subject parcel

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The organization id, as a search hit or a deal row carries it.

Query Parameters

property_id
string

The subject parcel of the place index, 32 hex characters: its segment, its last price and its point. Alone, the place of the fit is its ZIP. With radius_miles, the place is the radius around its point.

Pattern: ^[0-9a-f]{32}$
lat
number

Point latitude, with lng: the other subject. The place is the radius around it. One of property_id, or lat with lng, 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. With a point the default is 2.

Required range: 0.25 <= x <= 20
period
enum<string>
default:36m

The window of the match before the data end of the state: 12m, 24m or 36m (default 36m).

Available options:
12m,
24m,
36m
price
integer

The price the band is built on, whole US dollars, in place of the last price of the parcel.

Required range: 0 <= x <= 9007199254740991
segment
enum<string>

The segment the match reads, in place of the segment of the last deed of the parcel: SFR, CONDO_TH or OTHER.

Available options:
SFR,
CONDO_TH,
OTHER

Response

The fit of the organization for the subject.

The fit of the organization for the subject.

data
object
required

How one organization fits one subject: its match row and its rank, or null, and whether it bought in the place.

meta
object
required

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