> ## 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 lender > One lender organization: its loans by window and by rule, its open book and the quantiles of its amounts, rates and terms. The body adds its places, its spellings, its rank in the state and the same key in the other served states. The path takes the organization id of a ranking row, a loan row or a search hit. The loans are a dated slice: meta.build.states[].financing_as_of gives the date. This host does not serve a spelling that reads as a person. A call costs 0 credits. [The dataset of the Investorlift Data API](https://developers.investorlift.com/api-reference/dataset). ## OpenAPI ````yaml /openapi.json get /v3/lenders/{id} openapi: 3.1.0 info: title: God Mode API version: 1.44.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 served state and serves the buyers: the organizations behind the deeds, their people, the agents, the lenders and the listings. On every response, `meta.build.states[]` lists the served states and the publish behind each. **Deals** are the flagged purchases of the deed cut: a sale at arm's length that the rules read as an investment. **Buyers** are the organizations behind them: one organization for the entities of a registry, with the people it files. **Lenders** are the organizations that hold the loans on those deals, keyed through the same registry. 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.** The buyers of one Scottsdale ZIP code since 2024, the most purchases first: ``` GET https://api.investorlift.com/v3/buyers?zip=85251&from=2024-01-01&limit=3 Authorization: Bearer zpka_... ``` **Conventions.** Responses are `{ data, meta }`. Lists add `page` (an opaque cursor). A list parameter takes commas or repeated keys. Dates are YYYY-MM-DD. The ids are the ids of the files. An organization is the state, a colon and its registry number (`AZ:L17142520`). A person is `person:` and 12 hex characters, and an agent is the state, `:agt:` and 12 hex characters. A deal is 32 hex characters. Money is whole dollars. It is null, never 0, when the deed carries no price. Coordinates are WGS84. A place is a ZIP list (`zip`), a point and radius (`lat`, `lng`, `radius_miles`) or a viewport (`bbox=west,south,east,north`). A parcel (`property_id`) and an address with its ZIP are places too. 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 name of a person, a licence, a phone, an email, a website or a mailing address. It serves the organizations, the deals, the buyers, the properties, the places, the listings and the lenders. 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 header `X-Dataset-Version` changes only when a state is published again. Use it in cache keys, or poll `GET /v3/build`. **MCP.** The API serves the same data to Model Context Protocol clients at `POST https://api.investorlift.com/mcp` with the same key: forty-five read-only tools, five resources, six 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 inputs. 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, 404 job_not_found, 409 job_not_done, 406 not_acceptable, 410 gone, 413 batch_too_large, 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, 503 jobs_unavailable, 504 statement_timeout. servers: - url: https://api.investorlift.com security: - bearerAuth: [] tags: - name: dataset x-group: Dataset description: >- The served set, under `/v3`: who buys houses, from the state business registry, the deeds, the listings and the loans. The routes serve a name search, the organizations, the people, the agents, the deals and the buyers. They serve the properties, the places, the listings and the lenders too. Two probes serve the coverage and the build of each served state. externalDocs: description: >- The documentation site: the guides, the walkthroughs, the error catalogue and the MCP connection steps. url: https://developers.investorlift.com paths: /v3/lenders/{id}: get: tags: - dataset summary: Get one lender description: >- One lender organization: its loans by window and by rule, its open book and the quantiles of its amounts, rates and terms. The body adds its places, its spellings, its rank in the state and the same key in the other served states. The path takes the organization id of a ranking row, a loan row or a search hit. The loans are a dated slice: meta.build.states[].financing_as_of gives the date. This host does not serve a spelling that reads as a person. A call costs 0 credits. [The dataset of the Investorlift Data API](https://developers.investorlift.com/api-reference/dataset). operationId: getLender parameters: - schema: type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ in: path name: id required: true description: >- The lender organization: the organization id of the set, as a ranking row, a loan row or a search hit carries it. responses: '200': description: >- One lender. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Lender' meta: $ref: '#/components/schemas/DatasetMeta' required: - data - meta additionalProperties: false description: >- One lender. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates. example: data: id: AZ:R17517033 state: AZ kind: registry display_name: UNITED WHOLESALE MORTGAGE LLC recorded_name: UNITED WHOLESALE MORTGAGE from_registry: true tags: - institution nmls: id: 3038 url: >- https://www.nmlsconsumeraccess.org/EntityDetails.aspx/COMPANY/3038 successor: null counts: n_loans: 5459 n_loans_12m: 571 n_loans_24m: 1199 n_loans_36m: 1638 volume_24m: 367912870 n_unpriced_24m: 0 n_amount_excluded_24m: 0 n_blanket_positions_24m: 0 n_parcels: 5074 n_in_history: 2344 n_in_history_24m: 299 n_in_both_24m: 257 n_first_lien_24m: 1137 n_heloc_24m: 51 n_construction_24m: 0 n_purchase_label_24m: 23 n_priced_24m: 1199 n_rated_24m: 1134 n_term_known_24m: 1197 n_loans_since_2015: 5404 n_before_2002: 0 n_undated: 0 first_recording_date: '2005-08-01' last_recording_date: '2026-06-11' open: n_liens: 4526 n_first_liens: 3980 n_junior_liens: 546 n_due_known: 4522 n_maturing_12m: 0 n_on_resold_parcels: 54 n_open_24m: 1164 balance: 1059165787 n_balance_excluded: 48 terms: amount_window: 24m amount_p25: 236300 amount_p50: 318889 amount_p75: 375943 rate_p50: 6.64 term_p50_months: 360 share_le_24m: 0 share_25_120m: 0.006049496 share_121_359m: 0.078643446 share_ge_360m: 0.915307058 places: n_zips_24m: 7 n_counties_24m: 1 top_zip5_24m: '85379' top_zip_share_24m: 0.197664721 rank_in_state: loans_24m: 1 volume_24m: 1 deals: n_deals: 2 first_deal_date: '2026-06-15' last_deal_date: '2026-08-07' is_active_12m: true has_open_book: true borrowers: n_borrowers: 7568 n_borrowers_24m: 1731 n_borrower_orgs_24m: 1726 n_repeat_borrowers_24m: 40 financed: n_investor_loans: 101 n_investor_loans_24m: 15 n_investor_orgs_24m: 17 n_investor_loans_since_2015: 99 n_deals_financed: 32 n_deals_financed_24m: 5 n_auction_purchases_financed_24m: 0 n_marketplace_purchases_financed_24m: 0 n_purchase_24m: 749 n_not_purchase_24m: 438 n_purpose_unknown_24m: 12 investor_lender_by_count: false outcomes: n_strict_all: 32 n_strict_24m: 5 n_captured_24m: 5 n_foreclosed: 0 n_foreclosed_24m: 0 n_resolved_by_resale: 2 n_refinanced: 3 n_open_outcome: 29 n_takebacks: 2 n_takebacks_24m: 1 median_months_to_payoff: null is_auction_lender: false as_of: '2026-06-25' recordings_through: '2026-06-11' names: - name: UNITED WHOLESALE MORTGAGE lender_key: UNITED WHOLESALE MORTGAGE identity_basis: key company_like: true tags: - institution entity_no: R17517033 match_basis: filed n_rows: 10161 n_rows_24m: 2238 first_recording_date: '2005-08-01' last_recording_date: '2026-06-09' - name: UNITED WHOLESALE MORTGAGE LLC lender_key: UNITED WHOLESALE MORTGAGE identity_basis: key company_like: true tags: - institution entity_no: R17517033 match_basis: filed n_rows: 1238 n_rows_24m: 389 first_recording_date: '2020-12-18' last_recording_date: '2026-06-11' - name: UNITED SHORE FINANCIAL SERVICES LLC lender_key: UNITED SHORE FINANCIAL SERVICES identity_basis: dictionary company_like: true tags: - institution entity_no: R17517033 match_basis: filed n_rows: 1 n_rows_24m: 0 first_recording_date: '2012-06-20' last_recording_date: '2012-06-20' lender_key: UNITED WHOLESALE MORTGAGE identity_bases: - dictionary - key by_county: - key: '04013' n_24m: 1199 n_all: 5459 volume_24m: 367912870 share_of_lender: 1 rank_in_place: 1 share_of_place: 0.073962124 n_investor_loans_24m: 15 n_investor_loans_all: 101 by_zip: - key: '85379' n_24m: 237 n_all: 1349 volume_24m: 86030518 share_of_lender: 0.197664721 rank_in_place: 2 share_of_place: 0.075888569 n_investor_loans_24m: 4 n_investor_loans_all: 32 - key: '85345' n_24m: 230 n_all: 1086 volume_24m: 73589252 share_of_lender: 0.191826522 rank_in_place: 1 share_of_place: 0.07628524 n_investor_loans_24m: 3 n_investor_loans_all: 19 - key: '85351' n_24m: 208 n_all: 893 volume_24m: 46304757 share_of_lender: 0.173477898 rank_in_place: 1 share_of_place: 0.078549849 n_investor_loans_24m: 1 n_investor_loans_all: 8 - key: '85037' n_24m: 166 n_all: 759 volume_24m: 54812381 share_of_lender: 0.138448707 rank_in_place: 4 share_of_place: 0.060254083 n_investor_loans_24m: 1 n_investor_loans_all: 13 - key: '85033' n_24m: 155 n_all: 540 volume_24m: 44749653 share_of_lender: 0.129274395 rank_in_place: 3 share_of_place: 0.083512931 n_investor_loans_24m: 2 n_investor_loans_all: 13 - key: '85051' n_24m: 144 n_all: 584 volume_24m: 45835595 share_of_lender: 0.120100083 rank_in_place: 1 share_of_place: 0.075117371 n_investor_loans_24m: 2 n_investor_loans_all: 11 - key: '85031' n_24m: 59 n_all: 248 volume_24m: 16590714 share_of_lender: 0.049207673 rank_in_place: 3 share_of_place: 0.065774805 n_investor_loans_24m: 2 n_investor_loans_all: 5 other_states: [] meta: generated_at: '2026-10-18T21:38:34.282Z' 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: 5ca22a59 built_at: '2026-10-18T21:14:14.380Z' published_at: '2026-10-18T21:29:36.244Z' run_id: 1792358069 financing_as_of: '2026-06-25' recordings_through: '2026-06-11' financing_source: replay_887 str_as_of: '2026-10-18' - state: CA build_id: null built_at: '2026-09-24T01:58:30.453Z' published_at: '2026-09-24T03:15:56.838Z' run_id: 1790215190 financing_as_of: null recordings_through: null financing_source: null str_as_of: null - state: FL build_id: 0e5fa9bc built_at: '2026-09-24T15:08:23.506Z' published_at: '2026-09-24T18:59:42.805Z' run_id: 1790262682 financing_as_of: null recordings_through: null financing_source: null str_as_of: null - state: TX build_id: 775ed08d built_at: '2026-09-24T11:08:10.587Z' published_at: '2026-09-24T13:16:03.157Z' run_id: 1790248213 financing_as_of: null recordings_through: null financing_source: null str_as_of: null headers: ETag: $ref: '#/components/headers/ETag' X-Request-Id: $ref: '#/components/headers/X-Request-Id' X-Rows: $ref: '#/components/headers/X-Rows' X-Dataset-Version: $ref: '#/components/headers/X-Dataset-Version' X-Data-End: $ref: '#/components/headers/X-Data-End' '400': description: Bad request (invalid_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/lenders/{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/lenders/{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/lenders/{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/lenders/{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/lenders/{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/lenders/{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/lenders/{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/lenders/{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/lenders/{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/lenders/{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/lenders/{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/lenders/{id} request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' components: schemas: Lender: 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. state: type: string pattern: ^[A-Z]{2}$ description: The 2-letter state code of a served state, for example AZ. kind: type: string enum: - registry - deed_name description: >- registry: an organization of the business registry. deed_name: a spelling that no entity matched, one lender statewide under its key. display_name: type: string description: >- The name to print, in its display form (upper case, no period, the suffix as one token): the registry name of a registry organization, else the spelling with the most loans in the 24 months, or the one spelling of its deed rows when the lender bought under the name. recorded_name: description: >- The spelling of the lender with the most loan rows, as the county wrote it: the most rows in the 24 months, then all time, then the first alphabetically. For a deed-name lender, display_name is the display form of this spelling. Null when the spelling reads as a person. type: - string - 'null' from_registry: type: boolean description: True for an organization of the business registry. tags: type: array items: type: string enum: - government - bank - credit_union - trust - person - hard_money - institution description: >- A reading of the name of the lender, each by its rule in the build. government: a public body. bank: the bank, thrift and charter words. credit_union: a credit union. trust: a trust, an IRA, an estate or a seller carry-back. person: a name that reads as a person. hard_money: the hard-money vocabulary and brands. institution: the party-wide reading of an institutional word, by the rule tag_institution of the build. It reads a bank, mortgage, loan, lending, funding, finance or servicing word. It also reads a credit union, a GSE or HUD form, a public body, a title or escrow company and an association. It also reads a school, a hospital, a church, a club, an insurer, a pension or retirement plan, a securitization or loan trust and a REIT brand. It excludes FBO, custodian, IRA, seller financing, insurance trust and the iBuyer brands. A bank, a credit union, a public body and a hard-money REIT carry it beside their own tag. It never means a bank: a mortgage company and an investor lender carry it alike. A tag decides no row: a lender keeps its loans and gets a tag. The tags of an organization are the union of the tags of its spellings, less person when the organization reads as a company. The list can grow with the rules of the build: a client keeps an unknown tag. description: The union of the tags of its spellings, in the order of the enum. nmls: anyOf: - $ref: '#/components/schemas/LenderNmls' - type: 'null' description: >- Its NMLS id. Null when the seed of the build does not name the lender. successor: anyOf: - $ref: '#/components/schemas/LenderSuccessor' - type: 'null' description: >- Its successor in this state. Null when the link seed names none, or the successor is not a lender of this state. counts: $ref: '#/components/schemas/LenderCounts' open: $ref: '#/components/schemas/LenderOpen' terms: $ref: '#/components/schemas/LenderTerms' places: $ref: '#/components/schemas/LenderPlaces' rank_in_state: $ref: '#/components/schemas/LenderRankInState' deals: anyOf: - $ref: '#/components/schemas/LenderDeals' - type: 'null' description: >- The organization as a buyer. Null when it bought nothing on a flagged deed. is_active_12m: type: boolean description: True when it has a loan in the 365 days before financing_as_of. has_open_book: type: boolean description: True when it has an open position. borrowers: anyOf: - $ref: '#/components/schemas/LenderBorrowers' - type: 'null' description: >- Its borrowers by key and by organization. Null while the state has no loan links. financed: anyOf: - $ref: '#/components/schemas/LenderFinanced' - type: 'null' description: What its loans financed. Null while the state has no loan links. outcomes: anyOf: - $ref: '#/components/schemas/LenderOutcomes' - type: 'null' description: >- The outcomes of its captured loans and the parcels it took back. Null while the state has no loan links. as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the financing slice of the state, YYYY-MM-DD. Null while the state has no financing slice. recordings_through: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest recording date of the slice, YYYY-MM-DD. Null while the state has no financing slice. names: type: array items: $ref: '#/components/schemas/LenderName' description: >- Its spellings on the county records, the most rows first, at most 50. This host does not serve a spelling that reads as a person. lender_key: description: >- The canonical key of the organization with the most loan rows: what the lender search folds a query to. Null when the key reads as a person. type: - string - 'null' identity_bases: type: array items: type: string enum: - key - dictionary - truncated_prefix - spelling_fold description: The distinct ways its spellings joined it, sorted. by_county: type: array items: $ref: '#/components/schemas/LenderPlaceRow' description: >- Every county with a loan of the lender, the most 24-month loans first. by_zip: type: array items: $ref: '#/components/schemas/LenderPlaceRow' description: >- The ZIPs with a loan of the lender, the most 24-month loans first, at most 50. other_states: type: array items: $ref: '#/components/schemas/LenderOtherState' description: >- The same key in the other served states, in state order. Empty when none. required: - id - state - kind - display_name - recorded_name - from_registry - tags - nmls - successor - counts - open - terms - places - rank_in_state - deals - is_active_12m - has_open_book - borrowers - financed - outcomes - as_of - recordings_through - names - lender_key - identity_bases - by_county - by_zip - other_states description: >- One lender organization: its counts by window and by rule, its open book, its terms, its places, its spellings and its rank in the state. No class and no score. DatasetMeta: 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 of a route that scores a match, one per factor, rounded to 4 decimals. Absent on every route of the served set. 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 place that ran, defaults filled and keyed as the query is (see MetaGeometry). Present on every route that takes a place: the deals, the pins, the cells, the summary, the buyers and the listings. Copy it back as the query to repeat the request. 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: >- Empty on every route: the served set carries states, not markets, and meta.build.states[] lists them. dated: description: >- Absent on every route of the served set: no block of it is a dated snapshot. 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/BuildState' 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 /v3 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. LenderNmls: type: object properties: id: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The NMLS id of the lender from the curated seed of the build. url: type: string description: The NMLS Consumer Access page of the id. required: - id - url additionalProperties: false description: The NMLS id of a lender organization and the page that shows it. LenderSuccessor: type: object properties: org_id: type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The lender organization of this state that acquired the lender, or that it is a subsidiary of. kind: type: string enum: - acquisition - subsidiary description: >- acquisition: the successor bought the lender. subsidiary: the lender is a unit of the successor. required: - org_id - kind additionalProperties: false description: >- The successor of a lender organization from the curated link seed of the build. A link never merges two lenders. LenderCounts: type: object properties: n_loans: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The loans under the lender of record: one instrument row for each loan key and lender, all time. n_loans_12m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The loans recorded in the 365 days before financing_as_of. n_loans_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The loans recorded in the 730 days before financing_as_of. n_loans_36m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The loans recorded in the 1,095 days before financing_as_of. volume_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The sum of the amounts of the 24-month loans, whole US dollars. The sum keeps a priced loan that is not an outlier and not a blanket position other than the carrier. 0 when none. n_unpriced_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The 24-month loans with no amount. n_amount_excluded_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The 24-month loans the volume leaves out: an amount above 5,000,000, or a blanket position that is not the carrier. n_blanket_positions_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The 24-month loans in a blanket group: one lender, one date and one amount on five parcels or more. n_parcels: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The distinct parcels of its loans, all time. n_in_history: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its loans with a recorded instrument, all time. n_in_history_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans with a recorded instrument. n_in_both_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its 24-month loans that are an open position paired with a recorded instrument. n_first_lien_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans in the first open position of the parcel. n_heloc_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans with the product heloc. n_construction_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans with the product construction. n_purchase_label_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans the county labelled purchase money. n_priced_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans in the volume. n_rated_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans with a rate. n_term_known_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans with a term. n_loans_since_2015: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its loans recorded since 2015-01-01. n_before_2002: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its loans recorded before 2002-01-01. n_undated: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its loans with no recording date. first_recording_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its first recording date, YYYY-MM-DD. Null when none is dated. last_recording_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its last recording date, YYYY-MM-DD. Null when none is dated. required: - n_loans - n_loans_12m - n_loans_24m - n_loans_36m - volume_24m - n_unpriced_24m - n_amount_excluded_24m - n_blanket_positions_24m - n_parcels - n_in_history - n_in_history_24m - n_in_both_24m - n_first_lien_24m - n_heloc_24m - n_construction_24m - n_purchase_label_24m - n_priced_24m - n_rated_24m - n_term_known_24m - n_loans_since_2015 - n_before_2002 - n_undated - first_recording_date - last_recording_date additionalProperties: false description: >- The loans of a lender organization under the lender of record, by window and by rule. Every count is a count of observed rows. LenderOpen: type: object properties: n_liens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The open positions under the open-table lender: every open lien of the slice. n_first_liens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The open positions in the first position of the parcel. n_junior_liens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The open positions in the second position or below. n_due_known: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The open positions with a due date. n_maturing_12m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The open positions due in the 365 days after financing_as_of. n_on_resold_parcels: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The open positions on a parcel sold at arm's length after the recording. n_open_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The open positions recorded in the 730 days before financing_as_of. balance: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The sum of the estimated balances, whole US dollars. The sum leaves out an outlier, a blanket position other than the carrier and a position on a resold parcel. 0 when none. n_balance_excluded: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The open positions with a balance the sum leaves out. required: - n_liens - n_first_liens - n_junior_liens - n_due_known - n_maturing_12m - n_on_resold_parcels - n_open_24m - balance - n_balance_excluded additionalProperties: false description: >- The open book of a lender organization: its open positions and their balances, by rule. LenderTerms: type: object properties: amount_window: type: string enum: - 24m - all description: >- The window of the five quantiles: 24m when the lender has 20 priced loans or more in the 24 months, else all. amount_p25: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The first quartile of the amounts of the priced loans of the window, whole US dollars. Null below three loans. amount_p50: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The median amount of the window, whole US dollars. Null below three loans. amount_p75: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The third quartile of the window, whole US dollars. Null below three loans. rate_p50: description: >- The median rate of the rated loans of the window, percent. Null below three rated loans. type: - number - 'null' term_p50_months: description: >- The median term of the loans with a term in the window, months. Null below three. type: - number - 'null' share_le_24m: description: >- The share of its loans with a term of 24 months or less, of the loans with a term, all time, to nine decimals. Null when fewer than half of its loans carry a term. type: - number - 'null' share_25_120m: description: The share with a term of 25 to 120 months. Null as share_le_24m. type: - number - 'null' share_121_359m: description: The share with a term of 121 to 359 months. Null as share_le_24m. type: - number - 'null' share_ge_360m: description: The share with a term of 360 months or more. Null as share_le_24m. type: - number - 'null' required: - amount_window - amount_p25 - amount_p50 - amount_p75 - rate_p50 - term_p50_months - share_le_24m - share_25_120m - share_121_359m - share_ge_360m additionalProperties: false description: >- The amounts, the rate and the terms of the loans of a lender organization, as positional quantiles and shares. LenderPlaces: type: object properties: n_zips_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The distinct ZIPs of its 24-month loans. n_counties_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The distinct counties of its 24-month loans. top_zip5_24m: description: >- The ZIP with the most of its 24-month loans, the lower code on a tie. Null when it has no 24-month loan with a ZIP. type: - string - 'null' top_zip_share_24m: description: >- The share of its 24-month loans in that ZIP, to nine decimals. Null when it has no 24-month loan. type: - number - 'null' required: - n_zips_24m - n_counties_24m - top_zip5_24m - top_zip_share_24m additionalProperties: false description: >- Where a lender organization lent in the 24 months: the counts of its places and its top ZIP. LenderRankInState: type: object properties: loans_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its position among the lenders of the state by 24-month loans, 1 first. volume_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its position among the lenders of the state by 24-month volume, 1 first. required: - loans_24m - volume_24m additionalProperties: false description: The rank of a lender organization in its state, read at request time. LenderDeals: type: object properties: n_deals: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The flagged purchases of the organization as a buyer. first_deal_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its first deed as a buyer, YYYY-MM-DD. Null for a deed name. last_deal_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: Its last deed as a buyer, YYYY-MM-DD. Null for a deed name. required: - n_deals - first_deal_date - last_deal_date additionalProperties: false description: >- The lender organization as a buyer of investment property: the one node of the set. LenderBorrowers: type: object properties: n_borrowers: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The distinct borrower keys of its loans, all time. n_borrowers_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The distinct borrower keys of its 24-month loans. n_borrower_orgs_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The distinct borrower organizations of its 24-month loans. n_repeat_borrowers_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The borrower organizations on two or more of its 24-month loans. required: - n_borrowers - n_borrowers_24m - n_borrower_orgs_24m - n_repeat_borrowers_24m additionalProperties: false description: >- The borrowers of a lender organization, counted by key and by organization. LenderFinanced: type: object properties: n_investor_loans: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its loans to a borrower organization that has a flagged purchase of its own, all time. n_investor_loans_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Such loans in the 24 months. n_investor_orgs_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The distinct such organizations in the 24 months. n_investor_loans_since_2015: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Such loans recorded since 2015-01-01. n_deals_financed: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The flagged purchases whose purchase loan is a strict-linked loan of the lender, all time. n_deals_financed_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Such purchases financed by a loan of the 24 months. n_auction_purchases_financed_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Of them, the purchases at a foreclosure auction. n_marketplace_purchases_financed_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Of them, the purchases that closed a listing of the Investorlift marketplaces. n_purchase_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its 24-month loans whose purpose reads purchase: a priced purchase deed inside the 45 days up to the recording. n_not_purchase_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans whose purpose reads not_purchase. n_purpose_unknown_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans whose purpose is unknown. investor_lender_by_count: type: boolean description: >- True under the behavior rule of the build: 20 loans or more since 2015, a quarter of them strict-linked loans to an investor, and no bank tag. required: - n_investor_loans - n_investor_loans_24m - n_investor_orgs_24m - n_investor_loans_since_2015 - n_deals_financed - n_deals_financed_24m - n_auction_purchases_financed_24m - n_marketplace_purchases_financed_24m - n_purchase_24m - n_not_purchase_24m - n_purpose_unknown_24m - investor_lender_by_count additionalProperties: false description: >- What a lender organization financed: the investor loans, the purchases its loans financed and the purpose of its loans. LenderOutcomes: type: object properties: n_strict_all: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its loans strict-linked to a flagged purchase: recorded inside 45 days after the sale, all time. n_strict_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Such loans in the 24 months. n_captured_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans linked to a flagged purchase, strict or loose. n_foreclosed: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its captured loans followed by a take-back deed past the 90-day floor, before any resale or refinance. n_foreclosed_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Such loans recorded in the 24 months. n_resolved_by_resale: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its captured loans resolved by a priced resale of the parcel. n_refinanced: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its captured loans resolved by another loan on the parcel more than 45 days after. n_open_outcome: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its captured loans with an open position and no later event. n_takebacks: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The parcels the lender took back since 2016: a take-back deed with a key of the lender among the grantees, its own auction purchases out. n_takebacks_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The parcels it took back in the 24 months. median_months_to_payoff: description: >- The median months from the recording to the resale or the refinance of its strict-linked loans resolved in the 24 months. Null below three. type: - number - 'null' is_auction_lender: type: boolean description: >- True under one of two rules. A key of the lender is the grantee of two deeds in lieu or more on distinct parcels since 2016. Or a key of the lender bought two trustee-sale deeds or more as a seller key too, the credit bid. required: - n_strict_all - n_strict_24m - n_captured_24m - n_foreclosed - n_foreclosed_24m - n_resolved_by_resale - n_refinanced - n_open_outcome - n_takebacks - n_takebacks_24m - median_months_to_payoff - is_auction_lender additionalProperties: false description: >- The outcomes of the captured loans of a lender organization and the parcels it took back. A take-back is a deed, never delinquency. LenderName: type: object properties: name: description: >- The spelling as the county wrote it. Null when the spelling reads as a person. type: - string - 'null' lender_key: description: The key of the spelling in the build. Null with the name. type: - string - 'null' identity_basis: type: string enum: - key - dictionary - truncated_prefix - spelling_fold description: >- How the spelling joined the organization. key: its own key. dictionary: a row of the curated dictionary. truncated_prefix: a spelling the county cut at 30 or 40 characters, a prefix of one other spelling. spelling_fold: a lender with no entity of the state whose key differs from the key of the organization by spaces or a trailing S alone. The list can grow with the rules of the build. company_like: type: boolean description: >- True when the spelling reads as a company, a public body or an institution. tags: type: array items: type: string enum: - government - bank - credit_union - trust - person - hard_money - institution description: >- A reading of the name of the lender, each by its rule in the build. government: a public body. bank: the bank, thrift and charter words. credit_union: a credit union. trust: a trust, an IRA, an estate or a seller carry-back. person: a name that reads as a person. hard_money: the hard-money vocabulary and brands. institution: the party-wide reading of an institutional word, by the rule tag_institution of the build. It reads a bank, mortgage, loan, lending, funding, finance or servicing word. It also reads a credit union, a GSE or HUD form, a public body, a title or escrow company and an association. It also reads a school, a hospital, a church, a club, an insurer, a pension or retirement plan, a securitization or loan trust and a REIT brand. It excludes FBO, custodian, IRA, seller financing, insurance trust and the iBuyer brands. A bank, a credit union, a public body and a hard-money REIT carry it beside their own tag. It never means a bank: a mortgage company and an investor lender carry it alike. A tag decides no row: a lender keeps its loans and gets a tag. The tags of an organization are the union of the tags of its spellings, less person when the organization reads as a company. The list can grow with the rules of the build: a client keeps an unknown tag. description: The tags of the spelling. entity_no: description: >- The entity number of the registry entity the spelling matched, the key to `GET /v3/entities/{id}`. Null when no entity matched. type: - string - 'null' match_basis: description: >- How the spelling met the registry: filed, former, variant (a form of one registry key with no space or with the S form of its last word), principal or none. Null when the build matched none, and for a placeholder spelling. type: - string - 'null' n_rows: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The loan rows that name the spelling, as the lender or as the assignee, all time. n_rows_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The loan rows that name it in the 730 days before financing_as_of. first_recording_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The first recording date of its rows, YYYY-MM-DD. Null when none is dated. last_recording_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last recording date of its rows, YYYY-MM-DD. Null when none is dated. required: - name - lender_key - identity_basis - company_like - tags - entity_no - match_basis - n_rows - n_rows_24m - first_recording_date - last_recording_date additionalProperties: false description: >- One spelling of the lender on the county records, with how it joined the organization and its rows. LenderPlaceRow: type: object properties: key: type: string description: The county FIPS or the ZIP. n_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its loans in the place in the 730 days before financing_as_of. n_all: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its loans in the place, all time. volume_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Its 24-month volume in the place, whole US dollars: the sum of the priced amounts that are not an outlier and not a blanket position other than the carrier. 0 when none. share_of_lender: description: >- Its 24-month loans in the place over its 24-month loans everywhere, to nine decimals. Null when it has no 24-month loan. type: - number - 'null' rank_in_place: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Its position among the lenders of the place by 24-month loans, 1 first. Null when it has no 24-month loan in the place. share_of_place: description: >- Its 24-month loans in the place over every lender's 24-month loans there, to nine decimals. Null when the place has no 24-month loan. type: - number - 'null' n_investor_loans_24m: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Its 24-month loans in the place to a borrower organization with a flagged purchase of its own. Null while the state has no investor counts. n_investor_loans_all: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Such loans in the place, all time. Null while the state has no investor counts. required: - key - n_24m - n_all - volume_24m - share_of_lender - rank_in_place - share_of_place - n_investor_loans_24m - n_investor_loans_all additionalProperties: false description: >- One place of the lender with its loans there, its share of the lender and its rank in the place. LenderOtherState: type: object properties: state: type: string pattern: ^[A-Z]{2}$ description: The 2-letter state code of a served state, for example AZ. org_id: type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The lender organization of that state under the same key: the key to `GET /v3/lenders/{id}` there. n_loans_24m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Its 24-month loans in that state. required: - state - org_id - n_loans_24m additionalProperties: false description: The same lender key as a lender organization of another served state. 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. 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 over the places the API serves. Null when this market has no short-term rental tables. This block belongs to the first build, whose routes left on 2026-10-09, so no route reads it. meta.build.states[].str_as_of is the stamp of the dataset. 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 market of the first build. No route of the served set carries one: meta.coverage is empty. 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. BuildState: type: object properties: state: type: string pattern: ^[A-Z]{2}$ description: The 2-letter state code of a served state, for example AZ. build_id: description: >- The id of the build of the files, a hash of the recorded steps. Null while the files of the state are a trial and no build id exists. type: - string - 'null' built_at: anyOf: - type: string format: date-time description: Timestamp, ISO 8601. - type: 'null' description: >- When the last step of the build finished, ISO 8601. Null while the files carry no record. published_at: type: string format: date-time description: When the publish of the state wrote the served tables, ISO 8601. run_id: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The id of the publish that serves the rows of the state. It moves with each publish. financing_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the financing slice of the state, the newest applied drop of the county records: the clock of every lender window, YYYY-MM-DD. Null while the state has no financing slice. recordings_through: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest recording date of a loan of the slice, YYYY-MM-DD. Null while the state has no financing slice. financing_source: description: >- Where the financing slice came from: replay_887 for the replay of the archive of the feed, weekly when the weekly delivery carries the domains again. Null while the state has no financing slice. type: - string - 'null' str_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The short-term rental snapshot of the state, YYYY-MM-DD: the oldest snapshot date over the places this API serves, so no served status is older than it. Each place carries its own date on GET /v3/coverage. Null while the state has no short-term rental tables. required: - state - build_id - built_at - published_at - run_id - financing_as_of - recordings_through - financing_source - str_as_of additionalProperties: false description: >- One served state: its build, its publish and the dates of its financing slice. 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 build of the served set and from the representation, not from the body. It moves only when a state is published again. On a JSON route, send it back as If-None-Match, and an unchanged set answers 304 with no body. GET /v3/build 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 build token of the served set: one pair per served state in state order, each the state and its run id, joined by a dash (AZ1790123752-TX1790248213 for two states). The run ids are the same as meta.build.states[].run_id, and you can read them without parsing the body. The token moves only when a state is published again, so fold it into cache keys. On every 2xx and the 304, never on an error. schema: type: string X-Data-End: description: >- The newest deed date across the served states, YYYY-MM-DD. GET /v3/coverage carries the date of each state. On every 2xx and the 304, never on an error. Absent while no served state carries a deed date. 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.