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

# API reference

> The order of this reference: the objects first, then the endpoints that return them.

The site generates the parameters, the response fields and the playground on every page here from the service's own
schemas. So those cannot drift from what the API answers. Investorlift writes the prose around them by hand.

**The site documents each object once.** A Deal is the same object from `/v1/deals`, from a parcel's history or from
an investor's own list. So [the Deal object](/api-reference/objects/deal) describes its fields once, and every
endpoint that returns one links up to it. Start there when you read a response and want to know what a field means.

**Endpoint pages are short.** Each endpoint page says what it returns, when to use it instead of a neighbour, and the
few things that will surprise you. The [guides](/guides/quickstart) give the detail.

## The objects

| Object                                                                | What it is                                                                                                                                                     |
| --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Deal](/api-reference/objects/deal)                                   | One investment purchase, flip, wholesale or current holding on one parcel.                                                                                     |
| [Investor](/api-reference/objects/investor)                           | A buyer: every name the registry believes is one operator, what they buy, and how to reach them.                                                               |
| [Property](/api-reference/objects/property)                           | One parcel: its facts, its owner, its listing, its short-term rental licence and every deal on it.                                                             |
| [Listing agent](/api-reference/objects/agent)                         | The agent behind an MLS listing, keyed to the state licence roll where one matches. Early access.                                                              |
| [Investorlift listing](/api-reference/objects/wholesale-listing)      | One house listed on Investorlift, and its outcome as the county deeds show it. Early access.                                                                   |
| [Wholesaler](/api-reference/objects/wholesaler)                       | An Investorlift listing company: what it listed, how fast it closes, who buys from it. Early access.                                                           |
| [Short-term rental parcel](/api-reference/objects/str-parcel)         | A parcel on a city's short-term rental licence roll.                                                                                                           |
| [Parcel search row](/api-reference/objects/parcel-search-row)         | One parcel in a search result, with the blocks the request asked for.                                                                                          |
| [Financing](/api-reference/objects/financing)                         | What the owner owes on a parcel: the valuation, the open liens, the mortgages and the involuntary liens.                                                       |
| [Lender](/api-reference/objects/lender)                               | One lender of record: every spelling under one id, its loans counted once across both mortgage tables, a profile per market. Early access.                     |
| [Lender ranking row](/api-reference/objects/lender-ranking)           | One lender in the ranked list of a market, a ZIP, a city, a county or the area around a point. Early access.                                                   |
| [Lender ranking bucket](/api-reference/objects/lender-ranking-bucket) | One place or month a lender lent in, with its rank and share there. Early access.                                                                              |
| [Lender cell](/api-reference/objects/lender-cell)                     | One hex cell a lender lent in, with its counts, for a map. Early access.                                                                                       |
| [Lender loan](/api-reference/objects/lender-loan)                     | One recorded instrument of a lender, with the parcel and the terms as filed. It says if it financed a purchase and names the deal it belongs to. Early access. |
| [Lender borrower](/api-reference/objects/lender-borrower)             | One borrower of a lender: the key, a company's name, the investor behind it and the loans. A flag says if the borrower moved on. Early access.                 |
| [Permit](/api-reference/objects/permit)                               | One building permit on a parcel, with its work tags and dates.                                                                                                 |
| [History event](/api-reference/objects/history-event)                 | One typed change on a parcel, and the week whose file showed it.                                                                                               |
| [Listing cycle](/api-reference/objects/listing-cycle)                 | One period on the market, from the listing to the exit: the price path and how it ended.                                                                       |
| [The response envelope](/api-reference/objects/envelope)              | `data`, `page`, `summary` and `meta`, which every response carries.                                                                                            |

## Before your first call

* [Authentication](/guides/concepts/authentication): the `zpka_` bearer key and what it gets.
* [The response envelope](/guides/concepts/envelope): what comes back and in what units.
* [Pagination](/guides/concepts/pagination): follow `page.next_cursor`.
* [Errors](/guides/concepts/errors): every code, with a body to recognise and a fix.

## Conventions in one paragraph

* Every response is `{ data, meta }`. A list adds `page` and sometimes `summary`.
* Dates are `YYYY-MM-DD`.
* Money is whole dollars. It is null, never 0, when the deed carries no price.
* Every id has a prefix: `deal_`, `prop_`, `inv_`, `agt_`, `wl_`, `wsr_` or `len_`.
* The API follows an old `inv_`, `agt_` or `len_` id from an earlier registry run to the current record, with
  `meta.resolved_from`. For a retired id, the API answers `410 gone`.
* Coordinates are WGS84. Distances are miles.
* The geometry you ask about is a point and a radius (`lat`, `lng`, `radius_miles`), a viewport
  (`bbox=west,south,east,north`) or a parcel (`property_id`). On the deal, investor, wholesale and short-term rental
  lists, it can also be a place: a ZIP list (`zip`) or a postal city (`city`). With a place, `lat` and `lng` beside it
  are the reference point only.
* Lists take commas or repeated keys.
* This host does not serve the fields that identify a natural person. They arrive `null` with
  `contact_redacted: true`. On the parcel routes (search, financing, history, listing history) and on a lender's loan
  rows, the object leaves those keys out and carries no flag.
* One route, [parcel search](/api-reference/endpoints/properties-search), takes a `POST` body because its criteria
  nest. Every other route is a `GET`.

<Note>
  The playground on every endpoint page sends real requests to `https://api.investorlift.com` from your browser. Paste a
  key into its Authorization box. [Get an API key](/get-a-key) takes two minutes. The playground runs under your plan's
  limits like any other call.

  No official SDK exists yet. Every guide shows the request in curl, Node.js and Python. openapi-typescript or
  openapi-python-client generates a typed client from the OpenAPI document at
  `https://api.investorlift.com/openapi.json`. Official packages will follow.
</Note>

## Early access

The listing-agent routes and the Investorlift listing routes are in this reference from 2026-09-14. The lender routes
are in it too. All of them are for Investorlift's team and trusted partners while the developer tier is in beta:

* The listing-agent routes: `GET /v1/agents/search`, `GET /v1/agents/{id}` and `GET /v1/agents/{id}/listings`.
* The Investorlift listing routes: `GET /v1/wholesale-listings`, `GET /v1/wholesale-listings/{id}`,
  `GET /v1/investors/{id}/wholesale-purchases`, `GET /v1/wholesalers/search`, `GET /v1/wholesalers/{id}` and
  `GET /v1/wholesalers/{id}/listings`.
* The lender routes: `GET /v1/lenders/search`, `GET /v1/lenders`, `GET /v1/lenders/{id}` and
  `GET /v1/lenders/{id}/loans` from API 0.14.0, `GET /v1/lenders/{id}/borrowers` from 0.16.0, and
  `GET /v1/lenders/{id}/rankings` and `GET /v1/lenders/{id}/cells` from 0.19.0.

These routes have no price and cost no credits. Investorlift will restrict them further before they open to every
key, and will announce the change in the [changelog](/changelog) first. Once the paid plans publish, Growth and the
plans above it include the lender routes. From that day, the API refuses them below Growth. Investorlift will announce
that change the same way. `GET /v1/str-parcels` is under By contract: Investorlift sells it per jurisdiction under an
order form.

## Partners and staff

Staff and contracted partners reach the internal host on the company network with a `gm_` key. That host serves one
route that `api.investorlift.com` does not sell. The route left this reference on 2026-09-11: `GET /v1/deals/pins`,
every deal in a geometry as parallel arrays for a map. The operators' `openapi.json` on that host describes it. Here,
`/v1/deals/cells` with `/v1/deals` draws the same map.


## Related topics

- [List the building permits on a parcel](/api-reference/properties/list-the-building-permits-on-a-parcel.md)
- [Get one deal by id](/api-reference/deals/get-one-deal-by-id.md)
- [Find a lender by any spelling of its name](/api-reference/lenders/find-a-lender-by-any-spelling-of-its-name.md)
- [Find an investor by any name it buys under](/api-reference/investors/find-an-investor-by-any-name-it-buys-under.md)
- [Read the financing, liens and valuation of a parcel (dated)](/api-reference/properties/read-the-financing-liens-and-valuation-of-a-parcel-dated.md)
