Skip to main content
GET
Rank the organizations with purchases like one 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. The same key works on POST /mcp.

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 match 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, and the match reads every segment and every price unless segment and price say otherwise. 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. A parcel with no radius takes its ZIP as the place.

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
limit
integer
default:100

Page size, 1-500 (default 100).

Required range: 1 <= x <= 500
cursor
string

Opaque cursor from page.next_cursor of the previous page. A change of query, sort, weights or data version invalidates it (400 invalid_cursor). Then restart from page 1.

Required string length: 1 - 4096

Response

The organizations with purchases like the subject, most first, then the newest, then the id, one keyset page. The rank rule: n_like counts the purchases in the place of the subject in the period, of the same segment when the subject has one, priced within 30 percent of its price when it has one.

The organizations with purchases like the subject, most first, then the newest, then the id, one keyset page. The rank rule: n_like counts the purchases in the place of the subject in the period, of the same segment when the subject has one, priced within 30 percent of its price when it has one.

data
object[]
required

The rows of this page.

page
object
required

Pagination: the page size, the rows returned and the cursor for the next page. Paged lists carry no total. The summary block does.

meta
object
required

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

subject
object
required

What the match compared the deals to: the place, the segment, the price band and the window.