> ## 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. # List the loans of one lender > The loans of one lender organization, the newest recording first, one page. Each row is an open position or a recorded instrument with its amounts, dates, terms, labels and parcel. Use it for the book under a lender. The loans are a dated slice: meta.build.states[].financing_as_of gives the date. recorded_from and recorded_to cut a window, product, term_band and label keep kinds, zip keeps a place. A listed property serves no street line. A call costs 0 credits. [The lean dataset of the Investorlift Data API](https://developers.investorlift.com/api-reference/lean). ## OpenAPI ````yaml /openapi.json get /v3/lenders/{id}/loans openapi: 3.1.0 info: title: God Mode API version: 0.63.0 description: >- You have a house to sell, usually a wholesale contract. You want **the investors who buy houses like this one, from county deed records**. This API reads those records for each loaded market and serves three things: deals, investors and a ranking. On every response, `meta.coverage[]` lists the markets and the area each covers. **Deals** are every investment purchase, flip, wholesale and current investor holding. **Investors** are the buyers behind them, grouped so that the LLCs of an operator and the person behind them count as one. **A ranking** says, for a given house, which investors are the best fit and why. The documentation site at https://developers.investorlift.com carries the guides, the walkthroughs, the error catalogue and the connection steps for MCP clients. https://developers.investorlift.com/llms.txt indexes the site for a model. This document is the machine-readable reference behind the API tab of the site. **Start here.** Ranked buyers for a house at 7522 E Cholla St, Scottsdale, under contract at $410,000 and in need of a major rehab: ``` GET https://api.investorlift.com/v1/buyers/match?lat=33.476917&lng=-111.920385&radius_miles=2&subject_asking_price=410000&subject_condition=MAJOR_REHAB Authorization: Bearer zpka_... ``` **Conventions.** Responses are `{ data, meta }`. Lists add `page` (an opaque cursor) and sometimes `summary`. A list parameter takes commas or repeated keys. Dates are YYYY-MM-DD. Ids carry a prefix: `deal_`, `prop_`, `inv_`, `agt_`, `wl_`, `wsr_`. Money is whole dollars. It is null, never 0, when the deed carries no price. Coordinates are WGS84. A location is a point and radius (`lat`, `lng`, `radius_miles`), a viewport (`bbox=west,south,east,north`) or a parcel (`property_id`). Every operation carries `x-credits`, its price in credits on the public tier. `charge` is null at 0 credits. Otherwise `kind` names the deal, investor or property (a parcel) that costs 1 credit when new to your account. `base` is the credits a call costs before them. `contract: true` marks a route sold by contract. Every operation also carries `x-raises`, the problem codes it can answer, sorted. Each problem response of the operation lists and shows the codes of its status alone. The list includes the codes the gateway answers on its own. This host does not serve the people behind an entity, mailing addresses, owner identity, mortgage borrowers or lien parties. It does not serve the names, phones, emails and licence numbers of listing agents. It serves the entities, the deals, the listings and the ranking. Errors are RFC 9457 problem+json with a `code` to switch on. The catalogue is https://developers.investorlift.com/problems.json and the Errors page of the site. The field `meta.coverage[].dataset_version` changes only when a refresh rebuilds the tables of a market. Use it in cache keys, or poll `GET /v1/dataset`. **MCP.** The API serves the same data to Model Context Protocol clients at `POST https://api.investorlift.com/mcp` with the same key: twenty-nine read-only tools, four resources, seven prompts. The MCP tab of the documentation site has the client setup. The file `mcp-manifest.json` beside this document lists the tools with their input schemas. Problem codes: 400 validation_error, 400 unknown_parameter, 400 invalid_cursor, 400 geometry_required, 400 geometry_conflict, 400 sort_requires_point, 400 invalid_id, 400 market_required, 401 unauthorized, 403 quota_exceeded, 403 subscription_required, 403 payment_overdue, 403 plan_limit, 404 not_found, 406 not_acceptable, 410 gone, 422 outside_coverage, 422 ambiguous_apn, 422 ambiguous_address, 422 csv_cap_exceeded, 422 listings_unavailable, 422 agents_unavailable, 422 lenders_unavailable, 422 wholesale_unavailable, 422 str_unavailable, 422 cash_sale_unavailable, 422 auction_unavailable, 422 parcels_unavailable, 422 addresses_unavailable, 422 dated_refused, 422 history_unavailable, 400 quicklist_unavailable, 400 dataset_unavailable, 429 rate_limited, 500 internal_error, 503 database_unavailable, 503 pool_saturated, 503 ledger_unavailable, 504 statement_timeout. servers: - url: https://api.investorlift.com security: - bearerAuth: [] tags: - name: listings x-group: MLS listings description: >- Sale listings and observed asking rents near a location, with dated facts and sample counts. - name: buyers x-group: Buyers description: >- Which investors are the best fit for this house: the API ranks nearby investors against a subject property and explains each score. - name: deals x-group: Deals description: >- What occurred around a location: deals for a table, cells for a map, summary stats, and one deal by id. - name: investors x-group: Investors description: >- Who the buyers are: investors active in an area, a full profile, and their metro-wide history. A search finds an investor by any name they buy under. - name: properties x-group: Properties description: >- One parcel: find it from a point or an APN, then read its facts, owner information, short-term rental licence and every deal on it. The owner information covers investor holdings and business-use short-term rentals. - name: agents x-group: Listing agents description: >- Who the listing agents are: find one by name or licence number, then read the profile and every listing of theirs. The profile holds the licence, the brokerages, the listing counts and the investors they belong to. - name: wholesale x-group: Investorlift listings description: >- Investorlift listings as wholesale transactions: the houses listed, and what the county deeds show for each (closed, to whom, which deed). Also the listing companies, and what each investor bought off Investorlift. - name: lenders x-group: Lenders description: >- Who lends on houses in a market: find a lender by any spelling of its name. Rank the lenders of a market, or of one ZIP, city or county. Read a profile: loans counted once across the open-lien and recorded-history tables, the open book, terms, geography and rankings. List every loan of one lender. - name: lean x-group: Lean set description: >- The lean set, under `/v3`: who buys houses, from the state business registry and the deeds. A name search, one organization with its entities and its persons, its purchases, one person with the agent block, the current listings near a place, and the coverage and the build of each served state. - name: dataset x-group: Dataset and coverage description: >- What the API serves, how fresh it is and which data is available where. The dataset version and the last deed date of every market, for cache keys and freshness checks. The coverage matrix, with a place lookup. - name: contract x-group: By contract description: >- Routes sold per jurisdiction under an order form and not reachable on a self-serve key. Ask through the console. externalDocs: description: >- The documentation site: the guides, the walkthroughs, the error catalogue and the MCP connection steps. url: https://developers.investorlift.com paths: /v3/lenders/{id}/loans: get: tags: - lean summary: List the loans of one lender description: >- The loans of one lender organization, the newest recording first, one page. Each row is an open position or a recorded instrument with its amounts, dates, terms, labels and parcel. Use it for the book under a lender. The loans are a dated slice: meta.build.states[].financing_as_of gives the date. recorded_from and recorded_to cut a window, product, term_band and label keep kinds, zip keeps a place. A listed property serves no street line. A call costs 0 credits. [The lean dataset of the Investorlift Data API](https://developers.investorlift.com/api-reference/lean). operationId: listLeanLenderLoans parameters: - schema: type: string enum: - open - recorded - both in: query name: source required: false description: >- The source of the rows. Open rows are the open positions of the parcels, the current liens. Recorded rows are the recorded instruments of the history. Both gives the instrument rows alone, one for each loan key and lender. A paired loan rides as its open row. Default both. - schema: type: string format: date in: query name: recorded_from required: false description: Keep the loans recorded on or after this date, YYYY-MM-DD. - schema: type: string format: date in: query name: recorded_to required: false description: Keep the loans recorded on or before this date, YYYY-MM-DD. - schema: type: string pattern: ^\d{5}$ in: query name: zip required: false description: Keep the loans on parcels of one 5-digit ZIP. - schema: minItems: 1 type: array items: type: string enum: - construction - heloc - other description: >- The product of the loan, a reading of two flags of the county and the loan type: construction, heloc or other. in: query name: product required: false description: >- Keep the loans of these products (comma list or repeated key): construction, heloc, other. style: form explode: true - schema: minItems: 1 type: array items: type: string enum: - unknown - le_24m - 25_to_120m - 121_to_359m - ge_360m description: >- The term of the loan in months, banded: unknown, le_24m, 25_to_120m, 121_to_359m, ge_360m. in: query name: term_band required: false description: Keep the loans of these term bands (comma list or repeated key). style: form explode: true - schema: minItems: 1 type: array items: type: string enum: - refi_or_second - heloc - resale_purchase_money - new_purchase_money - construction - non_residential description: >- The label of the county for the transaction, mapped to a closed list. A label never sets a purpose: the county stopped labelling purchases in 2022. in: query name: label required: false description: >- Keep the loans with these labels of the county (comma list or repeated key). style: form explode: true - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: amount_min required: false description: >- Keep the loans with an amount of at least this many whole US dollars. - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: amount_max required: false description: Keep the loans with an amount of at most this many whole US dollars. - schema: type: string enum: - recorded_desc - recorded_asc - amount_desc in: query name: sort required: false description: >- The row order. recorded_desc puts the newest recording first, an undated row last. recorded_asc puts the oldest first, an undated row last. amount_desc puts the largest amount first, an unpriced row last. Every sort breaks a tie on the loan key, the source and the position. Default recorded_desc. - schema: default: 100 type: integer minimum: 1 maximum: 500 in: query name: limit required: false description: Page size, 1-500 (default 100). - schema: type: string minLength: 1 maxLength: 4096 in: query name: cursor required: false description: >- 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. - schema: type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ in: path name: id required: true description: >- The lender organization: the organization id of the set, as a ranking row, a loan row or a search hit carries it. responses: '200': description: >- The loans of the lender in the order of the sort, the newest recording first by default, one page. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/LeanLoan' description: The rows of this page. page: $ref: '#/components/schemas/Page' meta: $ref: '#/components/schemas/LeanMeta' required: - data - page - meta additionalProperties: false description: >- The loans of the lender in the order of the sort, the newest recording first by default, one page. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates. example: data: - loan_key: 8d6f30a4daf06847956e2978dac68e62 property_id: 91447dee8ac05fa1f7a3a1f8e7cf0ea1 source: open position: 1 is_instrument: true in_both: false lender: org_id: AZ:23078262 org_name: ROCKET MORTGAGE, LLC from_registry: true tags: - institution lender_name_as_recorded: ROCKET MORTGAGE LLC assigned_lender_name: ROCKET MORTGAGE LLC lender_open: null lender_disagrees: false recording_date: '2026-05-22' document_date: null due_date: '2056-06-01' loan_amount: 444150 amount_outlier: false current_balance: 444150 balance_outlier: false interest_rate: 6.46 interest_rate_type: null estimated_payment: 2795 term_months: 360 months: 360 term_band: ge_360m loan_type: New Conventional loan_type_code: U financing_type: Fixed Rate Override label: null label_as_recorded: null product: other product_basis: file product_proxy: retail purpose_of_loan: '15' heloc: false construction_loan: false standalone_refi: false cash_purchase: false adjustable_rate_rider: null ltv: 86.405 blanket: null link: purpose: purchase deed_deal_id: 4b690cd99108ad7250957e13dcc3a6b7 deed_date: '2026-05-21' deed_price: 493500 loan_to_price: 0.9 sale_mtg_match: true deal: null outcome: null resolved_on: null months_to_resolution: null foreclosed: null borrowers: - name: null org_id: null org_name: null from_registry: null match_basis: none company_like: false tags: [] borrower_basis: owner_of_record as_of: '2026-06-25' parcel: line: 6278 E Catalina Dr unit: null city: Scottsdale zip: '85251' county_fips: '04013' apn: 128-49-123 latitude: 33.481907 longitude: -111.945483 address_held_back: null location_radius_m: null - loan_key: fe87a3798ef8122c4bcd0c2724667914 property_id: c98410805601c7f3971322b22498c229 source: open position: 1 is_instrument: true in_both: false lender: org_id: AZ:23078262 org_name: ROCKET MORTGAGE, LLC from_registry: true tags: - institution lender_name_as_recorded: ROCKET MORTGAGE LLC assigned_lender_name: ROCKET MORTGAGE LLC lender_open: null lender_disagrees: false recording_date: '2026-05-22' document_date: null due_date: '2056-06-01' loan_amount: 388750 amount_outlier: false current_balance: 388750 balance_outlier: false interest_rate: 6.46 interest_rate_type: null estimated_payment: 2446 term_months: 360 months: 360 term_band: ge_360m loan_type: New Conventional loan_type_code: U financing_type: null label: null label_as_recorded: null product: other product_basis: file product_proxy: retail purpose_of_loan: '02' heloc: false construction_loan: false standalone_refi: false cash_purchase: false adjustable_rate_rider: null ltv: 68.1345 blanket: null link: purpose: not_purchase deed_deal_id: null deed_date: null deed_price: null loan_to_price: null sale_mtg_match: false deal: null outcome: null resolved_on: null months_to_resolution: null foreclosed: null borrowers: - name: null org_id: null org_name: null from_registry: null match_basis: none company_like: false tags: [] borrower_basis: owner_of_record as_of: '2026-06-25' parcel: line: 7167 E Rancho Vista Dr UNIT 4008 unit: '4008' city: Scottsdale zip: '85251' county_fips: '04013' apn: 173-33-872 latitude: 33.506724 longitude: -111.926529 address_held_back: null location_radius_m: null - loan_key: 255f5832da0ca15d4a109af016f1d0fa property_id: b700b4c302610d32db04ab3d78d6a8da source: open position: 1 is_instrument: true in_both: false lender: org_id: AZ:23078262 org_name: ROCKET MORTGAGE, LLC from_registry: true tags: - institution lender_name_as_recorded: ROCKET MORTGAGE LLC assigned_lender_name: ROCKET MORTGAGE LLC lender_open: null lender_disagrees: false recording_date: '2026-05-18' document_date: null due_date: '2056-06-01' loan_amount: 550000 amount_outlier: false current_balance: 550000 balance_outlier: false interest_rate: 6.12 interest_rate_type: null estimated_payment: 3340 term_months: 360 months: 360 term_band: ge_360m loan_type: New Conventional loan_type_code: U financing_type: Adjustable Rate label: null label_as_recorded: null product: other product_basis: file product_proxy: retail purpose_of_loan: '01' heloc: false construction_loan: false standalone_refi: false cash_purchase: false adjustable_rate_rider: true ltv: 53.5669 blanket: null link: purpose: not_purchase deed_deal_id: null deed_date: null deed_price: null loan_to_price: null sale_mtg_match: false deal: null outcome: null resolved_on: null months_to_resolution: null foreclosed: null borrowers: [] as_of: '2026-06-25' parcel: line: 8519 E Indianola Ave unit: null city: Scottsdale zip: '85251' county_fips: '04013' apn: 130-42-137 latitude: 33.491451 longitude: -111.897464 address_held_back: null location_radius_m: null page: next_cursor: >- eyJ2IjoxLCJydW4iOiJ8bGVhbi1BWjE3OTE0ODcyNTAtQ0ExNzkwMjE1MTkwLUZMMTc5MDI2MjY4Mi1UWDE3OTAyNDgyMTMiLCJxIjoiMjlkZmYxNGVjMDdhNzZlYmZhZjY2NGJiODczZjRlOTY1NzBkMjc3MGQwYThkNWMxMDQ5OTU5MTU4NDA3M2NmOSIsImsiOlsiMjAyNi0wNS0xOCIsIjI1NWY1ODMyZGEwY2ExNWQ0YTEwOWFmMDE2ZjFkMGZhIiwib3BlbiIsMV19 limit: 3 returned: 3 meta: generated_at: '2026-10-08T19:47:10.138Z' coverage: [] terms: >- Data: Investorlift Data Services. Public-record and MLS listing data licensed through BatchData; municipal short-term rental registries; Investorlift marketplace records. Attribution and data-use terms: https://developers.investorlift.com/guides/terms build: states: - state: AZ build_id: null built_at: '2026-10-08T19:20:44.917Z' published_at: '2026-10-08T19:28:12.158Z' run_id: 1791487250 financing_as_of: '2026-06-25' recordings_through: '2026-06-11' financing_source: replay_887 - state: CA build_id: null built_at: '2026-09-24T01:58:30.453Z' published_at: '2026-09-24T03:15:56.838Z' run_id: 1790215190 financing_as_of: null recordings_through: null financing_source: null - state: FL build_id: 0e5fa9bc built_at: '2026-09-24T15:08:23.506Z' published_at: '2026-09-24T18:59:42.805Z' run_id: 1790262682 financing_as_of: null recordings_through: null financing_source: null - state: TX build_id: 775ed08d built_at: '2026-09-24T11:08:10.587Z' published_at: '2026-09-24T13:16:03.157Z' run_id: 1790248213 financing_as_of: null recordings_through: null financing_source: null headers: ETag: $ref: '#/components/headers/ETag' X-Request-Id: $ref: '#/components/headers/X-Request-Id' X-Rows: $ref: '#/components/headers/X-Rows' X-Dataset-Version: $ref: '#/components/headers/X-Dataset-Version' X-Data-End: $ref: '#/components/headers/X-Data-End' '400': description: >- Bad request (invalid_cursor, invalid_id, unknown_parameter, validation_error) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: invalid_cursor: summary: Invalid cursor value: type: >- https://developers.investorlift.com/guides/concepts/errors#invalid_cursor title: Invalid cursor status: 400 code: invalid_cursor detail: >- The API issued the cursor for another query. Restart from page 1. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 invalid_id: summary: Invalid id value: type: >- https://developers.investorlift.com/guides/concepts/errors#invalid_id title: Invalid id status: 400 code: invalid_id detail: >- An investor id is inv_ followed by 12 hex characters. The prefix is part of the id. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 unknown_parameter: summary: Unknown parameter value: type: >- https://developers.investorlift.com/guides/concepts/errors#unknown_parameter title: Unknown parameter status: 400 code: unknown_parameter detail: >- The query carries a parameter this endpoint does not define: kind[]. Write the list as kind=flip,hold or as repeated keys. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 errors: - param: kind[] message: unknown parameter code: unknown_parameter validation_error: summary: Validation error value: type: >- https://developers.investorlift.com/guides/concepts/errors#validation_error title: Validation error status: 400 code: validation_error detail: radius_miles must be 20 or less. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 errors: - param: radius_miles message: must be 20 or less code: too_big headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '401': description: Unauthorized (unauthorized) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: unauthorized: summary: Unauthorized value: type: >- https://developers.investorlift.com/guides/concepts/errors#unauthorized title: Unauthorized status: 401 code: unauthorized detail: 'Send Authorization: Bearer with a current key.' instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '403': description: Forbidden (payment_overdue, subscription_required) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: payment_overdue: summary: Payment overdue value: type: >- https://developers.investorlift.com/guides/concepts/errors#payment_overdue title: Payment overdue status: 403 code: payment_overdue detail: >- The subscription's payment is overdue and the grace period passed. Update the card under Manage Billing in the developer console. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 subscription_required: summary: Subscription required value: type: >- https://developers.investorlift.com/guides/concepts/errors#subscription_required title: Subscription required status: 403 code: subscription_required detail: >- This key has no active plan subscription. Subscribe in the developer console. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '404': description: Not found (not_found) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: not_found: summary: Not found value: type: >- https://developers.investorlift.com/guides/concepts/errors#not_found title: Not found status: 404 code: not_found detail: No such deal in any loaded market. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '406': description: Not acceptable (not_acceptable) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: not_acceptable: summary: Not acceptable value: type: >- https://developers.investorlift.com/guides/concepts/errors#not_acceptable title: Not acceptable status: 406 code: not_acceptable detail: >- Accept text/html names no representation this endpoint produces (application/json). instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '429': description: Rate limited, with Retry-After (rate_limited) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: rate_limited: summary: Rate limited value: type: >- https://developers.investorlift.com/guides/concepts/errors#rate_limited title: Rate limited status: 429 code: rate_limited detail: >- The request exceeded the per-key budget. Retry in 12 seconds. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 retry_after: 12 bucket: key headers: Retry-After: $ref: '#/components/headers/Retry-After' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '500': description: Internal error (internal_error) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: internal_error: summary: Internal error value: type: >- https://developers.investorlift.com/guides/concepts/errors#internal_error title: Internal error status: 500 code: internal_error detail: The request failed. Quote request_id when you report it. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '503': description: >- Unavailable, with Retry-After on pool_saturated and ledger_unavailable (database_unavailable, pool_saturated) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: database_unavailable: summary: Database unavailable value: type: >- https://developers.investorlift.com/guides/concepts/errors#database_unavailable title: Database unavailable status: 503 code: database_unavailable detail: >- The service failed to reach the database and did not run the request. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 pool_saturated: summary: Pool saturated value: type: >- https://developers.investorlift.com/guides/concepts/errors#pool_saturated title: Pool saturated status: 503 code: pool_saturated detail: >- No pooled connection was free. The service did not run the request. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: Retry-After: $ref: '#/components/headers/Retry-After' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '504': description: Statement timeout (statement_timeout) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: statement_timeout: summary: Statement timeout value: type: >- https://developers.investorlift.com/guides/concepts/errors#statement_timeout title: Statement timeout status: 504 code: statement_timeout detail: >- The query exceeded the 10 second statement timeout. Narrow the geometry or filters. instance: /v3/lenders/{id}/loans request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' components: schemas: LeanLoan: type: object properties: loan_key: type: string description: >- The key of the loan: a hash of the parcel, the recording date and the amount. One key for a paired open and recorded row. property_id: type: string pattern: ^[0-9a-f]{32}$ description: 'The parcel: the key to `GET /v3/properties/{id}`.' source: type: string enum: - open - recorded description: >- open: an open position of the parcel. recorded: a recorded instrument of the history. position: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The position of the row in its source: 1 to 4 for an open position, 1 to 5 for a recorded instrument, the newest first. is_instrument: type: boolean description: >- True on the one row of a loan key and lender: the open row of a paired loan, the recorded row otherwise. in_both: type: boolean description: >- True when the row has a twin in the other source: the same parcel, date and amount. lender: $ref: '#/components/schemas/LeanLenderRef' description: >- The lender of record: the recorded instrument's lender when the loan has one, else the open position's. lender_name_as_recorded: description: >- The lender as the county spelled it on this row. Null when the spelling reads as a person. type: - string - 'null' assigned_lender_name: description: >- The assignee of an open position as the county spelled it. Null when none, and when the spelling reads as a person. type: - string - 'null' lender_open: anyOf: - $ref: '#/components/schemas/LeanLenderRef' - type: 'null' description: >- The open-table lender when it differs from the lender of record. Null when they agree, or when the loan has no open position. lender_disagrees: type: boolean description: >- True when the open position and the recorded instrument of one loan name two lenders. recording_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The recording date, YYYY-MM-DD. Null when the county carries none. document_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The document date of a recorded instrument, YYYY-MM-DD. Null on an open position, and when the county carries none. due_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The due date, YYYY-MM-DD. Null when the county carries none. loan_amount: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The amount of the loan, whole US dollars. Null when the county carries none. amount_outlier: description: >- True when the amount is above 5,000,000: out of every sum, never out of a count. Null when the amount is null. type: - boolean - 'null' current_balance: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The estimated balance of an open position, whole US dollars. Null on a recorded instrument, and when the county carries none. balance_outlier: description: >- True when the balance is above 5,000,000. Null when the balance is null. type: - boolean - 'null' interest_rate: description: The rate, percent. Null when the county carries none. type: - number - 'null' interest_rate_type: description: >- The rate type of a recorded instrument as the county wrote it. Null when the file carries none. type: - string - 'null' estimated_payment: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The estimated payment of an open position, whole US dollars. Null when the county carries none. term_months: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The term of the loan in months as the county wrote it. Null when the file carries none. months: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The term in months: term_months when the county gave one, else the months from the recording to the due date. Null when the file carries none. term_band: type: string enum: - unknown - le_24m - 25_to_120m - 121_to_359m - ge_360m description: >- The term of the loan in months, banded: unknown, le_24m, 25_to_120m, 121_to_359m, ge_360m. loan_type: description: >- The loan type as the county wrote it. Null when the county carries none or wrote Unknown. type: - string - 'null' loan_type_code: description: The code of the loan type. Null when the file carries none. type: - string - 'null' financing_type: description: >- The financing type of an open position as the county wrote it. Null when the file carries none. type: - string - 'null' label: anyOf: - type: string enum: - refi_or_second - heloc - resale_purchase_money - new_purchase_money - construction - non_residential description: >- The label of the county for the transaction, mapped to a closed list. A label never sets a purpose: the county stopped labelling purchases in 2022. - type: 'null' description: >- The label of the county, mapped. Null when the county wrote none, or a word outside the list. label_as_recorded: description: >- The label of the county as it wrote it. Null when the file carries none. type: - string - 'null' product: type: string enum: - construction - heloc - other description: >- The product of the loan, a reading of two flags of the county and the loan type: construction, heloc or other. product_basis: anyOf: - type: string enum: - file - term - type: 'null' description: >- file: the county gave the term. term: the due date gave the months. Null when the months are unknown. product_proxy: anyOf: - type: string enum: - bridge - rental_term - retail - type: 'null' description: >- A reading of the product other by its term. bridge: 24 months or under. rental_term: 360 months or over with a hard-money lender of record. retail: the rest. Null when the months are unknown. purpose_of_loan: description: >- The purpose of an open position as the county wrote it. Null when the file carries none. type: - string - 'null' heloc: description: >- The credit-line flag of an open position. Null on a recorded instrument. type: - boolean - 'null' construction_loan: description: >- The construction flag of an open position. Null on a recorded instrument. type: - boolean - 'null' standalone_refi: description: >- The standalone-refinance flag of an open position. Null on a recorded instrument. type: - boolean - 'null' cash_purchase: description: >- The cash-purchase flag of an open position as the county carries it. Null on a recorded instrument. type: - boolean - 'null' adjustable_rate_rider: description: >- The adjustable-rate flag of an open position. Null on a recorded instrument. type: - boolean - 'null' ltv: description: >- The loan-to-value of an open position, percent. Null on a recorded instrument, and when the county carries none. type: - number - 'null' blanket: anyOf: - $ref: '#/components/schemas/LeanLoanBlanket' - type: 'null' description: The blanket group of the loan. Null when the loan is on one parcel. link: anyOf: - $ref: '#/components/schemas/LeanLoanLink' - type: 'null' description: >- The links of the loan to the deeds of its parcel: its purpose, the purchase it financed and its outcome. Null while the state has no loan links. borrowers: type: array items: $ref: '#/components/schemas/LeanLoanBorrower' description: >- The borrowers of the loan: the names of the recorded instrument, or the owner of record on an open position with none. A name that reads as a person is not served here. Empty while the state has no linkage table. as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the financing slice of the state, YYYY-MM-DD. Null while the state has no financing slice. parcel: type: object properties: line: description: >- The street line of the parcel. Null when the parcel has no street line, and while the property is listed on the Investorlift marketplace: see address_held_back. type: - string - 'null' unit: description: >- The unit. Null when the parcel has none, and while the property is listed on the Investorlift marketplace. type: - string - 'null' city: description: The city. Null when the file carries none. type: - string - 'null' zip: description: The 5-digit ZIP. Null when the file carries none. type: - string - 'null' county_fips: description: The county, 5 digits. Null when the file carries none. type: - string - 'null' apn: description: >- The assessor parcel number. Null while the property is listed on the Investorlift marketplace: see address_held_back. type: - string - 'null' latitude: anyOf: - type: number minimum: -90 maximum: 90 description: WGS84 latitude. - type: 'null' description: >- WGS84 latitude of the parcel. An approximate value while the property is listed on the Investorlift marketplace: see location_radius_m. Null when the parcel has no point. longitude: anyOf: - type: number minimum: -180 maximum: 180 description: WGS84 longitude. - type: 'null' description: >- WGS84 longitude of the parcel. An approximate value while the property is listed on the Investorlift marketplace: see location_radius_m. Null when the parcel has no point. address_held_back: description: >- The reason that the API holds the address of the property back. The value listed_on_investorlift means that a wholesaler lists the property on Investorlift now, and the deed records show no transfer after the listing. Then the street line, the unit and the APN are null, and the point is approximate. Null for each other property. type: - string - 'null' location_radius_m: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The radius in metres of the circle to draw around latitude and longitude: 1200 while the property is listed on Investorlift. The circle always contains the true point. Null when the point is exact, and when the row has no point. required: - line - unit - city - zip - county_fips - apn - latitude - longitude - address_held_back - location_radius_m additionalProperties: false description: >- The parcel of the loan from the place index, under the listed-address rule. A property listed on the Investorlift marketplace now serves no street line and an approximate point. required: - loan_key - property_id - source - position - is_instrument - in_both - lender - lender_name_as_recorded - assigned_lender_name - lender_open - lender_disagrees - recording_date - document_date - due_date - loan_amount - amount_outlier - current_balance - balance_outlier - interest_rate - interest_rate_type - estimated_payment - term_months - months - term_band - loan_type - loan_type_code - financing_type - label - label_as_recorded - product - product_basis - product_proxy - purpose_of_loan - heloc - construction_loan - standalone_refi - cash_purchase - adjustable_rate_rider - ltv - blanket - link - borrowers - as_of - parcel description: One loan of a lender with its parcel. Page: type: object properties: next_cursor: description: >- Opaque cursor for the next page: pass it back as cursor= with the same query. Null on the last page. type: - string - 'null' limit: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The page size the API applied. returned: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Rows in this page. required: - next_cursor - limit - returned additionalProperties: false description: >- Pagination: the page size, the rows returned and the cursor for the next page. Paged lists carry no total. The summary block does. LeanMeta: type: object properties: generated_at: type: string format: date-time description: >- When the API produced this response, ISO 8601. It does not change the ETag. weights: description: >- The effective match weights, one per factor, rounded to 4 decimals (buyers/match only). The API rescales the weights of the scored factors to sum 1 before it reports them. type: object propertyNames: type: string additionalProperties: type: number reference_point: description: >- The point the API measures every distance in the response from: lat + lng, or the centre of the property_id parcel. Absent with a bare bbox. type: object properties: lat: type: number minimum: -90 maximum: 90 description: Latitude of the reference point. lng: type: number minimum: -180 maximum: 180 description: Longitude of the reference point. required: - lat - lng additionalProperties: false geometry: $ref: '#/components/schemas/MetaGeometry' description: >- The location that ran, defaults filled and keyed as the query is (see MetaGeometry), on REST only: the MCP meta carries reference_point alone. Present on every route that takes a location: the deal lists, summary and cells, the investors, wholesale listings and short-term rental parcels, and `/v1/buyers/match`. Also on the comps of a parcel, kind radius around the subject and property_id the subject, and on POST `/v1/properties/search` (a county-only body echoes nothing). The lender list and a lender's loans carry it when you gave a geometry, a zip or a city. They apply a geometry as the H3 res-8 cells whose centre lies inside it, and echo no county, because MetaGeometry has no county slot. Absent on a route with no location, and on `/v1/properties/resolve`, whose lat + lng is a hint for the nearest parcel, not an area that ran. resolved_from: description: >- Present when the id in the path was an old id of an earlier build: the ids the API followed through the alias table, in order. Store the id the response carries. type: array items: type: string coverage: type: array items: $ref: '#/components/schemas/Coverage' description: >- The markets the response draws on, with their counties, data end dates and data versions. dated: description: >- Present when the response carries a block that is a dated snapshot at its as-of date, not current data. Those blocks are the financing, lien and valuation blocks of the parcel products. One entry per dated block, with its as-of date. Absent when nothing in the response is dated. type: array items: $ref: '#/components/schemas/Dated' terms: type: string description: Attribution and data-use terms for the data in this response. build: type: object properties: states: type: array items: $ref: '#/components/schemas/LeanBuildState' description: Every served state, in state order. required: - states additionalProperties: false description: >- The publishes behind the response. The ETag and each cursor follow the newest publish, so a publish ends every cursor. The rows belong to no market of the deed registry, so meta.coverage is empty. required: - generated_at - coverage - terms - build additionalProperties: false description: >- Response metadata of the lean family: when the API produced it, and the publishes behind the rows. Problem: type: object properties: type: type: string description: >- URI of the problem: the Errors page of the documentation site, anchored at the code. title: type: string description: Short human-readable summary of the problem code. status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status. code: type: string description: >- Stable machine-readable code from the catalogue at https://developers.investorlift.com/problems.json. detail: type: string description: Human-readable explanation specific to this occurrence. instance: type: string description: Request path. request_id: type: string description: Request id to quote when you report a problem. errors: description: Per-parameter validation failures (400 only). type: array items: type: object properties: param: description: >- The offending parameter. Null when the problem is not about one parameter. type: - string - 'null' message: type: string description: What is wrong with it. code: type: string description: Machine-readable reason, for example invalid_enum_value. required: - param - message - code additionalProperties: false description: One validation failure. required: - type - title - status - code - detail - instance - request_id additionalProperties: {} description: >- RFC 9457 problem details (application/problem+json). Some codes add extra fields beside these: superseded_by, candidates, n_deals, cap, suggestion, markets, retry_after. LeanLenderRef: type: object properties: org_id: anyOf: - type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The organization id: the state, a colon and the anchor entity number for a registry organization, for example AZ:L16090024. For a deed name that no entity matched: the state, a colon, the word name, a colon and the name key, for example AZ:name:ACME HOLDINGS. The id is stable across builds while the anchor entity stays. - type: 'null' description: >- The lender organization: the key to `GET /v3/lenders/{id}` and `GET /v3/orgs/{id}`. Null when the loan names no lender, or when the name reads as a person. org_name: description: The display name of the lender. Null when withheld with the id. type: - string - 'null' from_registry: description: >- True for an organization of the business registry, false for a deed name. Null when withheld. type: - boolean - 'null' tags: type: array items: type: string enum: - government - bank - credit_union - trust - person - hard_money - institution description: >- 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. description: >- The tags of the lender, in the order of the enum. Empty when withheld. required: - org_id - org_name - from_registry - tags additionalProperties: false description: >- A lender organization as a loan row, a ranking row or a parcel block names it, under the name rule of the set. LeanLoanBlanket: type: object properties: group_id: type: string description: >- The id of the blanket group: one lender, one recording date and one amount on five parcels or more. n_parcels: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The parcels of the group. required: - group_id - n_parcels additionalProperties: false description: >- The blanket group of a loan, when the same instrument covers several parcels. LeanLoanLink: type: object properties: purpose: type: string enum: - purchase - not_purchase - unknown description: >- purchase: a priced arm's-length purchase of the parcel is dated inside the 45 days up to the recording. not_purchase: the parcel has a priced deed and its first deed is older than that window. unknown: the loan has no date, or the parcel no deed to read. deed_deal_id: description: >- The purchase deed of a purchase loan: the key to `GET /v3/deals/{id}`. Null on another purpose, and when that deed is no flagged purchase. type: - string - 'null' deed_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The date of that deed, YYYY-MM-DD. Null on another purpose. deed_price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: The price of that deed, whole US dollars. Null on another purpose. loan_to_price: description: >- The amount of the loan over the price of the deed, to four decimals. Null on another purpose, when the loan has no amount, and above three on a loan of one parcel. A blanket group keeps a ratio above three. type: - number - 'null' sale_mtg_match: description: >- True when the last-sale mortgage of the county record carries the date and the amount of this loan. Null when the loan has no date or no amount. type: - boolean - 'null' deal: anyOf: - $ref: '#/components/schemas/LeanLoanLinkDeal' - type: 'null' description: >- The flagged purchase the loan financed. Null when the build linked none. outcome: anyOf: - type: string enum: - foreclosed - resolved_by_resale - refinanced - open - unknown description: >- The outcome of a loan linked to a deal. foreclosed: a take-back deed more than 90 days after the recording, before any resale or refinance. resolved_by_resale: a priced resale of the parcel. refinanced: another loan on the parcel more than 45 days after. open: an open position and no later event. unknown: a recorded instrument alone and no later event. - type: 'null' description: The outcome of the loan. Null when the loan is linked to no deal. resolved_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the resolution, YYYY-MM-DD. Null while open or unknown, and when unlinked. months_to_resolution: description: >- The months from the recording to the resolution, one decimal. Null as resolved_on. type: - number - 'null' foreclosed: anyOf: - $ref: '#/components/schemas/LeanLoanForeclosure' - type: 'null' description: >- The take-back deed that followed the loan on its parcel, past the 90-day floor and before any resale or refinance, on every dated loan. Null when none. required: - purpose - deed_deal_id - deed_date - deed_price - loan_to_price - sale_mtg_match - deal - outcome - resolved_on - months_to_resolution - foreclosed additionalProperties: false description: >- The links of a loan to the deeds of its parcel: its purpose, the purchase it financed and its outcome. LeanLoanBorrower: type: object properties: name: description: >- The name of the borrower: the name on the instrument, or the owner of record on an open position. This host serves null here for a person when the name reads as a person. A company name is served to every key. type: - string - 'null' org_id: anyOf: - type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The organization id: the state, a colon and the anchor entity number for a registry organization, for example AZ:L16090024. For a deed name that no entity matched: the state, a colon, the word name, a colon and the name key, for example AZ:name:ACME HOLDINGS. The id is stable across builds while the anchor entity stays. - type: 'null' description: >- The organization the name matched: the key to `GET /v3/orgs/{id}`. Null when the build matched none. org_name: description: The display name of that organization. Null when org_id is null. type: - string - 'null' from_registry: description: >- True when the organization is one of the business registry. Null when org_id is null. type: - boolean - 'null' match_basis: description: >- How the name matched: filed, former, principal or none. Null when the build matched none. type: - string - 'null' company_like: description: >- True when the name reads as a company. Null when the file carries none. type: - boolean - 'null' tags: type: array items: type: string description: >- The tags of the name: a bank, a builder, a government body, a trust, an iBuyer. Empty when none. borrower_basis: type: string enum: - owner_of_record - deed - registry - party - mortgage_only description: >- Where the build saw the borrower key, the first that holds. owner_of_record: the owner of the parcel on the recording date, on an open position with no instrument. deed: a buyer of the financed deal. registry: an entity or a principal matched. party: a name on some deed of the state. mortgage_only: the instrument alone. required: - name - org_id - org_name - from_registry - match_basis - company_like - tags - borrower_basis additionalProperties: false description: >- One borrower of a loan: the name under the party rule of the set, the organization it matched and where the build saw the key. MetaGeometry: type: object properties: kind: type: string enum: - radius - bbox - place description: >- Which location ran: radius, bbox or place. A radius uses a point, a parcel ID, or a resolved address. A bbox is a viewport. A place is a ZIP list or a postal city. lat: anyOf: - type: number minimum: -90 maximum: 90 description: WGS84 latitude. - type: 'null' description: >- The centre of the radius, or the reference point you gave beside a bbox or a place. For a property_id request the centre is the parcel centroid. Null when a bbox or a place had no reference point. lng: anyOf: - type: number minimum: -180 maximum: 180 description: WGS84 longitude. - type: 'null' description: The longitude beside lat. Null when lat is null. radius_miles: description: >- The radius that ran, in miles: the value you sent, or the default when you sent none. The default is 2 on the GET lists and 1 around property_id on POST `/v1/properties/search`. Null for a bbox or a place. type: - number - 'null' bbox: anyOf: - type: array prefixItems: - type: number minimum: -180 maximum: 180 description: West edge (longitude). - type: number minimum: -90 maximum: 90 description: South edge (latitude). - type: number minimum: -180 maximum: 180 description: East edge (longitude). - type: number minimum: -90 maximum: 90 description: North edge (latitude). items: false minItems: 4 maxItems: 4 description: '[west, south, east, north] in WGS84 degrees.' - type: 'null' description: >- The viewport as [west, south, east, north] in WGS84 degrees. Null unless kind is bbox. property_id: anyOf: - type: string pattern: ^prop_[0-9a-f]{32}$ description: >- Parcel id: prop_ followed by 32 hex characters, for example prop_e93c776c53354a88de4e58448a6bf21b. The prefix is part of the id. - type: 'null' description: >- The parcel at the centre of the radius. Null unless the request named property_id. address: description: >- Resolved situs line for an address search. Null for other location forms. This field describes the resolved parcel. type: - string - 'null' zip: anyOf: - type: array items: type: string pattern: ^\d{5}$ - type: 'null' description: >- The ZIP list as you sent it, for example ["85251", "85257"]. Null unless kind is place and the request named ZIPs. city: description: >- The postal city as the API compared it: trimmed and folded to upper case ("Scottsdale" ran as "SCOTTSDALE"). Null unless kind is place and the request named a city. type: - string - 'null' location_radius_m: description: >- Present when the property at the centre is listed on Investorlift. Then lat and lng are an approximate point, address is null, and this value is the radius in metres of the circle that contains the true point. The API measures each distance from the true point. anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' required: - kind - lat - lng - radius_miles - bbox - property_id - address - zip - city additionalProperties: false description: >- The location the API computed the response over, as it ran: defaults filled, a parcel resolved to its centroid, a city folded. Copy it back as the query to repeat the request. Coverage: type: object properties: market: type: string description: Market code, for example phx. One entry per loaded market. state: type: string description: >- 2-letter state of the market. The loaded markets and their states are in meta.coverage[]. counties: type: array items: type: object properties: fips: type: string description: The 5-digit county FIPS code, for example 04013. name: type: string description: County name, for example Maricopa. data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last deed date on file for this county, YYYY-MM-DD. Null when the county carries no dated deed. required: - fips - name - data_end additionalProperties: false description: One county the loaded area lies in. description: >- The counties the loaded area lies in, each with its own data end date. For a zip market the list names the county, but the loaded area is only the ZIP (see universe_kind). bbox: type: array prefixItems: - type: number minimum: -180 maximum: 180 description: West edge (longitude). - type: number minimum: -90 maximum: 90 description: South edge (latitude). - type: number minimum: -180 maximum: 180 description: East edge (longitude). - type: number minimum: -90 maximum: 90 description: North edge (latitude). items: false minItems: 4 maxItems: 4 description: >- The rectangle (west, south, east, north) that encloses every deal in the market: the initial map viewport and, with point_tolerance_miles, the limit for outside_coverage. data_end: type: string format: date description: >- The last deed date in the data, YYYY-MM-DD. The API measures every "days since" value from this data_end, never from the request time. build_run_id: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Which pipeline build produced the data. Informational: use dataset_version for caching. Null when the data does not record it. registry_run: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Which investor registry run produced the data. Informational: use dataset_version for caching. Null when the data does not record it. registry_version: description: >- Which registry code version produced the data. Informational: use dataset_version for caching. Null when the data does not record it. type: - string - 'null' dataset_version: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Version of the loaded data, an integer that grows with every refresh. It is the cache key and the ETag, and every cursor binds to it. loaded_at: type: string format: date-time description: When this data version went live, ISO 8601. metro_buy_to_resale_ratio: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The median of purchase price divided by resale price over the market's priced flips since 2021. For example, 0.72 means flippers pay about 72% of the resale price. The price_fit factor uses it when an investor has too few flips of their own. Null when no priced flips exist. universe_kind: anyOf: - type: string enum: - zip - county - metro description: >- The area every count in this market covers: metro, county or zip. A metro market covers whole counties. A county market covers one county. The market cannot see what an investor did in the neighbouring counties. A zip market covers one or more ZIP codes. The market cannot see what an investor did outside them, a larger gap. In a county or zip market every investor count, price band, scale tier and confidence is a floor. - type: 'null' description: >- Null when the market row does not record it, a seed older than the column. The area every count in this market covers: metro, county or zip. A metro market covers whole counties. A county market covers one county. The market cannot see what an investor did in the neighbouring counties. A zip market covers one or more ZIP codes. The market cannot see what an investor did outside them, a larger gap. In a county or zip market every investor count, price band, scale tier and confidence is a floor. universe_zips: anyOf: - type: array items: type: string description: A 5-digit ZIP. - type: 'null' description: >- The ZIP codes of a zip universe, for example ["77088"]. Null for county and metro markets. point_tolerance_miles: type: number description: >- How far outside bbox a point can lie and get an answer, in miles: 20 for a metro, 2 for a county market. The point is lat + lng, or the centre of a property_id parcel. Farther out, the API answers 422 outside_coverage. A bbox must intersect the coverage bbox. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels in the loaded area, the universe every count covers. Null when the data does not record it. listings_data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The as-of date of the MLS listing feed for this market, YYYY-MM-DD: the newest status update among its listing rows, later than data_end. The deeds and the listings arrive in one delivery, each with its own end. The API measures every listing window (days_on_market, n_listed_12m) against this date. Null when this market has no published listing tables. Every listing block and listings rollup is null then, and the correct reading is "no listing data". agents_data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The as-of date of the listing set behind the agent registry of this market, YYYY-MM-DD. It equals listings_data_end when the registry is current. It is earlier when a refresh moved the listings but left the agents on the older set. Null when this market has no published agent tables. Then every agent_id, identity_basis and agent_is_holder_member on the listing agents is null, and the investor profile carries has_licensed_member and agent_links null. The /v1/agents routes then answer 422 agents_unavailable. wholesale_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the Investorlift export behind the market's wholesale transactions, YYYY-MM-DD. Every Investorlift listing published up to this date is on file. The API measures every wholesale window (n_listed_12m, n_bought_via_investorlift_12m) against the deed data_end. Null when this market has no published wholesale tables. Then every wholesale_listing block on deal rows, wholesale_purchases block on investor rows and wholesale_listings[] on a parcel is null. Then /v1/wholesale-listings, /v1/wholesalers, `/v1/investors/{id}/wholesale-purchases` and the source=investorlift and bought_on_investorlift filters answer 422 wholesale_unavailable. str_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The short-term rental snapshot of this market, YYYY-MM-DD: the oldest snapshot date among its served jurisdictions. Each jurisdiction's own date is in str.jurisdictions[].snapshot_date and on every block as data_as_of. Null when this market has no published short-term rental tables, or when the API serves none of its jurisdictions. Then every short_term_rental block on parcels and hold rows and every str roll-up on investor rows is null. Then the str_status, str_business_use, str_operator and str_holdings_min filters and /v1/str-parcels answer 422 str_unavailable. str: anyOf: - type: object properties: jurisdictions: type: array items: $ref: '#/components/schemas/StrCoverageJurisdiction' description: >- Every city of the market the short-term rental build knows, served or not. This list, not the parcel, explains a null block on a parcel: read the city's coverage_reason. required: - jurisdictions additionalProperties: false - type: 'null' description: >- The short-term rental jurisdiction table of this market. Null when this market has no published short-term rental tables. auction_counted: type: boolean description: >- True when this market measures the foreclosure-auction and REO purchase counts. Then every investor row carries the auction block (investor.auction) and deal rows carry bought_auction_kind. False when the market's registry build came before the counts existed. Then the block is null on every investor of the market, and bought_auction_kind is null on every deal. The buys_at_auction, buys_reo and bought_auction_kind filters then answer 422 auction_unavailable. parcel_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The deed data end that the build of the parcel product layer used, YYYY-MM-DD. The layer serves POST /v1/properties/search and the financing, permit and history routes. Null when this market has no published parcel product tables: those routes then answer 422 parcels_unavailable. address_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The deed data end of the address table behind GET /v1/properties/resolve?address, YYYY-MM-DD. Null when this market has no published address table. The address lookup answers 422 addresses_unavailable while no market carries the table. parcel: anyOf: - $ref: '#/components/schemas/ParcelCoverage' - type: 'null' description: >- What the parcel products cover in this market. The parts are the layer, the dated financing slice, the permit snapshot, the Owner Profile block and the history lake with its ZIP set. Null when this market has no published parcel product tables. lenders: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The slice date behind the lender registry, YYYY-MM-DD. It equals parcel.financing.as_of. Null when the registry row does not record it. recordings_through: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest recording date in either source table, YYYY-MM-DD. The API measures every recency on a lender against this date. Null when the registry row does not record it. counties: type: array items: type: string description: A 5-digit county FIPS. description: >- The counties the lender registry covers. A ZIP, city or county outside them answers 422 outside_coverage. history_capture_share: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The share of open lien positions recorded since 2022 that the recorded history also carries within 3 days, 0 to 1. It says how much of the open table the history sees. Null when the registry did not measure it. n_lender_ids: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Lender ids served in the market: the identities with a profile, after the person gate. parcel.financing.n_lenders counts raw spellings, several per id. Null when the registry row does not record it. purchase_measured: type: boolean description: >- True when the market has the deed link. Then the API serves purpose and the deed block on the loan rows, and the purchase-money counts and ranks on the lenders. It also serves the lender list's purpose, investor_only and purchase_desc parameters. False on a registry built before the deed link: every such value is null, and those parameters answer 422 lenders_unavailable. investor_lending_measured: type: boolean description: >- True when the market has the deal link and the borrower match. Then the API serves the deal block, outcome and investor ids on the loan rows, and the investor_lending block on the profiles. It also serves the financing block on deal rows and the financing sidecar on investor profiles. False otherwise: every one of those is null. flips_measured: type: boolean description: >- True when the market measures the flips each lender financed, the flips_financed block on the profiles. False otherwise: the block is null. borrowers_measured: type: boolean description: >- True when the market has the borrower fold. Then the API serves borrower keys on the loan rows, the borrowers block on the profiles, GET `/v1/lenders/{id}/borrowers` and the financed_by and uses_private_lender filters. False otherwise: the block is null, and the route and the filters answer 422 lenders_unavailable. takebacks_measured: type: boolean description: >- True when the registry of this market includes the foreclosure take-backs. That needs the auction deed tables built and the lender members present. Then the API serves the takebacks block on the profiles, the foreclosed block on the loan rows and the FORECLOSED outcome. False otherwise: the block is null on every profile, and foreclosed is null on every loan row. counties_measured: type: boolean description: >- True when the market has more than one loaded county, so a county ranking means something: rankings.n_counties_ranked_first_24m on the profiles. False while the slice covers one county: that count is null. dated: description: >- True when the registry is a snapshot valued at as_of, like the financing slice behind it. The API stamps every value from it in meta.dated[] as the lenders block. Null on a registry row that does not record it, a row older than the column. type: - boolean - 'null' n_parcels_uncovered: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels of the market outside the counties the registry covers. Such a county is one the financing slice does not reach. Null when the row does not record it. required: - as_of - recordings_through - counties - history_capture_share - n_lender_ids - purchase_measured - investor_lending_measured - flips_measured - borrowers_measured - takebacks_measured - counties_measured - dated - n_parcels_uncovered additionalProperties: false - type: 'null' description: >- The lender registry of this market. Null when this market has no published lender tables: every /v1/lenders route then answers 422 lenders_unavailable. required: - market - state - counties - bbox - data_end - build_run_id - registry_run - registry_version - dataset_version - loaded_at - metro_buy_to_resale_ratio - universe_kind - universe_zips - point_tolerance_miles - n_parcels - listings_data_end - agents_data_end - wholesale_as_of - str_as_of - str - auction_counted - parcel_as_of - address_as_of - parcel - lenders additionalProperties: false description: >- One loaded market: the area its counts cover (universe_kind), the counties it lies in, how fresh it is, and its data version. Dated: type: object properties: block: type: string enum: - valuation - financing - liens - lenders description: >- The block of the response that is a snapshot at as_of, not current data. The values are valuation (the AVM, equity and LTV), financing (open liens and mortgage history), liens (involuntary liens) and lenders. The lenders block is the lender registry and every count on it, built from the same slice. as_of: type: string format: date description: >- The date of the delivery that valued the snapshot, YYYY-MM-DD: the same date as meta.coverage[].parcel.financing.as_of for the market. reason: type: string description: >- Why the block is dated, in one sentence: the dataset is not in the current delivery. required: - block - as_of - reason additionalProperties: false description: >- One block of the response that is a dated snapshot. Every response that carries a value from a dated block lists it here. A caller that cannot use dated data passes require_current: true. The API then answers 422 dated_refused instead. LeanBuildState: type: object properties: state: type: string pattern: ^[A-Z]{2}$ description: The 2-letter state code of a served state, for example AZ. build_id: description: >- The id of the build of the files, a hash of the recorded steps. Null while the files of the state are a trial and no build id exists. type: - string - 'null' built_at: anyOf: - type: string format: date-time description: Timestamp, ISO 8601. - type: 'null' description: >- When the last step of the build finished, ISO 8601. Null while the files carry no record. published_at: type: string format: date-time description: When the publish of the state wrote the served tables, ISO 8601. run_id: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The id of the publish that serves the rows of the state. It moves with each publish. financing_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the financing slice of the state, the newest applied drop of the county records: the clock of every lender window, YYYY-MM-DD. Null while the state has no financing slice. recordings_through: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest recording date of a loan of the slice, YYYY-MM-DD. Null while the state has no financing slice. financing_source: description: >- Where the financing slice came from: replay_887 for the replay of the archive of the feed, weekly when the weekly delivery carries the domains again. Null while the state has no financing slice. type: - string - 'null' required: - state - build_id - built_at - published_at - run_id - financing_as_of - recordings_through - financing_source additionalProperties: false description: >- One served state: its build, its publish and the dates of its financing slice. LeanLoanLinkDeal: type: object properties: deal_id: type: string description: 'The financed deal: the key to `GET /v3/deals/{id}`.' sale_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The date of its deed, YYYY-MM-DD. Null when the deed carries none. link_window: type: string enum: - strict - loose description: >- strict: the loan is recorded inside 45 days after the sale of the deal. loose: inside 15 days before to 90 days after, on a deal that is no pair and no marketplace closing. is_purchase_loan: type: boolean description: >- True when this loan is the purchase loan of the deal: the strict one first, then the largest. secondary_loans_n: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The other strict loans of the deal, on the purchase loan alone. Null on another loan. buyer: $ref: '#/components/schemas/LeanLinkBuyerRef' description: >- The buyer organization of the deal as the deed names it, under the party rule of the set. required: - deal_id - sale_date - link_window - is_purchase_loan - secondary_loans_n - buyer additionalProperties: false description: >- The flagged purchase a loan financed, and the place of the loan among the loans of that purchase. LeanLoanForeclosure: type: object properties: instrument: type: string enum: - trustees_deed - sheriffs_deed - deed_in_lieu - certificate_of_title description: >- The take-back deed: a trustee's deed, a sheriff's deed (Arizona and Washington), a deed in lieu of foreclosure, or the Florida certificate of title. deed_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the take-back deed, YYYY-MM-DD. Null when the deed carries none. buyer_is_lender: description: >- True when a grantee of the take-back deed is a spelling of the lender of record: a performance proxy, never delinquency. Null when the file carries none. type: - boolean - 'null' required: - instrument - deed_date - buyer_is_lender additionalProperties: false description: The take-back deed that followed a loan on its parcel. StrCoverageJurisdiction: type: object properties: name: type: string description: >- The jurisdiction, upper case, for example SCOTTSDALE, PHOENIX or HOUSTON: the city-limit polygon the parcel falls in, never the postal city. The same value as short_term_rental.coverage.jurisdiction on the parcels inside it. regime: anyOf: - type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN description: >- The city's rule on a short-term rental licence or permit. REQUIRED: an ordinance requires one. NOT_REQUIRED: the city has no requirement, so no roll exists. UNKNOWN: the survey did not cover the city. Null when the market row does not record it. - type: 'null' description: >- Null when the market row does not record it. The city's rule on a short-term rental licence or permit. REQUIRED: an ordinance requires one. NOT_REQUIRED: the city has no requirement, so no roll exists. UNKNOWN: the survey did not cover the city. Null when the market row does not record it. coverage_reason: anyOf: - type: string enum: - LOADED_SERVED - LOADED_UNVALIDATED - LOADED_COUNTS_ONLY - REQUIRED_NOT_PUBLISHED - NO_REQUIREMENT - NOT_SURVEYED description: >- Why parcels of this jurisdiction carry, or do not carry, a short-term rental block. LOADED_SERVED: the city's roll is on file, matched to parcels and served, so every parcel inside carries a block, NONE when it has no record. LOADED_UNVALIDATED: the roll is on file and matched, but without a spot check, so the block is present with status null and coverage.served false. LOADED_COUNTS_ONLY: the roll is on file for counts only, because no parcel match is possible for the file, so no block. No block for REQUIRED_NOT_PUBLISHED (licence required, no roll published), NO_REQUIREMENT (no licence required) or NOT_SURVEYED (outside the survey). Null when the market row does not record it. - type: 'null' description: >- Null when the market row does not record it. Why parcels of this jurisdiction carry, or do not carry, a short-term rental block. LOADED_SERVED: the city's roll is on file, matched to parcels and served, so every parcel inside carries a block, NONE when it has no record. LOADED_UNVALIDATED: the roll is on file and matched, but without a spot check, so the block is present with status null and coverage.served false. LOADED_COUNTS_ONLY: the roll is on file for counts only, because no parcel match is possible for the file, so no block. No block for REQUIRED_NOT_PUBLISHED (licence required, no roll published), NO_REQUIREMENT (no licence required) or NOT_SURVEYED (outside the survey). Null when the market row does not record it. served: type: boolean description: >- True when parcels inside this jurisdiction carry a measured status (LICENSED, PENDING, EXPIRED or NONE). False when they carry a block with status null, or no block at all: coverage_reason says why. snapshot_only: type: boolean description: >- True when the roll came from a single pull and has no weekly feed (Fountain Hills, Cave Creek). Its dates are the pull date, and the API never sets feed_stale. licence_start: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The earliest possible date of a licence in this jurisdiction, the day its ordinance took effect, YYYY-MM-DD, for example 2025-10-01 for Houston. Null when unknown, or when the city requires no licence. snapshot_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The snapshot the served blocks read, YYYY-MM-DD: short_term_rental.data_as_of on every parcel inside. Null when no roll is on file. feed_stale: type: boolean description: >- True when this week's feed failed the freshness rule and the API serves the last good snapshot instead. Every block inside then carries coverage.feed_stale true. False otherwise. sources: type: array items: $ref: '#/components/schemas/StrCoverageSource' description: >- The city files behind this jurisdiction, each with its newest load date and its stale flag. Empty when no roll is on file. n_licensed: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels inside with status LICENSED on this snapshot. Null when no roll is on file. n_pending: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Parcels inside with status PENDING. Null when no roll is on file. n_expired: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Parcels inside with status EXPIRED. Null when no roll is on file. n_advertised: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels the city lists as advertised without a licence, Scottsdale only. The API counts them and never serves them as a status. Null when the city publishes no such list. share_unmatched: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The share of the city's records that matched no parcel, 0 to 1, for example 0.04. Null when no roll is on file. share_assumed: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The share of attributed parcels with attribution_basis ASSUMED, 0 to 1. ASSUMED means the attribution has no date, no name and no regime bound. Null when no roll is on file. required: - name - regime - coverage_reason - served - snapshot_only - licence_start - snapshot_date - feed_stale - sources - n_licensed - n_pending - n_expired - n_advertised - share_unmatched - share_assumed additionalProperties: false description: >- One city of the market in the short-term rental build. It says if the licence roll is on file and served, how fresh it is, and what it counts. It explains a null short_term_rental block on a parcel: the block is null where the API does not serve the jurisdiction. ParcelCoverage: type: object properties: parcel_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The deed data end that the parcel layer build used, YYYY-MM-DD. Null when the coverage row does not record it. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels in the layer for this market. Null when the coverage row does not record it. sale_mortgage_measured: type: boolean description: >- True when the delivery records a purchase mortgage on at least one priced last sale in five of the market. Then cash_sale_proxy, the sale.cash_sale filter and the cash-buyer quicklist are measured. False below that bar, as in the 2026 deliveries, which carry the column empty. Then cash_sale_proxy is null on every parcel, and the filter and the quicklist answer 422 cash_sale_unavailable. financing: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the delivery that valued the financing, lien and valuation slice, YYYY-MM-DD. Null when the coverage row does not record it. dated: type: boolean description: >- True while the Recorder & Mortgage and AVM datasets are not in the current delivery, so the slice stays at as_of. The API then stamps every value from the slice in meta.dated[]. dated_reason: description: Why the slice is dated. Null when dated is false. type: - string - 'null' n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with a row in the slice. Null when the coverage row does not record it. n_with_open_lien: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with at least one open lien at as_of. Null when the coverage row does not record it. n_free_and_clear: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with zero open liens at as_of. Null when the coverage row does not record it. n_avm: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with an AVM at as_of. Null when the coverage row does not record it. n_involuntary: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with an involuntary lien at as_of. Null when the coverage row does not record it. n_lenders: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Distinct raw lender spellings over the two lien tables, not registry ids. For registry ids, read meta.coverage[].lenders.n_lender_ids. Null when the coverage row does not record it. required: - as_of - dated - dated_reason - n_parcels - n_with_open_lien - n_free_and_clear - n_avm - n_involuntary - n_lenders additionalProperties: false - type: 'null' description: The financing slice. Null when this market has none. permits: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The effective date of the loaded permit snapshot, YYYY-MM-DD. Null when the coverage row does not record it. n_permits: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Permits served for this market. Null when the coverage row does not record it. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with at least one permit. Null when the coverage row does not record it. n_unmatched: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Permits in the county file that landed on no parcel of the market, so the API does not serve them. Null when the coverage row does not record it. jurisdictions: anyOf: - type: array items: type: object properties: jurisdiction: description: >- The issuing city or county, upper case. Null when the file names none. type: - string - 'null' n_permits: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Permits the jurisdiction issued, all time. Null when the coverage row does not record it. last_issue_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest issue date of the jurisdiction, YYYY-MM-DD. Null when no permit of the jurisdiction carries an issue date. windows_measured: description: >- True when the jurisdiction issued a permit in the 12 months before as_of. False when it did not: its feed is stale, so its parcels carry null 24-month and 36-month windows. The rule applies in every market. Read those null windows (n_permits_24m, n_open_permits_12m, major_work_36m, tags_24m, job_value_24m) as unmeasured, not as permit-free. The negative permit filters of the search leave such parcels out. Null only on a coverage row built before the flag existed. type: - boolean - 'null' required: - jurisdiction - n_permits - last_issue_date - windows_measured additionalProperties: false - type: 'null' description: >- The issuing jurisdictions, largest first, each with its permit count, its newest issue date and its windows_measured flag. Null when the coverage row does not record them. required: - as_of - n_permits - n_parcels - n_unmatched - jurisdictions additionalProperties: false - type: 'null' description: The permit snapshot. Null when this market has none. owner_profile: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the delivery the Owner Profile block comes from, YYYY-MM-DD. Null when the coverage row does not record it. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels carrying a profile. Null when the coverage row does not record it. n_multi: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels whose owner holds two or more properties. Null when the coverage row does not record it. n_portfolio_5: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels whose owner holds five or more. Null when the coverage row does not record it. required: - as_of - n_parcels - n_multi - n_portfolio_5 additionalProperties: false - type: 'null' description: The Owner Profile block. Null when this market has none. history: anyOf: - type: object properties: first_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The first weekly file the history lake replayed (the baseline FULL), YYYY-MM-DD. Null when the lake has no file. last_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last weekly file replayed, YYYY-MM-DD. Null when the lake has no file. zips: anyOf: - type: array items: type: string - type: 'null' description: >- The ZIP codes the history lake covers. A parcel outside them has no history: `GET /v1/properties/{id}/history` answers 422 history_unavailable and the history block is null. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels observed in the ZIP set. Null when the coverage row does not record it. n_events: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Typed events on record. Null when the coverage row does not record it. n_weeks: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Weekly files replayed. Null when the coverage row does not record it. domains: anyOf: - type: object propertyNames: type: string additionalProperties: type: object properties: first_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The first weekly file with the domain, YYYY-MM-DD. Null when the lake has no file for it. last_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last weekly file with the domain, YYYY-MM-DD. Null when the lake has no file for it. n_events: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Typed events of the domain on record. Null when the coverage row does not record it. required: - first_week - last_week - n_events additionalProperties: false - type: 'null' description: >- Per domain, the weeks the lake covers it. Valuation and financing end at the financing slice date, financing.as_of. The rest run to last_week. Null when the coverage row does not record them. required: - first_week - last_week - zips - n_parcels - n_events - n_weeks - domains additionalProperties: false - type: 'null' description: The history lake. Null when this market has none. required: - parcel_as_of - n_parcels - sale_mortgage_measured - financing - permits - owner_profile - history additionalProperties: false description: >- What the parcel products cover in one market. The parts are the parcel layer, the dated financing slice, the permit snapshot, the Owner Profile block and the history lake. Each part carries its as-of date and its counts, and is null where the market has none of it. The block itself is null where the market has no parcel product tables. LeanLinkBuyerRef: type: object properties: org_id: anyOf: - type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The organization id: the state, a colon and the anchor entity number for a registry organization, for example AZ:L16090024. For a deed name that no entity matched: the state, a colon, the word name, a colon and the name key, for example AZ:name:ACME HOLDINGS. The id is stable across builds while the anchor entity stays. - type: 'null' description: >- The buyer organization: the key to `GET /v3/orgs/{id}`. Null when the name reads as a person. org_name: description: The display name of the buyer. Null when withheld with the id. type: - string - 'null' from_registry: description: >- True for an organization of the business registry, false for a deed name. Null when withheld. type: - boolean - 'null' tags: type: array items: type: string description: >- The tags of the organization as a buyer: investor, ibuyer, builder, bank or another tag of the build. Empty when none, and when withheld. required: - org_id - org_name - from_registry - tags additionalProperties: false description: >- The buyer organization of a financed deal, under the party rule of the set. StrCoverageSource: type: object properties: source: type: string description: >- The source code of one city file, for example S1 (the Scottsdale licensed roll), P1 (the Phoenix active permits layer) or COH (the Houston registry). snapshot_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the newest load of this source, YYYY-MM-DD. Null before the first load of this source. stale: type: boolean description: >- True when the newest load failed the freshness rule and the API still serves the previous snapshot. A load fails the rule when the count moved more than 30 percent, or when its newest date is more than 14 days old. required: - source - snapshot_date - stale additionalProperties: false description: >- One city file behind a jurisdiction's short-term rental data: the date of its newest load, and if that load is stale. headers: ETag: description: >- The entity tag of the answer, derived from the dataset version of the markets in the response and from the representation, not from the body. It moves only when a refresh rebuilds the tables of a market. On a JSON route, send it back as If-None-Match, and an unchanged dataset answers 304 with no body. The API streams an export whatever the tag. GET /v1/dataset runs no query, so it is the lowest-cost place to send the tag. On every 2xx and the 304, never on an error. schema: type: string X-Request-Id: description: >- The id of this call. The edge mints it and also sends it as zp-rid, the gateway's own name for it. The API keys its log line for the call on it, and every error body repeats it as request_id. Log it on every response, not only on errors. A refusal the gateway answers itself carries zp-rid and request_id alone. Those refusals are a 401, a 403 quota_exceeded and a 429 at the limit of the plan. schema: type: string X-Rows: description: >- How many rows the body carries: data.length on a list, 1 on a single record. The size of the body, not a charge. Absent on a streamed export, whose count the API knows only when the stream ends, and on a 304. schema: type: integer minimum: 0 X-Dataset-Version: description: >- The dataset version of every market in the response, as market=version pairs joined by commas (phx=1788469819 for one market). The header carries one pair per loaded market. The figures are the same as meta.coverage[].dataset_version, and you can read them without parsing the body. A version moves only when a refresh rebuilds the tables of the market, so fold the label into cache keys. On every 2xx and the 304, never on an error. Absent when the answer names no market: an empty deployment, or a GET /v1/coverage lookup outside every market. schema: type: string X-Data-End: description: >- The last deed date of every market in the response, as market=YYYY-MM-DD pairs joined by commas (phx=2026-08-12 for one market). The header carries one pair per loaded market. The dates are the same as meta.coverage[].data_end. On every 2xx and the 304, never on an error. Absent when the answer names no market: an empty deployment, or a GET /v1/coverage lookup outside every market. schema: type: string Retry-After: description: >- Whole seconds to wait before you retry, never below 1. On a 429, the seconds until the spent bucket refills. On a 503, 1 for pool_saturated and 5 for ledger_unavailable, and none for database_unavailable. On a 403 plan_limit for the name-search day cap, the seconds to the next UTC midnight, when the cap resets. The other plan limits carry none. The body repeats it as retry_after on the 429, the ledger refusal and the day cap. schema: type: integer minimum: 1 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.