Skip to main content
GET
List the loans of one lender

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

​
id
string
required

The lender organization: the organization id of the set, as a ranking row, a loan row or a search hit carries it.

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

Query Parameters

​
source
enum<string>

The source of the rows. Open rows are the open positions of the parcels, the current liens. Recorded rows are the recorded instruments of the history. Both gives the instrument rows alone, one for each loan key and lender. A paired loan rides as its open row. Default both.

Available options:
open,
recorded,
both
​
recorded_from
string<date>

Keep the loans recorded on or after this date, YYYY-MM-DD.

​
recorded_to
string<date>

Keep the loans recorded on or before this date, YYYY-MM-DD.

​
zip
string

Keep the loans on parcels of one 5-digit ZIP.

Pattern: ^\d{5}$
​
product
enum<string>[]

Keep the loans of these products (comma list or repeated key): construction, heloc, other.

Minimum array length: 1

The product of the loan, a reading of two flags of the county and the loan type: construction, heloc or other.

Available options:
construction,
heloc,
other
​
term_band
enum<string>[]

Keep the loans of these term bands (comma list or repeated key).

Minimum array length: 1

The term of the loan in months, banded: unknown, le_24m, 25_to_120m, 121_to_359m, ge_360m.

Available options:
unknown,
le_24m,
25_to_120m,
121_to_359m,
ge_360m
​
label
enum<string>[]

Keep the loans with these labels of the county (comma list or repeated key).

Minimum array length: 1

The label of the county for the transaction, mapped to a closed list. A label never sets a purpose: the county stopped labelling purchases in 2022.

Available options:
refi_or_second,
heloc,
resale_purchase_money,
new_purchase_money,
construction,
non_residential
​
amount_min
integer

Keep the loans with an amount of at least this many whole US dollars.

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

Keep the loans with an amount of at most this many whole US dollars.

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

The row order. recorded_desc puts the newest recording first, an undated row last. recorded_asc puts the oldest first, an undated row last. amount_desc puts the largest amount first, an unpriced row last. Every sort breaks a tie on the loan key, the source and the position. Default recorded_desc.

Available options:
recorded_desc,
recorded_asc,
amount_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 loans of the lender in the order of the sort, the newest recording first by default, one page. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates.

The loans of the lender in the order of the sort, the newest recording first by default, one page. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates.

​
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.