Skip to main content
GET
List the borrowers 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.

Path Parameters

​
id
string
required

Lender id, len_ followed by 12 hex characters, for example len_d2028f0766fc. Take it from a search hit, a ranking row's lender.id or a parcel's financing block. The id is the same in every market and stable across data refreshes. The API follows an id from an earlier registry run to the current lender, and meta.resolved_from lists it. For a retired id with no successor, the API answers 410 gone.

Query Parameters

​
market
string

Market code, for example phx. The loaded markets are in meta.coverage[]. Send it only when the id exists in more than one loaded market. 400 market_required says so, and a lender has the same id in every market it lent in. Otherwise the API uses the id's own market.

Required string length: 1 - 16
​
period
enum<string>
default:24m

Which count min_loans and the loans_desc sort read. 24m, the default, counts loans from this lender in the 24 months ending on the slice date, and the API walks it through an index. The value all counts every loan on record, and the API sorts it in memory, slower on the largest lenders.

Available options:
24m,
all
​
q
string

An entity name to look for among the borrowers, as the recorded mortgages write it ("Saguaro Holdings", "SAGUARO HOLDINGS LLC"). Every word of the query of 3 or more characters must be a word of the borrower's name. The match ignores LLC, INC and similar suffixes. It matches company borrowers alone: a person's name never matches, on any key. Send at least 3 letters or digits (400 otherwise).

Required string length: 1 - 200
​
registered_only
enum<string>

true keeps only borrowers that resolve to a registered investor (investor not null). false keeps only the rest. Default: every borrower.

Available options:
true,
false
​
churned
enum<string>

true keeps only churned borrowers (churned true). false keeps only the rest. Default: every borrower. A churned borrower took a later loan elsewhere and none here since, a lower bound.

Available options:
true,
false
​
investor_kind
enum<string>[]

Keep only borrowers whose registered investor carries at least one of these kinds (comma list or repeated key). The filter drops borrowers without an investor.

Minimum array length: 1

Investor kind, the primary one of kinds[] (an investor can carry several), for display only. FLIPPER: buys, renovates and resells. WHOLESALER: buys to resell quickly, often through a double close. LANDLORD: buys and holds rentals. BUILDER: builds on lots it buys. IBUYER: Opendoor, Offerpad or Zillow.

Available options:
FLIPPER,
WHOLESALER,
LANDLORD,
BUILDER,
IBUYER
​
min_loans
integer
default:1

Keep only borrowers with at least this many loans from this lender in the period, default 1. The count is n_loans_24m under period=24m and n_loans under period=all.

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

Row order of a lender's borrowers: loans_desc, the default, puts the most loans from this lender in the period first. With volume_desc, the largest loan total in the period comes first. With last_loan_desc, the newest loan from this lender comes first. With churned_first, borrowers who moved to another lender come first, then the rest by loans. Ties end on borrower_key.

Available options:
loans_desc,
volume_desc,
last_loan_desc,
churned_first
​
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
​
require_current
enum<string>
default:false

true refuses the request with 422 dated_refused while the registry's source, the financing slice, is a dated snapshot. The default false serves it, and meta.dated[] carries the lenders and financing blocks.

Available options:
true,
false

Response

The lender's borrowers in one market, one page in the requested sort.

The lender's borrowers in one market, one page in the requested sort.

​
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: when the API produced it, which markets it covers, and how fresh they are.