Skip to main content
GET
List the rental listings of a place

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, address with zip, 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 address, 0.25 to 20 (default 1).

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

A street line, with zip: the API resolves it to a parcel and searches the radius around it. For example 7522 E Cholla St with zip 85254.

Required string length: 3 - 200
zip
string[]

A place as a list of 5-digit ZIPs (comma list or repeated key), at most 60. With address, the one ZIP of the address.

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

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

on_market
enum<string>
default:true

True keeps the listings on the market at the data end: active and pending. False keeps every current listing, sold and off-market ones too. Default true.

Available options:
true,
false
sort
enum<string>

The row order. distance puts the nearest listing first and needs a point. listed_desc puts the newest listing first. price_asc and price_desc order on the list price, unpriced rows last. The default is distance with a point, else listed_desc. Every sort breaks a tie on the listing id.

Available options:
distance,
listed_desc,
price_asc,
price_desc
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 current listings near the place, one page.

The current listings near the place, 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 /v3 family: when the API produced it, and the publishes behind the rows.