> ## 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. # Get one organization of the lean set > Get one organization of the lean set. This route serves the lean set under `/v3/orgs/{id}`. See [The lean dataset](/api-reference/lean) for the tier rules. ## OpenAPI ````yaml GET /v3/orgs/{id} openapi: 3.1.0 info: title: God Mode API version: 0.61.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/orgs/{id}: get: tags: - lean summary: Get one organization of the lean set description: >- One organization of the lean set: its entities of the business registry, the persons that file with them, and its deeds. The entities share a person, an agent or an address, with their status, their former names and their links. The path takes the id of a search hit or a deal row. The profile block has its purchases and sales by rule, its pace, its band and its holds. The marketplace block has its listings as the wholesaler with outcomes. The purchases are on `/v3/orgs/{id}/deals`. A call costs 0 credits. [The lean dataset of the Investorlift Data API](https://developers.investorlift.com/api-reference/lean). operationId: getLeanOrg parameters: - schema: type: string in: path name: id required: true description: The organization id, as a search hit or a deal row carries it. responses: '200': description: One organization. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/LeanOrg' meta: $ref: '#/components/schemas/LeanMeta' required: - data - meta additionalProperties: false description: One organization. example: data: id: AZ:L17142520 kind: registry state: AZ display_name: EVENTUS INTERNATIONAL LLC n_entities: 16 anchor_entity_no: L17142520 anchor_formation_date: '2011-10-18' deals: n_deals: 30 first_deal_date: '2011-11-01' last_deal_date: '2018-01-05' total_price: 7571400 n_sold: 11 n_bought_from: 39 n_sold_to: 17 profile: data_end: '2026-09-17' n_purchases: 37 n_sales: 11 first_purchase_date: '2011-08-16' last_purchase_date: '2022-08-23' last_sale_date: '2024-05-23' n_purchases_12m: 0 n_purchases_24m: 0 n_purchases_36m: 0 is_active: false days_since_last_purchase: 1486 days_since_last_sale: 847 median_gap_days: 32.5 n_resold: 24 n_held: 13 n_quick_resales: 4 n_flips: 2 n_flip_window_other: 2 n_long_holds_sold: 16 n_builds: 0 median_hold_days: 1178 median_spread: 1.543 n_priced_purchases: 33 price_p25: 70000 price_p50: 175000 price_p75: 240000 price_band_window: all n_sfr: 13 n_condo_th: 1 n_other: 23 total_price: 14811420 auction: n_auction_buys: 0 n_auction_buys_24m: 0 last_auction_buy_date: null is_active_auction_buyer: false n_reo_buys: 3 n_reo_buys_24m: 0 last_reo_buy_date: '2013-04-24' is_active_reo_buyer: false entities: - entity_no: L17142520 name: EVENTUS INTERNATIONAL LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2011-10-18' is_foreign: false is_anchor: true former_names: [] agent_name: null principal_address: line1: 644 E. LEHI RD. city: MESA state: AZ zip: '85203' links: - link_class: person link_key: null rule: agent_principal kept: true joined: true drop_reason: null n_entities: 4 - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 4 - link_class: person link_key: null rule: principal kept: true joined: false drop_reason: second_pass_cut n_entities: 9 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - entity_no: L17142531 name: UNITED REALTY M.T.A. LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2011-10-18' is_foreign: false is_anchor: false former_names: - UNITED REALITY MANAGEMENT LLC agent_name: null principal_address: line1: 644 E. LEHI RD. city: MESA state: AZ zip: '85203' links: - link_class: agent link_key: null rule: agent_insider kept: true joined: true drop_reason: null n_entities: 9 - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - entity_no: L19820644 name: COUNTRY CLUB URMTA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2015-02-04' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 644 E LEHI RD city: MESA state: AZ zip: '85203' links: - link_class: agent link_key: null rule: agent_insider kept: true joined: true drop_reason: null n_entities: 9 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - link_class: person link_key: null rule: principal kept: false joined: false drop_reason: company_name n_entities: 5 - entity_no: L19820655 name: BROOKWOOD URMTA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2015-02-04' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 644 E LEHI RD city: MESA state: AZ zip: '85203' links: - link_class: agent link_key: null rule: agent_insider kept: true joined: true drop_reason: null n_entities: 9 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - link_class: person link_key: null rule: principal kept: false joined: false drop_reason: company_name n_entities: 5 - entity_no: L21365278 name: HELPO AUTO LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2016-11-09' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 1868 E. BROADWAY ROAD SUITE118 city: TEMPE state: AZ zip: '85282' links: - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: agent link_key: null rule: agent_outside kept: false joined: false drop_reason: candidate_rule n_entities: 7 - entity_no: L22038051 name: BL MED SPA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2017-07-18' is_foreign: false is_anchor: false former_names: - BLUE LAGOON SPA LLC - BL SPA LLC agent_name: null principal_address: line1: 644 E LEHI RD city: MESA state: AZ zip: '85203' links: - link_class: agent link_key: null rule: agent_insider kept: true joined: true drop_reason: null n_entities: 9 - link_class: person link_key: null rule: principal kept: true joined: false drop_reason: second_pass_cut n_entities: 2 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - entity_no: L22038186 name: PARADISE ON THE MESA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2017-07-18' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 644 E LEHI RD city: MESA state: AZ zip: '85203' links: - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - link_class: agent link_key: null rule: agent_outside kept: false joined: false drop_reason: candidate_rule n_entities: 7 - entity_no: L22038970 name: VIRGINIA URMTA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2017-10-11' is_foreign: false is_anchor: false former_names: - VIRGINA URMTA LLC agent_name: null principal_address: line1: 644 E LEHI RD city: MESA state: AZ zip: '85203' links: - link_class: agent link_key: null rule: agent_insider kept: true joined: true drop_reason: null n_entities: 9 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - link_class: person link_key: null rule: principal kept: false joined: false drop_reason: company_name n_entities: 5 - entity_no: L22048951 name: DEVELOPMENT PROJECTS URMTA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2017-10-11' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 644 E LEHI RD city: MESA state: AZ zip: '85203' links: - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - link_class: agent link_key: null rule: agent_outside kept: false joined: false drop_reason: candidate_rule n_entities: 7 - entity_no: L22602528 name: MINING ALTCOIN URMTA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2018-02-14' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 644 E LEHI RD. city: MESA state: AZ zip: '85203' links: - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - entity_no: '1950417' name: Vacation Rentals URMTA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2019-02-13' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 644 E Lehi Rd city: MESA state: AZ zip: '85203' links: - link_class: person link_key: null rule: agent_principal kept: true joined: true drop_reason: null n_entities: 4 - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 4 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - entity_no: '23066161' name: Bicandy LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2020-02-26' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 644 E Lehi Rd city: MESA state: AZ zip: '85203' links: - link_class: agent link_key: null rule: agent_insider kept: true joined: true drop_reason: null n_entities: 9 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 - entity_no: '23263119' name: Center Mesa URMTA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2021-08-23' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 945 W Juniper city: GILBERT state: AZ zip: '85233' links: - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 4 - link_class: agent link_key: null rule: agent_outside kept: false joined: false drop_reason: candidate_rule n_entities: 9 - entity_no: '23445423' name: Norte URMTA LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2022-11-07' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 5301 E Wonderview rd city: PHOENIX state: AZ zip: '85018' links: - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: address link_key: 5301 E WONDERVIEW RD|85018 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 2 - link_class: agent link_key: null rule: agent_outside kept: false joined: false drop_reason: candidate_rule n_entities: 9 - entity_no: '23455616' name: Northe URFD LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2022-12-05' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 945 West Juniper Ave city: GILBERT state: AZ zip: '85233' links: - link_class: person link_key: null rule: agent_principal kept: true joined: true drop_reason: null n_entities: 4 - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 4 - entity_no: '25056671' name: Breakfast and Burgers @ Brookwood LLC kind: LLC type_as_filed: Domestic Limited Liability Company status: Active formation_date: '2026-05-01' is_foreign: false is_anchor: false former_names: [] agent_name: null principal_address: line1: 644 E Lehi Rd city: Mesa state: AZ zip: '85203' links: - link_class: agent link_key: null rule: agent_insider kept: true joined: true drop_reason: null n_entities: 9 - link_class: person link_key: null rule: principal kept: true joined: true drop_reason: null n_entities: 10 - link_class: address link_key: 644 E LEHI RD|85203 rule: address kept: false joined: false drop_reason: candidate_rule n_entities: 15 people: - person_key: UNITED REALTY MTA|85203 name: UNITED REALTY MTA LLC is_company: true person_id: null roles: null n_deals: null n_listings: null has_licence: null filings: - entity_no: L19820644 title: Member role: member source: principal - entity_no: L19820655 title: Member role: member source: principal - entity_no: L22038970 title: Member role: member source: principal n_agents: 0 marketplace: n_listings: 0 n_closed: 0 n_closed_late: 0 n_open: 0 n_late_window: 0 n_no_deed: 0 n_unresolved: 0 first_published_on: null last_published_on: null n_closings_as_buyer: 0 last_closing_as_buyer_on: null listings: [] addresses: null meta: generated_at: '2026-10-07T20:37:44.149Z' 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-07T19:57:24.579Z' published_at: '2026-10-07T20:29:57.916Z' run_id: 1791403199 - state: CA build_id: null built_at: '2026-09-24T01:58:30.453Z' published_at: '2026-09-24T03:15:56.838Z' run_id: 1790215190 - state: FL build_id: 0e5fa9bc built_at: '2026-09-24T15:08:23.506Z' published_at: '2026-09-24T18:59:42.805Z' run_id: 1790262682 - state: TX build_id: 775ed08d built_at: '2026-09-24T11:08:10.587Z' published_at: '2026-09-24T13:16:03.157Z' run_id: 1790248213 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_id, validation_error) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: 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/orgs/{id} request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 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/orgs/{id} 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/orgs/{id} 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/orgs/{id} 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/orgs/{id} 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/orgs/{id} 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/orgs/{id} 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/orgs/{id} 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/orgs/{id} 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/orgs/{id} 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/orgs/{id} 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/orgs/{id} request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' components: schemas: LeanOrg: type: object properties: id: 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. kind: type: string enum: - registry - deed_name description: >- registry: an organization of the business registry, with entities. deed_name: a name on deeds that no entity matched, with no entity and no filing. state: type: string pattern: ^[A-Z]{2}$ description: The 2-letter state code of a served state, for example AZ. display_name: type: string description: >- The name to print. A business name, or the deed spelling of a deed name. A deed name that reads as a person is not served here: 404 for a deals-only key. n_entities: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The entities of the organization. 0 for a deed name. anchor_entity_no: description: The entity that gives the organization its id. Null for a deed name. type: - string - 'null' anchor_formation_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The formation date of the anchor entity, YYYY-MM-DD. Null when the registry records none, and for a deed name. deals: $ref: '#/components/schemas/LeanOrgDealCounts' profile: anyOf: - $ref: '#/components/schemas/LeanOrgProfile' - type: 'null' description: >- The profile of the organization over every purchase and sale at arm's length, served to every key. Null for an organization with no purchase and no sale at arm's length, and while the state has no profile table. entities: type: array items: $ref: '#/components/schemas/LeanOrgEntity' description: >- The entities, the anchor first, then by formation date. Empty for a deed name. people: type: array items: $ref: '#/components/schemas/LeanOrgPerson' description: >- The persons and the companies that file with the entities, most filings first. A deals-only key gets the companies alone. n_agents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The agents that list for the organization. 0 when none. marketplace: anyOf: - $ref: '#/components/schemas/LeanOrgMarketplace' - type: 'null' description: >- Its listings as the wholesaler and its closings as the buyer on the Investorlift marketplaces. Null while the build of the state has no marketplace match table. addresses: anyOf: - type: array items: $ref: '#/components/schemas/LeanAddress' - type: 'null' description: >- The reach addresses of the organization, the non-generic ones first: the mailing addresses of its deeds and the filed addresses of its entities. This host serves null here for a person. Empty when none. required: - id - kind - state - display_name - n_entities - anchor_entity_no - anchor_formation_date - deals - profile - entities - people - n_agents - marketplace - addresses description: >- One organization: its entities with their filing facts and links, the persons that file with them, its reach addresses, its deeds and its profile. 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. LeanOrgDealCounts: type: object properties: n_deals: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The flagged purchases of the organization, on any side of a deed. 0 when none. first_deal_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The date of its first deed, YYYY-MM-DD. Null when it has no deed. last_deal_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The date of its last deed, YYYY-MM-DD. Null when it has no deed. total_price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The sum of the prices of its purchases, whole US dollars. Null when no purchase carries a price. n_sold: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The deeds on which it sold. Null for a deed name and for a person, whose sales the build does not count. n_bought_from: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The distinct sellers it bought from. Null for a deed name and for a person. n_sold_to: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The distinct buyers it sold to. Null for a deed name and for a person. required: - n_deals - first_deal_date - last_deal_date - total_price - n_sold - n_bought_from - n_sold_to additionalProperties: false description: >- What the organization did on the deeds: its purchases, its sales, its counterparties, in counts. LeanOrgProfile: type: object properties: data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest purchase date of the state, YYYY-MM-DD: the clock of every window and every days count below. Null when the state records no dated purchase. n_purchases: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its purchases at arm's length under every rule, each deed counted once. The flagged purchases of `deals` are a part of them. n_sales: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The deeds on which it sold at arm's length. first_purchase_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its first purchase, YYYY-MM-DD. Null when it sold and never bought. last_purchase_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its last purchase, YYYY-MM-DD. Null when it sold and never bought. last_sale_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its last sale, YYYY-MM-DD. Null when it never sold. n_purchases_12m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its purchases in the 365 days before the data end, the data end included. n_purchases_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its purchases in the 730 days before the data end. n_purchases_36m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its purchases in the 1095 days before the data end. is_active: type: boolean description: True when it bought in the 365 days before the data end. days_since_last_purchase: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The days from its last purchase to the data end. Null when it never bought. days_since_last_sale: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The days from its last sale to the data end. Null when it never sold. median_gap_days: description: >- The median of the days from one purchase date to the next. Null below two distinct purchase dates. type: - number - 'null' n_resold: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its purchases with a later priced deed on the parcel. n_held: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: 'Its purchases with no resale: the open inventory.' n_quick_resales: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its purchases resold in 29 days or less. n_flips: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its purchases resold in 30 to 365 days at a spread of 0.10 to 1.50 over the price. n_flip_window_other: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its purchases resold in 30 to 365 days outside that spread, or with no price on one leg. n_long_holds_sold: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its purchases resold after more than 365 days. n_builds: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its resold purchases whose resale deed carries the new-construction mark and whose purchase deed does not. median_hold_days: description: >- The median days held over its resold purchases. Null when it resold none. type: - number - 'null' median_spread: description: >- The median of the resale price over the price, minus one, over its resold purchases with a price on both legs, to three decimals. Null when none has both. type: - number - 'null' n_priced_purchases: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its purchases with a price of 20,000 US dollars or more. price_p25: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The first quartile of those prices in the band window, whole US dollars. Null when it has no priced purchase. price_p50: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The median of those prices in the band window, whole US dollars. Null when it has no priced purchase. price_p75: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The third quartile of those prices in the band window, whole US dollars. Null when it has no priced purchase. price_band_window: anyOf: - type: string enum: - 5y - all - type: 'null' description: >- The window of the quartiles. 5y: the five years before the data end, when five or more priced purchases fall in them. all: every priced purchase. Null when it has no priced purchase. n_sfr: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its purchases of a single-family home. n_condo_th: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its purchases of a condominium or a town house. n_other: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its purchases of another segment, or of none. total_price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The sum of the prices of its purchases, whole US dollars. Null when no purchase carries a price. auction: anyOf: - $ref: '#/components/schemas/LeanOrgAuction' - type: 'null' description: >- Its auction and REO purchases. Null while the profile of the state predates the auction counts of stage 5. required: - data_end - n_purchases - n_sales - first_purchase_date - last_purchase_date - last_sale_date - n_purchases_12m - n_purchases_24m - n_purchases_36m - is_active - days_since_last_purchase - days_since_last_sale - median_gap_days - n_resold - n_held - n_quick_resales - n_flips - n_flip_window_other - n_long_holds_sold - n_builds - median_hold_days - median_spread - n_priced_purchases - price_p25 - price_p50 - price_p75 - price_band_window - n_sfr - n_condo_th - n_other - total_price - auction additionalProperties: false description: >- The profile of the organization over its purchases and sales at arm's length: the counts by rule, the pace, the price band and the holds. Every figure is a count, a date or a quantile of observed rows, with no kind and no score. LeanOrgEntity: type: object properties: entity_no: type: string description: The registry number of the entity. name: type: string description: >- The name of the entity as filed. A business name, served to every key. kind: description: >- The kind of the entity as the build reads it (a company, a trust, a public body). Null when the file carries none. type: - string - 'null' type_as_filed: description: >- The type of the entity as filed, for example LLC. Null when the file carries none. type: - string - 'null' status: description: >- The status of the entity with the registry. Null when the file carries none. type: - string - 'null' formation_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The formation date, YYYY-MM-DD. Null when the registry records none. is_foreign: description: >- True when the entity is registered in another state. Null when the file carries none. type: - boolean - 'null' is_anchor: type: boolean description: >- True for the anchor entity of the organization, the one that gives it its id. former_names: type: array items: type: string description: The names the entity filed before, oldest first. Empty when none. agent_name: description: >- The name of the statutory agent as filed, a business or a person. This host serves null here for a person. type: - string - 'null' principal_address: type: object properties: line1: description: >- The first line of the principal address as filed. Null when the file carries none. type: - string - 'null' city: description: The city. Null when the file carries none. type: - string - 'null' state: description: The 2-letter state. Null when the file carries none. type: - string - 'null' zip: description: The 5-digit ZIP. Null when the file carries none. type: - string - 'null' required: - line1 - city - state - zip additionalProperties: false description: >- The principal address as filed with the registry, a public filing served to every key. links: type: array items: $ref: '#/components/schemas/LeanOrgLink' description: >- The links of the entity, the joined ones first. Empty for an anchor alone. required: - entity_no - name - kind - type_as_filed - status - formation_date - is_foreign - is_anchor - former_names - agent_name - principal_address - links additionalProperties: false description: >- One entity of the organization, with its filing facts and the links that joined it. LeanOrgPerson: type: object properties: person_key: type: string description: >- The key of the person as the build keyed the filings. A company key for a company that files as a person. name: type: string description: >- The name as filed. A person, not served here: a deals-only key gets no person here, only the companies that file as persons. is_company: type: boolean description: >- True when the filed name is a company, a law firm or an agent service. person_id: anyOf: - type: string pattern: >- ^(person:[0-9a-f]{12}|buyer:[0-9a-f]{12}|[A-Z]{2}:agt:[0-9a-f]{12})$ description: >- The person id: person: and 12 hex characters for a registry profile, buyer: and 12 hex characters for a deed buyer, or the agent id (the state, a colon, agt, a colon and 12 hex characters) for an agent alone. - type: 'null' description: >- The person of the person layer: the key to `GET /v3/people/{id}`. Null when the build joined no profile. roles: anyOf: - type: array items: type: string enum: - agent - buyer - principal description: >- A role of a person. agent: lists for a brokerage. buyer: a deed buyer of a flagged purchase. principal: files with a business registry. - type: 'null' description: The roles of the person. Null when the build joined no profile. n_deals: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The flagged purchases of the person as a buyer. Null when the build joined no profile. n_listings: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The listings of the person as an agent. Null when the build joined no profile. has_licence: description: >- True when the person holds a real-estate licence. Null when the build joined no profile. type: - boolean - 'null' filings: type: array items: $ref: '#/components/schemas/LeanOrgPersonFiling' description: The filings of the person on the entities of the organization. required: - person_key - name - is_company - person_id - roles - n_deals - n_listings - has_licence - filings additionalProperties: false description: >- One person that files with an entity of the organization, with the filings and the profile of the person layer. LeanOrgMarketplace: type: object properties: n_listings: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The listings of the marketplaces whose seller name met the organization: its listings as the wholesaler. n_closed: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its listings with a purchase in the 180 days from the publication. n_closed_late: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its listings with a purchase from 180 to 400 days after the publication, and none before. n_open: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its listings with no purchase yet, inside 180 days of the publication. n_late_window: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its listings with no purchase yet, inside 400 days of the publication. n_no_deed: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its listings with no purchase after the windows. n_unresolved: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its listings whose address met no parcel. first_published_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its first listing, YYYY-MM-DD. Null when it has none. last_published_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its last listing, YYYY-MM-DD. Null when it has none. n_closings_as_buyer: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The listings of any seller whose closing purchase names the organization as the buyer. last_closing_as_buyer_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of its last such purchase, YYYY-MM-DD. Null when it closed none. listings: type: array items: $ref: '#/components/schemas/LeanMarketplaceMark' description: >- Its listings as the wholesaler, the newest 50, each with its outcome. required: - n_listings - n_closed - n_closed_late - n_open - n_late_window - n_no_deed - n_unresolved - first_published_on - last_published_on - n_closings_as_buyer - last_closing_as_buyer_on - listings additionalProperties: false description: >- The organization on the Investorlift marketplaces: its listings as the wholesaler with their outcomes, and its closings as the buyer. LeanAddress: type: object properties: source: type: string enum: - deed_buyer - deed_seller - registry_office - registry_place - registry_agent - registry_filing - roll_mailing description: >- Where the address comes from. deed_buyer and deed_seller: the mailing address the subject gave on a deed, on that side. registry_office, registry_place and registry_agent: the principal office, the known place of business and the statutory agent of an entity of the organization. registry_filing: the address a person filed with on an entity. roll_mailing: the mailing address on the licence roll of the agent of a person. kind: type: string enum: - HOUSE - SUITE - POBOX description: >- The kind of the street line: a house, a suite or a unit, or a PO box. line: type: string description: The street line as written, upper case. city: description: The city as written. Null when the source gives none. type: - string - 'null' state: description: The 2-letter state of the address. Null when the source gives none. type: - string - 'null' zip: description: The 5-digit ZIP. Null when the source gives none. type: - string - 'null' n_rows: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The rows behind the address. Deeds for a deed address, entities for a registry address of an organization, filings for a filing address, 1 for a roll address. first_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The first date behind the address, YYYY-MM-DD: a deed date, or the formation date of an entity. Null for a filing. last_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The last date behind the address, YYYY-MM-DD. Null for a filing. is_generic: type: boolean description: >- True when more than five subjects of the state share the address: a professional office, a registered agent or a mail drop. n_subjects: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The subjects of the state that share the address. required: - source - kind - line - city - state - zip - n_rows - first_date - last_date - is_generic - n_subjects additionalProperties: false description: >- One reach address of an organization or a person, with its source, its kind and the rows behind it. 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. required: - state - build_id - built_at - published_at - run_id additionalProperties: false description: 'One served state: its build and its publish.' LeanOrgAuction: type: object properties: n_auction_buys: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its purchases at a foreclosure auction: a trustee sale or a sheriff sale that passed the five tests of step 06b. n_auction_buys_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The same in the 730 days before the data end. last_auction_buy_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- Its last auction purchase, YYYY-MM-DD. Null when it never bought at auction. is_active_auction_buyer: type: boolean description: >- True when n_auction_buys_24m is 1 or more: the filter auction of the buyers routes. n_reo_buys: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its purchases from a lender, a servicer or an agency after a take-back (REO). n_reo_buys_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The same in the 730 days before the data end. last_reo_buy_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its last REO purchase, YYYY-MM-DD. Null when it never bought REO. is_active_reo_buyer: type: boolean description: >- True when n_reo_buys_24m is 1 or more: the filter reo of the buyers routes. required: - n_auction_buys - n_auction_buys_24m - last_auction_buy_date - is_active_auction_buyer - n_reo_buys - n_reo_buys_24m - last_reo_buy_date - is_active_reo_buyer additionalProperties: false description: >- The purchases of the organization at foreclosure auction and from a lender after a take-back, from step 06b through its profile. LeanOrgLink: type: object properties: link_class: type: string description: >- The class of the link: person, agent, address or another class of the build. link_key: description: >- The key the link joins on. This host serves null here for a person for a person or an agent link. An address key is served to every key. type: - string - 'null' rule: type: string description: The rule of the build that made the link. kept: type: boolean description: True when the link survived the caps of the build. joined: type: boolean description: True when the link joined this entity to its organization. drop_reason: description: Why the link was cut. Null when the link was kept. type: - string - 'null' n_entities: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The entities the key links. Null when the build did not count them. required: - link_class - link_key - rule - kept - joined - drop_reason - n_entities additionalProperties: false description: >- One link of an entity of the organization: what joined it, or what was cut. LeanOrgPersonFiling: type: object properties: entity_no: type: string description: The entity of the filing. title: description: >- The title on the filing, for example MEMBER. Null when the file carries none. type: - string - 'null' role: description: >- The role of the build: member, manager, officer, director or registered_agent. Null when the file carries none. type: - string - 'null' source: description: >- The source of the filing: principal or agent. Null when the file carries none. type: - string - 'null' required: - entity_no - title - role - source additionalProperties: false description: One filing of a person on one entity of the organization. LeanMarketplaceMark: type: object properties: listing_id: type: string description: 'The listing: the id of the marketplace listing table.' source: description: >- The marketplace of the listing, as the loader names it. Null when the marketplace carries none. type: - string - 'null' source_listing_id: description: >- The id of the listing on its marketplace. Null when the marketplace carries none. type: - string - 'null' published_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The publication date of the listing, YYYY-MM-DD. Null when the marketplace carries none. status_word: description: >- The status as the marketplace writes it. Never evidence of a sale: the outcome reads the deeds. Null when the marketplace carries none. type: - string - 'null' asking_price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The asking price of the listing, whole US dollars. Null when the marketplace carries none. buy_now_price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The buy-now price of the listing, whole US dollars. Null when the marketplace carries none. zip: description: >- The 5-digit ZIP of the listing. Null when the marketplace carries none. type: - string - 'null' property_id: description: >- The parcel the address of the listing resolved to, 32 hex characters: the key to `GET /v3/properties/{id}`. Null when the ladder found none. type: - string - 'null' resolve: type: string enum: - exact - unit - nodir - ambiguous - none description: >- How the address met the place index. Exact: one parcel at the key. Unit: the unit of the listing picked one of several. Nodir: one parcel at the key without the directional. Ambiguous: several and no unit decides. None: no parcel. n_candidates: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The parcels at the address key. Null when the address has no key. legs: type: object properties: pre: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The purchases of the parcel in the 60 days before the publication. close: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The purchases in the 180 days from the publication. late: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The purchases from 180 to 400 days after the publication. required: - pre - close - late additionalProperties: false description: >- The purchase deeds of the parcel in the three windows of the old wholesale family. closing: anyOf: - type: object properties: deal_id: type: string description: >- The purchase that closed the listing, 32 hex characters: 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 that purchase, YYYY-MM-DD. Null when the deed carries none. price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The price of that purchase, whole US dollars. Null when the deed carries none. window: type: string enum: - close - late description: >- close: the first purchase in the 180 days from the publication. late: the first in the 180 to 400 days after it, with none before. buyer: 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 of that purchase: the key to `GET /v3/orgs/{id}`. Null when the build matched none. A deed name that reads as a person is not served here. 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' required: - org_id - org_name - from_registry additionalProperties: false description: The buyer organization of the closing purchase. required: - deal_id - sale_date - price - window - buyer additionalProperties: false - type: 'null' description: >- The purchase that closed the listing. Null when no purchase followed inside the windows. price_within_asking: description: >- True when the closing price is within 5 percent of the asking price or of the buy-now price. Null without a closing price and a listing price. type: - boolean - 'null' outcome: type: string enum: - closed - closed_late - open - late_window - no_deed - unresolved description: >- The reading of the deeds. Closed: a purchase in the 180 days from the publication. Closed late: one from 180 to 400 days after it. Open: no purchase yet, inside 180 days. Late window: no purchase yet, inside 400 days. No deed: no purchase and the windows are over. Unresolved: no parcel. seller: type: object properties: org_id: description: >- The seller organization as the marketplace gives it: an id of the marketplace, not of the lean set. Null when the marketplace carries none. type: - string - 'null' org_name: description: >- The name of that organization. Null when the marketplace carries none. type: - string - 'null' required: - org_id - org_name additionalProperties: false description: The seller as the marketplace gives it. wholesaler: 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 organization of the business registry whose entity name key is the name key of the seller: the key to `GET /v3/orgs/{id}`. Null when none matched. match: type: string enum: - filed - former - ambiguous - none description: >- How the seller name met the registry: filed, former, ambiguous when the key points at two organizations, or none. required: - org_id - match additionalProperties: false description: The seller as an organization of the lean set. required: - listing_id - source - source_listing_id - published_on - status_word - asking_price - buy_now_price - zip - property_id - resolve - n_candidates - legs - closing - price_within_asking - outcome - seller - wholesaler description: >- One listing of the Investorlift marketplaces met with its parcel and the deeds after it: the outcome, the closing purchase, the seller and the wholesaler. 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. 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.