Skip to main content
GET
List the organizations with purchases in one ZIP
This route serves the lean set under /v3/places/{zip}/buyers. 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.

Path Parameters

zip
string
required

The 5-digit ZIP of the place.

Pattern: ^\d{5}$

Query Parameters

from
string<date>

Count the deals dated on or after this date alone, YYYY-MM-DD. Default: every deal.

buyer
enum<string>

Keep one buyer kind. Default: both.

Available options:
registry,
deed_name
auction
enum<string>

True keeps the organizations active at auction, with an auction purchase in the 730 days before the data end of the state. False keeps the others.

Available options:
true,
false
reo
enum<string>

True keeps the organizations active in REO, with an REO purchase in the 730 days before the data end of the state. False keeps the others.

Available options:
true,
false
active
enum<string>

true keeps the organizations with a purchase in the 365 days before the data end of the state, the is_active of the profile. false keeps the others, an organization with no profile included. Default: both.

Available options:
true,
false
min_deals
integer

Keep the organizations with at least this many deals in the place, in the window. Default: 1.

Required range: 1 <= x <= 9007199254740991
sort
enum<string>

The row order. The sort deals puts the most deals in the place first, then the newest deed. The sort last_deal puts the newest deed in the place first, an undated organization last, then the most deals. The sort total_price puts the largest sum of prices in the place first, an unpriced organization last, then the most deals. The default is deals. Every sort breaks a tie on the organization id.

Available options:
deals,
last_deal,
total_price
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 deals in the place in the order of the sort, the most deals first by default, one page.

The organizations with deals in the place in the order of the sort, the most deals first by default, one page.

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 lean family: when the API produced it, and the publishes behind the rows.