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

period
enum<string>

all: every borrower. 24m: the borrowers with a loan of the lender in the 730 days before financing_as_of. The counts, the dates and the sum of each row stay all time under both. Default all.

Available options:
all,
24m
q
string

A word of the name of the borrower organization, matched as a word, case-insensitive. A person never matches.

Required string length: 2 - 80
registered_only
enum<string>

True keeps the borrowers that are organizations of the business registry. False keeps the others. Default: every borrower.

Available options:
true,
false
min_loans
integer

Keep the borrowers with at least this many loans of the lender. Default: 1.

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

The row order. loans_desc puts the most loans first. volume_desc puts the largest sum of amounts first, an unpriced pair last. last_loan_desc puts the newest loan first. Every sort breaks a tie on the organization id. Default loans_desc.

Available options:
loans_desc,
volume_desc,
last_loan_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 borrowers of the lender as organizations, the most loans first by default, one page. Each row is a counterparty with the relation lent_to: n_deeds counts the loans between the two, and total_price sums their amounts. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates.

The borrowers of the lender as organizations, the most loans first by default, one page. Each row is a counterparty with the relation lent_to: n_deeds counts the loans between the two, and total_price sums their amounts. 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 /v3 family: when the API produced it, and the publishes behind the rows.