Skip to main content
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.
One row of GET /v1/lenders/{id}/cells: one H3 hexagon at the requested resolution and what one lender did in it over the window.

​
Read a cell

  • cell is the H3 index as hex, the same string GET /v1/deals/cells uses and any H3 library turns into an outline. The cell is the parcel’s, so every loan sits in exactly one cell at each resolution. The API never clips an edge cell.
  • n counts the lender’s instruments of any kind in the cell over the window, once across the open-lien and recorded-history tables. With product= on the request, it is the named products’ counts alone. volume sums the priced ones under the $5,000,000 amount rule and the blanket rule of the Lender object. product never narrows it.
  • n_purchase_money and n_investor are the instruments among the cell’s that financed a purchase, and those whose borrower resolves to a registered investor. Both are null where the market’s build does not include the deed link.
  • n_foreclosed counts the cell’s instruments that a take-back deed followed. The deed is a trustee’s deed, a sheriff’s deed or a deed in lieu of foreclosure on the parcel. It comes after the recording and before any resale or later mortgage. This is the reading foreclosed on the loan row carries. It is a deed count, never a delinquency measure.
Every cell is dated: as_of is the registry’s slice date and meta.dated[] on the response names the lenders and financing blocks. A cell carries no ids, no names and no prices.

One H3 cell the lender lent in over the period: the count, the volume, the purchase-money, investor and foreclosed counts. The zoomed-out map layer of one lender.

​
cell
string
required

The H3 cell as a hex string, for example 8848eba59dfffff, at the requested res: the form H3 libraries read and GET /v1/deals/cells serves.

​
n
integer
required

Instruments recorded in the cell over the period with this lender as lender of record, counted once across both tables. With product[] the count is the sum of the named products' counts.

Required range: -9007199254740991 <= x <= 9007199254740991
​
volume
integer
required

Sum of the loan amounts of the priced instruments in the cell over the period, whole dollars. The sum counts a blanket group once and leaves out amounts above $5,000,000. 0 when none carries a price. The product[] filter does not narrow it.

Required range: -9007199254740991 <= x <= 9007199254740991
​
n_purchase_money
integer | null
required

Of the cell's instruments, those whose purpose is PURCHASE. Null while the market has no deed link. The product[] filter does not narrow it.

Required range: -9007199254740991 <= x <= 9007199254740991
​
n_investor
integer | null
required

Of the cell's instruments, those whose borrower resolves to a registered investor. Null while the market has no borrower match. The product[] filter does not narrow it.

Required range: -9007199254740991 <= x <= 9007199254740991
​
n_foreclosed
integer
required

Of the cell's instruments, those followed by a take-back deed on the parcel. Those instruments carry foreclosed on the loan row. 0 where the registry does not carry the take-backs for the market. The product[] filter does not narrow it.

Required range: -9007199254740991 <= x <= 9007199254740991
​
as_of
string
required

The slice date, YYYY-MM-DD. The API measures the counts at it. Dated: see meta.dated[].

​
dated
boolean
required

True while the datasets are not in the current delivery, so the row is a snapshot at as_of.