Skip to main content
GET
Find a lender by any spelling of its name
Early access: while the developer tier is in beta, the API serves this route to Investorlift’s team and trusted partners. Investorlift will restrict the route further before it opens to every key.
The route returns the stable lender id. Use the id to open a profile.

​
Use it when

The lender typeahead, and the step that turns a name you already have into a lender id. “Kiavi”, “LendingHome” and “Kiavi Funding, Inc.” all find the one id.
From a parcel you already have, skip the search. Its financing block names the lender of every lien. A profile’s names[] lists every spelling under the id.

​
Read the response

match says how the API found the hit, best first:
  • matched_name is the spelling that hit. So a search for LendingHome answers Kiavi’s id, with matched_name LENDINGHOME FUNDING CORP under name KIAVI FUNDING INC.
  • Within one match level, the lenders with the most loans in the 24 months to as_of come first. The hit carries n_loans_24m, n_open_liens, open_balance and rank_24m. So you can tell a list of candidates apart without a look at each profile.
  • page.capped is true when limit cut the page. The envelope’s page block has the rule and what to do when it is true.
  • Without market=, the API searches every loaded market with a lender registry. A lender that lent in two markets appears once per market under the same id.

​
Gotchas

  • By default the list hides persons and government lenders. To show persons, set include_persons=true. To show government lenders, set include_government=true. lender_class= narrows within what the list shows and does not lift the two defaults. A person-named lender below the person gate has no id and is never a hit. The Lender object defines the gate.
  • No cursor: page.next_cursor is always null.
  • Every hit is dated (meta.dated[]). With require_current=true, the API answers 422 dated_refused.
  • A market with no published lender registry answers 422 lenders_unavailable. With no market loaded at all, the search answers 503 not_ready.
Who is this 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.

Query Parameters

​
q
string
required

The lender to look for: any spelling the recorded instruments use, or part of one. "Kiavi Funding", "LendingHome" and "Wells Fargo Bank N.A." are examples. Case, punctuation and the entity suffix (LLC, INC, NA) do not matter. Send at least 3 letters or digits (400 otherwise).

Required string length: 1 - 200
​
market
string

Market code, for example phx. The loaded markets are in meta.coverage[]. It narrows the search to that market. The API answers 400 when that market is not loaded, 422 lenders_unavailable when the market has no published lender registry. Without it the API searches every loaded market with a lender registry and each hit carries its market.

Required string length: 1 - 16
​
lender_class
enum<string>[]

Keep only lenders of these classes (comma list or repeated key): BANK, NONBANK, PRIVATE, INDIVIDUAL, GOVERNMENT. It does not lift the two defaults below: INDIVIDUAL and PRIVATE still need include_persons=true, and GOVERNMENT needs include_government=true. For the hard-money sense of private lender, use hard_money=true, not lender_class=PRIVATE.

Minimum array length: 1

How the lender name reads. BANK: a bank, credit union or thrift. NONBANK: a mortgage company or other lending business. PRIVATE: a trust, a seller carry-back or another private party, not the hard-money sense of private lender, which the Lender object carries as is_hard_money. INDIVIDUAL: a person's name. GOVERNMENT: an agency or a public body.

Available options:
BANK,
NONBANK,
PRIVATE,
INDIVIDUAL,
GOVERNMENT
​
hard_money
enum<string>

true keeps only hard-money lenders (is_hard_money true). false keeps only the rest. Default: every lender. The registry flags a hard-money lender by name or brand, or by behaviour in a market with the deed link.

Available options:
true,
false
​
include_persons
enum<string>
default:false

true includes lenders whose class reads INDIVIDUAL or PRIVATE: a person's name, a trust, a seller carry-back. Default false hides them, the way investor lists hide institutional investors.

Available options:
true,
false
​
include_government
enum<string>
default:false

true includes GOVERNMENT lenders: HUD, the VA, a housing authority. Their counts are insurance claims and partial-claim seconds recorded under the agency's name, not originations. Default false hides them.

Available options:
true,
false
​
limit
integer
default:10

Lenders to return, 1 to 50 (default 10).

Required range: 1 <= x <= 50
​
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

Lenders that match the query, best match first. page.next_cursor is always null and page.capped is true when the API cut the page at limit.

Lenders that match the query, best match first. page.next_cursor is always null and page.capped is true when the API cut the page at limit.

​
data
object[]
required

The hits, best match first.

​
page
object
required

The page block of a name search: no cursor, the limit applied, the hits returned and if the API cut the page at the limit.

​
meta
object
required

Response metadata: when the API produced it, which markets it covers, and how fresh they are.