Skip to main content
GET
List the marketplace listings with the reading of the deeds

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
lat
number

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

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). A listing whose address resolved to no parcel is outside every radius.

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[]

The scope as a list of 5-digit ZIPs (comma list or repeated key), at most 60. The ZIP is the ZIP of the listing, so a listing with no parcel is in it too.

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

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

​
state
string

The scope as a state, for example AZ: every listing of the state.

Pattern: ^[A-Z]{2}$
​
wholesaler
string

The scope as the wholesaler: the listings whose seller name met this organization of the business registry.

Pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$
​
buyer
string

The scope as the buyer: the listings this organization closed as the buyer of the purchase deed.

Pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$
​
outcome
enum<string>[]

Keep these outcomes (comma list or repeated key): closed, closed_late, open, late_window, no_deed or unresolved. Default: every outcome.

Minimum array length: 1
Available options:
closed,
closed_late,
open,
late_window,
no_deed,
unresolved
​
source
enum<string>

Keep the listings of one marketplace: investorlift or mogul. Default: both.

Available options:
investorlift,
mogul
​
from
string<date>

Keep the listings published on or after this date, YYYY-MM-DD.

​
to
string<date>

Keep the listings published on or before this date, YYYY-MM-DD.

​
closed_from
string<date>

Keep the listings whose closing purchase is dated on or after this date, YYYY-MM-DD. A listing with no closing leaves.

​
closed_to
string<date>

Keep the listings whose closing purchase is dated on or before this date, YYYY-MM-DD. A listing with no closing leaves.

​
asking_min
integer

Keep the listings asked at or above this, whole US dollars. An unpriced listing leaves.

Required range: 0 <= x <= 9007199254740991
​
asking_max
integer

Keep the listings asked at or below this, whole US dollars. An unpriced listing leaves.

Required range: 0 <= x <= 9007199254740991
​
sort
enum<string>

The row order. published_desc puts the newest publication first. closed_desc puts the newest closing first, a listing with no closing last. price_desc and price_asc order on the asking price, unpriced listings last. distance puts the nearest parcel first and needs lat and lng, or property_id. The listing id breaks every tie.

Available options:
published_desc,
closed_desc,
price_desc,
price_asc,
distance
​
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 listings of the marketplaces in the scope, newest publication first by default, one page.

The listings of the marketplaces in the scope, newest publication 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.