Skip to main content
GET
Rank the lenders of a place
This route serves the lean set under /v3/lenders. See The lean dataset for the tier rules and the rule of a lender name.

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

state
string
required

The served state of the ranking, two letters. A ranking is a ranking in a place.

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

One county by its 5-digit FIPS. Default: the whole state. A county the served state does not list answers 404: meta.build.states[].counties lists them. county and zip together answer 400 geometry_conflict.

Pattern: ^[0-9]{5}$
zip
string

One 5-digit ZIP. Default: the whole state. A ZIP with no parcel in the place index answers 404. county and zip together answer 400 geometry_conflict.

Pattern: ^\d{5}$
period
enum<string>

The window of the ranking, anchored on financing_as_of of the state: all, 24m (the 730 days before), 12m (the 365 days before). Default 24m.

Available options:
all,
24m,
12m
tags
enum<string>[]

Keep the lenders that carry every tag given (comma list or repeated key): government, bank, credit_union, trust, person, hard_money, institution. Default: every lender.

Minimum array length: 1

A reading of the name of the lender, each by its rule in the build. government: a public body. bank: the bank, thrift and charter words. credit_union: a credit union. trust: a trust, an IRA, an estate or a seller carry-back. person: a name that reads as a person. hard_money: the hard-money vocabulary and brands. institution: a servicer, a title company or an association. A tag decides no row: a lender keeps its loans and gets a tag. The list can grow with the rules of the build: a client keeps an unknown tag.

Available options:
government,
bank,
credit_union,
trust,
person,
hard_money,
institution
min_n
integer

Keep the lenders with at least this many loans in the place and the period. Default: 1.

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

The row order. loans_desc puts the most loans in the place first, then the largest volume. volume_desc puts the largest volume first, then the most loans. open_liens_desc puts the most open positions first, and needs period=all: the open book is counted on the all period alone. last_recorded_desc puts the newest recording first. Every sort breaks a tie on the organization id. Default loans_desc.

Available options:
loans_desc,
volume_desc,
open_liens_desc,
last_recorded_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 lenders of the place in the order of the sort, the most loans first by default, one page. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates.

The lenders of the place in the order of the sort, the most loans 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.