> ## Documentation Index
> Fetch the complete documentation index at: https://developers.investorlift.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Lender ranking bucket

> One place or month a lender lent in: its loans, rank and share there among every lender of the market, and a partial-window flag.

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

One row of [`GET /v1/lenders/{id}/rankings`](/api-reference/endpoints/lenders-rankings): one place or one calendar
month, and what one lender did there over the window the request named. A place is a ZIP, a city, a county or an H3
cell. [The ranking row](/api-reference/objects/lender-ranking) is one lender inside one place. The bucket is one place
inside one lender.

## Read a bucket

* **`key`** names the bucket: the ZIP, the city, the county FIPS, the H3 index as hex, or the month as `YYYY-MM`.
* **`n` is every instrument of any kind** the lender recorded in the bucket over the window. The API counts each instrument once
  across the open-lien and recorded-history tables. `volume` sums the priced ones. It counts a blanket loan once and
  leaves out amounts above \$5,000,000. That is the same rule as every volume on
  [the Lender object](/api-reference/objects/lender#what-the-counts-are).
* **`rank` is the lender's position among every lender of the market** in the same bucket and window, by `n`, with
  ties by volume then id. Persons below the person gate and placeholder names hold a slot. **`share`** is `n` over
  every lender's instruments in the bucket. On a month bucket, the pair equals the profile's `by_month[]` `rank` and
  `share` for that month, computed the same way. On a month the lender recorded nothing in, `rank` is null and `share`
  is 0. The month series fills in such a month so that the series is complete.
* **`n_purchase_money`** is the count of instruments among `n` that financed a purchase. **`n_investor`** is the
  count of those whose borrower resolves to a registered investor. Both are null where no deed link exists for the
  market.
* **`partial`** is true when the bucket is the slice month or the slice year, a window that ends after
  `recordings_through`. The bucket is the slice month when its key is that month, or when `period=YYYY-MM` names that
  month. The bucket is the slice year when `period=YYYY` names that year. **`floor`** is true on a calendar-year
  bucket before `history_floor_year`. The history keeps five slots per parcel, so those years are a floor, never a
  count.

Every bucket is dated: `as_of` is the registry's slice date, and `meta.dated[]` on the response names the `lenders`
and `financing` blocks. A bucket carries no name and no address. The lender is the path id.


## Related topics

- [Rank one lender by place or by month](/api-reference/endpoints/lenders-rankings.md)
- [API reference](/api-reference/introduction.md)
- [Changelog](/changelog.md)
- [The Lender ranking row](/api-reference/objects/lender-ranking.md)
- [Who is this lender?](/guides/walkthroughs/profile-a-lender.md)