> ## 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 person of the lean set > Get one person of the lean set. This route serves the lean set under `/v3/people/{id}`. See [The lean dataset](/api-reference/lean) for the tier rules. ## OpenAPI ````yaml GET /v3/people/{id} openapi: 3.1.0 info: title: God Mode API version: 0.61.0 description: >- You have a house to sell, usually a wholesale contract. You want **the investors who buy houses like this one, from county deed records**. This API reads those records for each loaded market and serves three things: deals, investors and a ranking. On every response, `meta.coverage[]` lists the markets and the area each covers. **Deals** are every investment purchase, flip, wholesale and current investor holding. **Investors** are the buyers behind them, grouped so that the LLCs of an operator and the person behind them count as one. **A ranking** says, for a given house, which investors are the best fit and why. The documentation site at https://developers.investorlift.com carries the guides, the walkthroughs, the error catalogue and the connection steps for MCP clients. https://developers.investorlift.com/llms.txt indexes the site for a model. This document is the machine-readable reference behind the API tab of the site. **Start here.** Ranked buyers for a house at 7522 E Cholla St, Scottsdale, under contract at $410,000 and in need of a major rehab: ``` GET https://api.investorlift.com/v1/buyers/match?lat=33.476917&lng=-111.920385&radius_miles=2&subject_asking_price=410000&subject_condition=MAJOR_REHAB Authorization: Bearer zpka_... ``` **Conventions.** Responses are `{ data, meta }`. Lists add `page` (an opaque cursor) and sometimes `summary`. A list parameter takes commas or repeated keys. Dates are YYYY-MM-DD. Ids carry a prefix: `deal_`, `prop_`, `inv_`, `agt_`, `wl_`, `wsr_`. Money is whole dollars. It is null, never 0, when the deed carries no price. Coordinates are WGS84. A location is a point and radius (`lat`, `lng`, `radius_miles`), a viewport (`bbox=west,south,east,north`) or a parcel (`property_id`). Every operation carries `x-credits`, its price in credits on the public tier. `charge` is null at 0 credits. Otherwise `kind` names the deal, investor or property (a parcel) that costs 1 credit when new to your account. `base` is the credits a call costs before them. `contract: true` marks a route sold by contract. Every operation also carries `x-raises`, the problem codes it can answer, sorted. Each problem response of the operation lists and shows the codes of its status alone. The list includes the codes the gateway answers on its own. This host does not serve the people behind an entity, mailing addresses, owner identity, mortgage borrowers or lien parties. It does not serve the names, phones, emails and licence numbers of listing agents. It serves the entities, the deals, the listings and the ranking. Errors are RFC 9457 problem+json with a `code` to switch on. The catalogue is https://developers.investorlift.com/problems.json and the Errors page of the site. The field `meta.coverage[].dataset_version` changes only when a refresh rebuilds the tables of a market. Use it in cache keys, or poll `GET /v1/dataset`. **MCP.** The API serves the same data to Model Context Protocol clients at `POST https://api.investorlift.com/mcp` with the same key: twenty-nine read-only tools, four resources, seven prompts. The MCP tab of the documentation site has the client setup. The file `mcp-manifest.json` beside this document lists the tools with their input schemas. Problem codes: 400 validation_error, 400 unknown_parameter, 400 invalid_cursor, 400 geometry_required, 400 geometry_conflict, 400 sort_requires_point, 400 invalid_id, 400 market_required, 401 unauthorized, 403 quota_exceeded, 403 subscription_required, 403 payment_overdue, 403 plan_limit, 404 not_found, 406 not_acceptable, 410 gone, 422 outside_coverage, 422 ambiguous_apn, 422 ambiguous_address, 422 csv_cap_exceeded, 422 listings_unavailable, 422 agents_unavailable, 422 lenders_unavailable, 422 wholesale_unavailable, 422 str_unavailable, 422 cash_sale_unavailable, 422 auction_unavailable, 422 parcels_unavailable, 422 addresses_unavailable, 422 dated_refused, 422 history_unavailable, 400 quicklist_unavailable, 400 dataset_unavailable, 429 rate_limited, 500 internal_error, 503 database_unavailable, 503 pool_saturated, 503 ledger_unavailable, 504 statement_timeout. servers: - url: https://api.investorlift.com security: - bearerAuth: [] tags: - name: listings x-group: MLS listings description: >- Sale listings and observed asking rents near a location, with dated facts and sample counts. - name: buyers x-group: Buyers description: >- Which investors are the best fit for this house: the API ranks nearby investors against a subject property and explains each score. - name: deals x-group: Deals description: >- What occurred around a location: deals for a table, cells for a map, summary stats, and one deal by id. - name: investors x-group: Investors description: >- Who the buyers are: investors active in an area, a full profile, and their metro-wide history. A search finds an investor by any name they buy under. - name: properties x-group: Properties description: >- One parcel: find it from a point or an APN, then read its facts, owner information, short-term rental licence and every deal on it. The owner information covers investor holdings and business-use short-term rentals. - name: agents x-group: Listing agents description: >- Who the listing agents are: find one by name or licence number, then read the profile and every listing of theirs. The profile holds the licence, the brokerages, the listing counts and the investors they belong to. - name: wholesale x-group: Investorlift listings description: >- Investorlift listings as wholesale transactions: the houses listed, and what the county deeds show for each (closed, to whom, which deed). Also the listing companies, and what each investor bought off Investorlift. - name: lenders x-group: Lenders description: >- Who lends on houses in a market: find a lender by any spelling of its name. Rank the lenders of a market, or of one ZIP, city or county. Read a profile: loans counted once across the open-lien and recorded-history tables, the open book, terms, geography and rankings. List every loan of one lender. - name: lean x-group: Lean set description: >- The lean set, under `/v3`: who buys houses, from the state business registry and the deeds. A name search, one organization with its entities and its persons, its purchases, one person with the agent block, the current listings near a place, and the coverage and the build of each served state. - name: dataset x-group: Dataset and coverage description: >- What the API serves, how fresh it is and which data is available where. The dataset version and the last deed date of every market, for cache keys and freshness checks. The coverage matrix, with a place lookup. - name: contract x-group: By contract description: >- Routes sold per jurisdiction under an order form and not reachable on a self-serve key. Ask through the console. externalDocs: description: >- The documentation site: the guides, the walkthroughs, the error catalogue and the MCP connection steps. url: https://developers.investorlift.com paths: /v3/people/{id}: get: tags: - lean summary: Get one person of the lean set description: >- One person of the lean set: the roles, the organizations of the registry the person files with, the filings, and for an agent every phone, email and website of the feed with its counts and dates, the licence, the brokerages and the listing counts. The path takes a person id, a buyer id or an agent id. The API follows a merged id and names it in `meta.resolved_from`. This host serves no name, licence or reach channel of a person. A call costs 0 credits. [The lean dataset of the Investorlift Data API](https://developers.investorlift.com/api-reference/lean). operationId: getLeanPerson parameters: - schema: type: string in: path name: id required: true description: >- The person id, as a search hit, an organization or a listing carries it. responses: '200': description: The person. meta.resolved_from lists the ids that redirected here. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/LeanPerson' meta: $ref: '#/components/schemas/LeanMeta' required: - data - meta additionalProperties: false description: >- The person. meta.resolved_from lists the ids that redirected here. example: data: id: person:01d108287995 state: AZ roles: - agent - principal name: null name_key: null zip: '85086' n_entities: 2 n_entities_all: 2 n_deals: 4 n_listings: 6 has_licence: true agent_basis: licence agent: id: AZ:agt:746abc7438c7 kind: PERSON identity_basis: licence anchor_kind: licence anchor_shared: false name_variants: null licence: null brokerages: - name: West USA Realty n_rows: 7 last_listed_on: '2022-05-14' office_address: >- 16150 N Arrowhead Fountain Center, Peoria, Az, 85382, Us - name: West Usa Realty n_rows: 1 last_listed_on: '2020-06-06' office_address: >- 16150 N Arrowhead Fountains Ctr Dr # 100 Peoria AZ 85382-4748 current_brokerage: West USA Realty counts: n_mentions: 9 n_listings: 6 n_active: 0 n_pending: 0 n_sold: 3 n_off_market: 2 n_listed_12m: 0 first_listed_on: '2019-08-24' last_listed_on: '2022-05-14' n_zips: 4 last_zip: '85029' agent_orgs: - side: buyer org_id: AZ:23331261 org_name: "SFR ACQUISITIONS 3 LLC\t" from_registry: true n_listings: 1 first_on: '2022-05-14' last_on: '2022-05-14' n_flagged: 1 - side: seller org_id: AZ:L11962260 org_name: DEED, LLC from_registry: true n_listings: 1 first_on: '2020-12-22' last_on: '2020-12-22' n_flagged: 0 buyer: null buyer_org_id: null orgs: - org_id: AZ:L11962260 display_name: DEED, LLC n_entities: 4 filings: - entity_no: '23017432' entity_name: Sonoran Star LLC title: Statutory Agent role: agent org_id: AZ:L11962260 - entity_no: '23017432' entity_name: Sonoran Star LLC title: Member role: member org_id: AZ:L11962260 - entity_no: L21342320 entity_name: EAST WEST HORIZON LLC title: Member role: member org_id: AZ:L11962260 addresses: null meta: generated_at: '2026-10-06T20:22:59.895Z' 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: 0ba08efb built_at: '2026-10-06T20:12:55.875Z' published_at: '2026-10-06T20:22:34.435Z' run_id: 1791317578 - state: CA build_id: null built_at: '2026-09-24T01:58:30.453Z' published_at: '2026-09-24T03:15:56.838Z' run_id: 1790215190 - state: FL build_id: 0e5fa9bc built_at: '2026-09-24T15:08:23.506Z' published_at: '2026-09-24T18:59:42.805Z' run_id: 1790262682 - state: TX build_id: 775ed08d built_at: '2026-09-24T11:08:10.587Z' published_at: '2026-09-24T13:16:03.157Z' run_id: 1790248213 headers: ETag: $ref: '#/components/headers/ETag' X-Request-Id: $ref: '#/components/headers/X-Request-Id' X-Rows: $ref: '#/components/headers/X-Rows' X-Dataset-Version: $ref: '#/components/headers/X-Dataset-Version' X-Data-End: $ref: '#/components/headers/X-Data-End' '400': description: Bad request (invalid_id, validation_error) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: invalid_id: summary: Invalid id value: type: >- https://developers.investorlift.com/guides/concepts/errors#invalid_id title: Invalid id status: 400 code: invalid_id detail: >- An investor id is inv_ followed by 12 hex characters. The prefix is part of the id. instance: /v3/people/{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/people/{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/people/{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/people/{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/people/{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/people/{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/people/{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/people/{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/people/{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/people/{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/people/{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/people/{id} request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' components: schemas: LeanPerson: type: object properties: id: type: string pattern: ^(person:[0-9a-f]{12}|buyer:[0-9a-f]{12}|[A-Z]{2}:agt:[0-9a-f]{12})$ description: >- The person id: person: and 12 hex characters for a registry profile, buyer: and 12 hex characters for a deed buyer, or the agent id (the state, a colon, agt, a colon and 12 hex characters) for an agent alone. state: type: string pattern: ^[A-Z]{2}$ description: The 2-letter state code of a served state, for example AZ. roles: type: array items: type: string enum: - agent - buyer - principal description: >- A role of a person. agent: lists for a brokerage. buyer: a deed buyer of a flagged purchase. principal: files with a business registry. description: The roles of the person. name: description: The name of the person. This host serves null here for a person. type: - string - 'null' name_key: description: >- The key of the name as the build keyed it. This host serves null here for a person. type: - string - 'null' zip: description: >- The 5-digit ZIP of the person as filed. Null when the filings carry none. type: - string - 'null' n_entities: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The entities the person files with in the organizations the build joined. n_entities_all: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The entities the person files with, joined or not. n_deals: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The flagged purchases of the person as a buyer. n_listings: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The listings of the person as an agent. has_licence: description: >- True when the person holds a real-estate licence. Null when the build did not read a roll. type: - boolean - 'null' agent_basis: description: >- How the profile met its agent: the licence, the name or the roll. Null when the person is no agent. type: - string - 'null' agent: anyOf: - $ref: '#/components/schemas/LeanAgent' - type: 'null' description: The agent block. Null when the person is no agent. agent_orgs: type: array items: $ref: '#/components/schemas/LeanAgentOrg' description: >- The organizations the agent is linked to through the listings, most listings first. A deals-only key reads the registry organizations alone: a deed name on the buyer side can be a person. Empty when the person is no agent. buyer: anyOf: - $ref: '#/components/schemas/LeanOrgDealCounts' - type: 'null' description: >- What the person did on the deeds as a buyer. Null when the person is no buyer. buyer_org_id: anyOf: - type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The organization id: the state, a colon and the anchor entity number for a registry organization, for example AZ:L16090024. For a deed name that no entity matched: the state, a colon, the word name, a colon and the name key, for example AZ:name:ACME HOLDINGS. The id is stable across builds while the anchor entity stays. - type: 'null' description: >- The deed name the person buys under: the key to `GET /v3/orgs/{id}`. The id carries the name. This host serves null here for a person. Null when the person is no buyer. orgs: type: array items: $ref: '#/components/schemas/LeanPersonOrg' description: >- The organizations of the business registry the person files with, largest first. Empty when none. filings: type: array items: $ref: '#/components/schemas/LeanPersonFiling' description: The filings of the person, by entity. Empty when none. addresses: anyOf: - type: array items: $ref: '#/components/schemas/LeanAddress' - type: 'null' description: >- The reach addresses of the person, the non-generic ones first. They are its filing addresses, the roll mailing of its agent and the deed addresses of the name it buys under. This host serves null here for a person. Empty when none. required: - id - state - roles - name - name_key - zip - n_entities - n_entities_all - n_deals - n_listings - has_licence - agent_basis - agent - agent_orgs - buyer - buyer_org_id - orgs - filings - addresses description: >- One person of the person layer: the roles, the agent block with every phone and email, the organizations, the deals, the filings, the addresses. LeanMeta: type: object properties: generated_at: type: string format: date-time description: >- When the API produced this response, ISO 8601. It does not change the ETag. weights: description: >- The effective match weights, one per factor, rounded to 4 decimals (buyers/match only). The API rescales the weights of the scored factors to sum 1 before it reports them. type: object propertyNames: type: string additionalProperties: type: number reference_point: description: >- The point the API measures every distance in the response from: lat + lng, or the centre of the property_id parcel. Absent with a bare bbox. type: object properties: lat: type: number minimum: -90 maximum: 90 description: Latitude of the reference point. lng: type: number minimum: -180 maximum: 180 description: Longitude of the reference point. required: - lat - lng additionalProperties: false geometry: $ref: '#/components/schemas/MetaGeometry' description: >- The location that ran, defaults filled and keyed as the query is (see MetaGeometry), on REST only: the MCP meta carries reference_point alone. Present on every route that takes a location: the deal lists, summary and cells, the investors, wholesale listings and short-term rental parcels, and `/v1/buyers/match`. Also on the comps of a parcel, kind radius around the subject and property_id the subject, and on POST `/v1/properties/search` (a county-only body echoes nothing). The lender list and a lender's loans carry it when you gave a geometry, a zip or a city. They apply a geometry as the H3 res-8 cells whose centre lies inside it, and echo no county, because MetaGeometry has no county slot. Absent on a route with no location, and on `/v1/properties/resolve`, whose lat + lng is a hint for the nearest parcel, not an area that ran. resolved_from: description: >- Present when the id in the path was an old id of an earlier build: the ids the API followed through the alias table, in order. Store the id the response carries. type: array items: type: string coverage: type: array items: $ref: '#/components/schemas/Coverage' description: >- The markets the response draws on, with their counties, data end dates and data versions. dated: description: >- Present when the response carries a block that is a dated snapshot at its as-of date, not current data. Those blocks are the financing, lien and valuation blocks of the parcel products. One entry per dated block, with its as-of date. Absent when nothing in the response is dated. type: array items: $ref: '#/components/schemas/Dated' terms: type: string description: Attribution and data-use terms for the data in this response. build: type: object properties: states: type: array items: $ref: '#/components/schemas/LeanBuildState' description: Every served state, in state order. required: - states additionalProperties: false description: >- The publishes behind the response. The ETag and each cursor follow the newest publish, so a publish ends every cursor. The rows belong to no market of the deed registry, so meta.coverage is empty. required: - generated_at - coverage - terms - build additionalProperties: false description: >- Response metadata of the lean family: when the API produced it, and the publishes behind the rows. Problem: type: object properties: type: type: string description: >- URI of the problem: the Errors page of the documentation site, anchored at the code. title: type: string description: Short human-readable summary of the problem code. status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status. code: type: string description: >- Stable machine-readable code from the catalogue at https://developers.investorlift.com/problems.json. detail: type: string description: Human-readable explanation specific to this occurrence. instance: type: string description: Request path. request_id: type: string description: Request id to quote when you report a problem. errors: description: Per-parameter validation failures (400 only). type: array items: type: object properties: param: description: >- The offending parameter. Null when the problem is not about one parameter. type: - string - 'null' message: type: string description: What is wrong with it. code: type: string description: Machine-readable reason, for example invalid_enum_value. required: - param - message - code additionalProperties: false description: One validation failure. required: - type - title - status - code - detail - instance - request_id additionalProperties: {} description: >- RFC 9457 problem details (application/problem+json). Some codes add extra fields beside these: superseded_by, candidates, n_deals, cap, suggestion, markets, retry_after. LeanAgent: type: object properties: id: type: string description: >- The agent id: the state, a colon, agt, a colon and 12 hex characters. kind: description: >- The kind of the agent as the feed shows it: a person or a team. Null when the file carries none. type: - string - 'null' identity_basis: description: >- What made the mentions one agent: the licence, the phone, the email or the name. Null when the file carries none. type: - string - 'null' anchor_kind: description: >- The kind of the anchor value of the identity. Null when the file carries none. type: - string - 'null' anchor_shared: description: >- True when the anchor value is shared with another agent. Null when the file carries none. type: - boolean - 'null' name_variants: anyOf: - type: array items: type: string - type: 'null' description: >- Every spelling of the name in the feed, most frequent first. This host serves null here for a person. licence: anyOf: - $ref: '#/components/schemas/LeanAgentLicence' - type: 'null' description: The licence. This host serves null here for a person. brokerages: type: array items: $ref: '#/components/schemas/LeanBrokerage' description: The brokerages the agent listed under, most rows first. current_brokerage: description: >- The brokerage of the newest listing. Null when the file carries none. type: - string - 'null' counts: type: object properties: n_mentions: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The listing rows that name the agent. n_listings: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The distinct listings. n_active: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The active listings at the data end. n_pending: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The pending listings at the data end. n_sold: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The sold listings. n_off_market: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The listings that left the market unsold. n_listed_12m: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The listings started in the 12 months before the data end. first_listed_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The first listing date, YYYY-MM-DD. Null when unknown. last_listed_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The last listing date, YYYY-MM-DD. Null when unknown. n_zips: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The distinct ZIPs of the listings. last_zip: description: The ZIP of the newest listing. Null when the file carries none. type: - string - 'null' required: - n_mentions - n_listings - n_active - n_pending - n_sold - n_off_market - n_listed_12m - first_listed_on - last_listed_on - n_zips - last_zip additionalProperties: false description: The listing counts of the agent. required: - id - kind - identity_basis - anchor_kind - anchor_shared - name_variants - licence - brokerages - current_brokerage - counts description: >- The agent block of a person: the identity, the licence, the brokerages and the counts. LeanAgentOrg: type: object properties: side: type: string description: >- seller: the agent listed for the organization. buyer: the organization bought what the agent listed. org_id: type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: 'The organization: the key to `GET /v3/orgs/{id}`.' org_name: description: >- The display name of the organization. Null when the file carries none. type: - string - 'null' from_registry: description: >- True when the organization is one of the business registry. Null when the file carries none. type: - boolean - 'null' n_listings: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The listings behind the link. first_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The first listing date of the link, YYYY-MM-DD. Null when unknown. last_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The last listing date of the link, YYYY-MM-DD. Null when unknown. n_flagged: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The listings whose deed was a flagged purchase. required: - side - org_id - org_name - from_registry - n_listings - first_on - last_on - n_flagged additionalProperties: false description: One organization the agent is linked to through the listings. LeanOrgDealCounts: type: object properties: n_deals: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The flagged purchases of the organization, on any side of a deed. 0 when none. first_deal_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The date of its first deed, YYYY-MM-DD. Null when it has no deed. last_deal_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The date of its last deed, YYYY-MM-DD. Null when it has no deed. total_price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The sum of the prices of its purchases, whole US dollars. Null when no purchase carries a price. n_sold: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The deeds on which it sold. Null for a deed name and for a person, whose sales the build does not count. n_bought_from: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The distinct sellers it bought from. Null for a deed name and for a person. n_sold_to: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The distinct buyers it sold to. Null for a deed name and for a person. required: - n_deals - first_deal_date - last_deal_date - total_price - n_sold - n_bought_from - n_sold_to additionalProperties: false description: >- What the organization did on the deeds: its purchases, its sales, its counterparties, in counts. LeanPersonOrg: type: object properties: org_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. display_name: type: string description: The display name of the organization. n_entities: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The entities of the organization. required: - org_id - display_name - n_entities additionalProperties: false description: One organization of the business registry the person files with. LeanPersonFiling: type: object properties: entity_no: type: string description: The entity of the filing. entity_name: description: The name of the entity. Null when the file carries none. type: - string - 'null' title: description: The title on the filing. Null when the file carries none. type: - string - 'null' role: description: The role of the build. Null when the file carries none. type: - string - 'null' org_id: anyOf: - type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The organization id: the state, a colon and the anchor entity number for a registry organization, for example AZ:L16090024. For a deed name that no entity matched: the state, a colon, the word name, a colon and the name key, for example AZ:name:ACME HOLDINGS. The id is stable across builds while the anchor entity stays. - type: 'null' description: The organization of the entity. Null when the entity is in none. required: - entity_no - entity_name - title - role - org_id additionalProperties: false description: One filing of the person on one entity. LeanAddress: type: object properties: source: type: string enum: - deed_buyer - deed_seller - registry_office - registry_place - registry_agent - registry_filing - roll_mailing description: >- Where the address comes from. deed_buyer and deed_seller: the mailing address the subject gave on a deed, on that side. registry_office, registry_place and registry_agent: the principal office, the known place of business and the statutory agent of an entity of the organization. registry_filing: the address a person filed with on an entity. roll_mailing: the mailing address on the licence roll of the agent of a person. kind: type: string enum: - HOUSE - SUITE - POBOX description: >- The kind of the street line: a house, a suite or a unit, or a PO box. line: type: string description: The street line as written, upper case. city: description: The city as written. Null when the source gives none. type: - string - 'null' state: description: The 2-letter state of the address. Null when the source gives none. type: - string - 'null' zip: description: The 5-digit ZIP. Null when the source gives none. type: - string - 'null' n_rows: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The rows behind the address. Deeds for a deed address, entities for a registry address of an organization, filings for a filing address, 1 for a roll address. first_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The first date behind the address, YYYY-MM-DD: a deed date, or the formation date of an entity. Null for a filing. last_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The last date behind the address, YYYY-MM-DD. Null for a filing. is_generic: type: boolean description: >- True when more than five subjects of the state share the address: a professional office, a registered agent or a mail drop. n_subjects: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The subjects of the state that share the address. required: - source - kind - line - city - state - zip - n_rows - first_date - last_date - is_generic - n_subjects additionalProperties: false description: >- One reach address of an organization or a person, with its source, its kind and the rows behind it. MetaGeometry: type: object properties: kind: type: string enum: - radius - bbox - place description: >- Which location ran: radius, bbox or place. A radius uses a point, a parcel ID, or a resolved address. A bbox is a viewport. A place is a ZIP list or a postal city. lat: anyOf: - type: number minimum: -90 maximum: 90 description: WGS84 latitude. - type: 'null' description: >- The centre of the radius, or the reference point you gave beside a bbox or a place. For a property_id request the centre is the parcel centroid. Null when a bbox or a place had no reference point. lng: anyOf: - type: number minimum: -180 maximum: 180 description: WGS84 longitude. - type: 'null' description: The longitude beside lat. Null when lat is null. radius_miles: description: >- The radius that ran, in miles: the value you sent, or the default when you sent none. The default is 2 on the GET lists and 1 around property_id on POST `/v1/properties/search`. Null for a bbox or a place. type: - number - 'null' bbox: anyOf: - type: array prefixItems: - type: number minimum: -180 maximum: 180 description: West edge (longitude). - type: number minimum: -90 maximum: 90 description: South edge (latitude). - type: number minimum: -180 maximum: 180 description: East edge (longitude). - type: number minimum: -90 maximum: 90 description: North edge (latitude). items: false minItems: 4 maxItems: 4 description: '[west, south, east, north] in WGS84 degrees.' - type: 'null' description: >- The viewport as [west, south, east, north] in WGS84 degrees. Null unless kind is bbox. property_id: anyOf: - type: string pattern: ^prop_[0-9a-f]{32}$ description: >- Parcel id: prop_ followed by 32 hex characters, for example prop_e93c776c53354a88de4e58448a6bf21b. The prefix is part of the id. - type: 'null' description: >- The parcel at the centre of the radius. Null unless the request named property_id. address: description: >- Resolved situs line for an address search. Null for other location forms. This field describes the resolved parcel. type: - string - 'null' zip: anyOf: - type: array items: type: string pattern: ^\d{5}$ - type: 'null' description: >- The ZIP list as you sent it, for example ["85251", "85257"]. Null unless kind is place and the request named ZIPs. city: description: >- The postal city as the API compared it: trimmed and folded to upper case ("Scottsdale" ran as "SCOTTSDALE"). Null unless kind is place and the request named a city. type: - string - 'null' location_radius_m: description: >- Present when the property at the centre is listed on Investorlift. Then lat and lng are an approximate point, address is null, and this value is the radius in metres of the circle that contains the true point. The API measures each distance from the true point. anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' required: - kind - lat - lng - radius_miles - bbox - property_id - address - zip - city additionalProperties: false description: >- The location the API computed the response over, as it ran: defaults filled, a parcel resolved to its centroid, a city folded. Copy it back as the query to repeat the request. Coverage: type: object properties: market: type: string description: Market code, for example phx. One entry per loaded market. state: type: string description: >- 2-letter state of the market. The loaded markets and their states are in meta.coverage[]. counties: type: array items: type: object properties: fips: type: string description: The 5-digit county FIPS code, for example 04013. name: type: string description: County name, for example Maricopa. data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last deed date on file for this county, YYYY-MM-DD. Null when the county carries no dated deed. required: - fips - name - data_end additionalProperties: false description: One county the loaded area lies in. description: >- The counties the loaded area lies in, each with its own data end date. For a zip market the list names the county, but the loaded area is only the ZIP (see universe_kind). bbox: type: array prefixItems: - type: number minimum: -180 maximum: 180 description: West edge (longitude). - type: number minimum: -90 maximum: 90 description: South edge (latitude). - type: number minimum: -180 maximum: 180 description: East edge (longitude). - type: number minimum: -90 maximum: 90 description: North edge (latitude). items: false minItems: 4 maxItems: 4 description: >- The rectangle (west, south, east, north) that encloses every deal in the market: the initial map viewport and, with point_tolerance_miles, the limit for outside_coverage. data_end: type: string format: date description: >- The last deed date in the data, YYYY-MM-DD. The API measures every "days since" value from this data_end, never from the request time. build_run_id: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Which pipeline build produced the data. Informational: use dataset_version for caching. Null when the data does not record it. registry_run: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Which investor registry run produced the data. Informational: use dataset_version for caching. Null when the data does not record it. registry_version: description: >- Which registry code version produced the data. Informational: use dataset_version for caching. Null when the data does not record it. type: - string - 'null' dataset_version: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Version of the loaded data, an integer that grows with every refresh. It is the cache key and the ETag, and every cursor binds to it. loaded_at: type: string format: date-time description: When this data version went live, ISO 8601. metro_buy_to_resale_ratio: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The median of purchase price divided by resale price over the market's priced flips since 2021. For example, 0.72 means flippers pay about 72% of the resale price. The price_fit factor uses it when an investor has too few flips of their own. Null when no priced flips exist. universe_kind: anyOf: - type: string enum: - zip - county - metro description: >- The area every count in this market covers: metro, county or zip. A metro market covers whole counties. A county market covers one county. The market cannot see what an investor did in the neighbouring counties. A zip market covers one or more ZIP codes. The market cannot see what an investor did outside them, a larger gap. In a county or zip market every investor count, price band, scale tier and confidence is a floor. - type: 'null' description: >- Null when the market row does not record it, a seed older than the column. The area every count in this market covers: metro, county or zip. A metro market covers whole counties. A county market covers one county. The market cannot see what an investor did in the neighbouring counties. A zip market covers one or more ZIP codes. The market cannot see what an investor did outside them, a larger gap. In a county or zip market every investor count, price band, scale tier and confidence is a floor. universe_zips: anyOf: - type: array items: type: string description: A 5-digit ZIP. - type: 'null' description: >- The ZIP codes of a zip universe, for example ["77088"]. Null for county and metro markets. point_tolerance_miles: type: number description: >- How far outside bbox a point can lie and get an answer, in miles: 20 for a metro, 2 for a county market. The point is lat + lng, or the centre of a property_id parcel. Farther out, the API answers 422 outside_coverage. A bbox must intersect the coverage bbox. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels in the loaded area, the universe every count covers. Null when the data does not record it. listings_data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The as-of date of the MLS listing feed for this market, YYYY-MM-DD: the newest status update among its listing rows, later than data_end. The deeds and the listings arrive in one delivery, each with its own end. The API measures every listing window (days_on_market, n_listed_12m) against this date. Null when this market has no published listing tables. Every listing block and listings rollup is null then, and the correct reading is "no listing data". agents_data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The as-of date of the listing set behind the agent registry of this market, YYYY-MM-DD. It equals listings_data_end when the registry is current. It is earlier when a refresh moved the listings but left the agents on the older set. Null when this market has no published agent tables. Then every agent_id, identity_basis and agent_is_holder_member on the listing agents is null, and the investor profile carries has_licensed_member and agent_links null. The /v1/agents routes then answer 422 agents_unavailable. wholesale_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the Investorlift export behind the market's wholesale transactions, YYYY-MM-DD. Every Investorlift listing published up to this date is on file. The API measures every wholesale window (n_listed_12m, n_bought_via_investorlift_12m) against the deed data_end. Null when this market has no published wholesale tables. Then every wholesale_listing block on deal rows, wholesale_purchases block on investor rows and wholesale_listings[] on a parcel is null. Then /v1/wholesale-listings, /v1/wholesalers, `/v1/investors/{id}/wholesale-purchases` and the source=investorlift and bought_on_investorlift filters answer 422 wholesale_unavailable. str_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The short-term rental snapshot of this market, YYYY-MM-DD: the oldest snapshot date among its served jurisdictions. Each jurisdiction's own date is in str.jurisdictions[].snapshot_date and on every block as data_as_of. Null when this market has no published short-term rental tables, or when the API serves none of its jurisdictions. Then every short_term_rental block on parcels and hold rows and every str roll-up on investor rows is null. Then the str_status, str_business_use, str_operator and str_holdings_min filters and /v1/str-parcels answer 422 str_unavailable. str: anyOf: - type: object properties: jurisdictions: type: array items: $ref: '#/components/schemas/StrCoverageJurisdiction' description: >- Every city of the market the short-term rental build knows, served or not. This list, not the parcel, explains a null block on a parcel: read the city's coverage_reason. required: - jurisdictions additionalProperties: false - type: 'null' description: >- The short-term rental jurisdiction table of this market. Null when this market has no published short-term rental tables. auction_counted: type: boolean description: >- True when this market measures the foreclosure-auction and REO purchase counts. Then every investor row carries the auction block (investor.auction) and deal rows carry bought_auction_kind. False when the market's registry build came before the counts existed. Then the block is null on every investor of the market, and bought_auction_kind is null on every deal. The buys_at_auction, buys_reo and bought_auction_kind filters then answer 422 auction_unavailable. parcel_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The deed data end that the build of the parcel product layer used, YYYY-MM-DD. The layer serves POST /v1/properties/search and the financing, permit and history routes. Null when this market has no published parcel product tables: those routes then answer 422 parcels_unavailable. address_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The deed data end of the address table behind GET /v1/properties/resolve?address, YYYY-MM-DD. Null when this market has no published address table. The address lookup answers 422 addresses_unavailable while no market carries the table. parcel: anyOf: - $ref: '#/components/schemas/ParcelCoverage' - type: 'null' description: >- What the parcel products cover in this market. The parts are the layer, the dated financing slice, the permit snapshot, the Owner Profile block and the history lake with its ZIP set. Null when this market has no published parcel product tables. lenders: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The slice date behind the lender registry, YYYY-MM-DD. It equals parcel.financing.as_of. Null when the registry row does not record it. recordings_through: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest recording date in either source table, YYYY-MM-DD. The API measures every recency on a lender against this date. Null when the registry row does not record it. counties: type: array items: type: string description: A 5-digit county FIPS. description: >- The counties the lender registry covers. A ZIP, city or county outside them answers 422 outside_coverage. history_capture_share: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The share of open lien positions recorded since 2022 that the recorded history also carries within 3 days, 0 to 1. It says how much of the open table the history sees. Null when the registry did not measure it. n_lender_ids: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Lender ids served in the market: the identities with a profile, after the person gate. parcel.financing.n_lenders counts raw spellings, several per id. Null when the registry row does not record it. purchase_measured: type: boolean description: >- True when the market has the deed link. Then the API serves purpose and the deed block on the loan rows, and the purchase-money counts and ranks on the lenders. It also serves the lender list's purpose, investor_only and purchase_desc parameters. False on a registry built before the deed link: every such value is null, and those parameters answer 422 lenders_unavailable. investor_lending_measured: type: boolean description: >- True when the market has the deal link and the borrower match. Then the API serves the deal block, outcome and investor ids on the loan rows, and the investor_lending block on the profiles. It also serves the financing block on deal rows and the financing sidecar on investor profiles. False otherwise: every one of those is null. flips_measured: type: boolean description: >- True when the market measures the flips each lender financed, the flips_financed block on the profiles. False otherwise: the block is null. borrowers_measured: type: boolean description: >- True when the market has the borrower fold. Then the API serves borrower keys on the loan rows, the borrowers block on the profiles, GET `/v1/lenders/{id}/borrowers` and the financed_by and uses_private_lender filters. False otherwise: the block is null, and the route and the filters answer 422 lenders_unavailable. takebacks_measured: type: boolean description: >- True when the registry of this market includes the foreclosure take-backs. That needs the auction deed tables built and the lender members present. Then the API serves the takebacks block on the profiles, the foreclosed block on the loan rows and the FORECLOSED outcome. False otherwise: the block is null on every profile, and foreclosed is null on every loan row. counties_measured: type: boolean description: >- True when the market has more than one loaded county, so a county ranking means something: rankings.n_counties_ranked_first_24m on the profiles. False while the slice covers one county: that count is null. dated: description: >- True when the registry is a snapshot valued at as_of, like the financing slice behind it. The API stamps every value from it in meta.dated[] as the lenders block. Null on a registry row that does not record it, a row older than the column. type: - boolean - 'null' n_parcels_uncovered: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels of the market outside the counties the registry covers. Such a county is one the financing slice does not reach. Null when the row does not record it. required: - as_of - recordings_through - counties - history_capture_share - n_lender_ids - purchase_measured - investor_lending_measured - flips_measured - borrowers_measured - takebacks_measured - counties_measured - dated - n_parcels_uncovered additionalProperties: false - type: 'null' description: >- The lender registry of this market. Null when this market has no published lender tables: every /v1/lenders route then answers 422 lenders_unavailable. required: - market - state - counties - bbox - data_end - build_run_id - registry_run - registry_version - dataset_version - loaded_at - metro_buy_to_resale_ratio - universe_kind - universe_zips - point_tolerance_miles - n_parcels - listings_data_end - agents_data_end - wholesale_as_of - str_as_of - str - auction_counted - parcel_as_of - address_as_of - parcel - lenders additionalProperties: false description: >- One loaded market: the area its counts cover (universe_kind), the counties it lies in, how fresh it is, and its data version. Dated: type: object properties: block: type: string enum: - valuation - financing - liens - lenders description: >- The block of the response that is a snapshot at as_of, not current data. The values are valuation (the AVM, equity and LTV), financing (open liens and mortgage history), liens (involuntary liens) and lenders. The lenders block is the lender registry and every count on it, built from the same slice. as_of: type: string format: date description: >- The date of the delivery that valued the snapshot, YYYY-MM-DD: the same date as meta.coverage[].parcel.financing.as_of for the market. reason: type: string description: >- Why the block is dated, in one sentence: the dataset is not in the current delivery. required: - block - as_of - reason additionalProperties: false description: >- One block of the response that is a dated snapshot. Every response that carries a value from a dated block lists it here. A caller that cannot use dated data passes require_current: true. The API then answers 422 dated_refused instead. LeanBuildState: type: object properties: state: type: string pattern: ^[A-Z]{2}$ description: The 2-letter state code of a served state, for example AZ. build_id: description: >- The id of the build of the files, a hash of the recorded steps. Null while the files of the state are a trial and no build id exists. type: - string - 'null' built_at: anyOf: - type: string format: date-time description: Timestamp, ISO 8601. - type: 'null' description: >- When the last step of the build finished, ISO 8601. Null while the files carry no record. published_at: type: string format: date-time description: When the publish of the state wrote the served tables, ISO 8601. run_id: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The id of the publish that serves the rows of the state. It moves with each publish. required: - state - build_id - built_at - published_at - run_id additionalProperties: false description: 'One served state: its build and its publish.' LeanAgentLicence: type: object properties: digits: description: >- The digits of the licence number the build keyed the agent on. Null when the build keyed the agent on no licence. type: - string - 'null' state: description: The state of the licence. Null when the file carries none. type: - string - 'null' source: description: >- Where the licence came from: the feed, the roll or both. Null when the file carries none. type: - string - 'null' conflict: description: >- True when the feed and the roll disagree on the licence. Null when the file carries none. type: - boolean - 'null' roll: type: object properties: number: description: >- The licence number as the roll of licensees spells it. Null when the roll has no row. type: - string - 'null' status: description: The status on the roll. Null when the roll has no row. type: - string - 'null' type: description: The licence type on the roll. Null when the roll has no row. type: - string - 'null' employer: description: The employing broker on the roll. Null when the roll has no row. type: - string - 'null' original_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The original licence date on the roll, YYYY-MM-DD. Null when the roll has no row. expires_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The expiry date on the roll, YYYY-MM-DD. Null when the roll has no row. mailing_zip: description: >- The 5-digit mailing ZIP on the roll. Null when the roll has no row. type: - string - 'null' basis: description: >- How the roll row matched the agent. Null when the roll has no row. type: - string - 'null' required: - number - status - type - employer - original_on - expires_on - mailing_zip - basis additionalProperties: false description: The row of the state roll of licensees, when one matched. required: - digits - state - source - conflict - roll additionalProperties: false description: >- The licence of the agent: the digits the build keyed on, and the row of the roll. LeanBrokerage: type: object properties: name: type: string description: >- The brokerage as the feed spells it. A business name, served to every key. n_rows: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The listing rows under this brokerage. last_listed_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last listing date under this brokerage, YYYY-MM-DD. Null when unknown. office_address: description: >- The office address as the feed carried it. Null when the file carries none. type: - string - 'null' required: - name - n_rows - last_listed_on - office_address additionalProperties: false description: One brokerage the agent listed under. StrCoverageJurisdiction: type: object properties: name: type: string description: >- The jurisdiction, upper case, for example SCOTTSDALE, PHOENIX or HOUSTON: the city-limit polygon the parcel falls in, never the postal city. The same value as short_term_rental.coverage.jurisdiction on the parcels inside it. regime: anyOf: - type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN description: >- The city's rule on a short-term rental licence or permit. REQUIRED: an ordinance requires one. NOT_REQUIRED: the city has no requirement, so no roll exists. UNKNOWN: the survey did not cover the city. Null when the market row does not record it. - type: 'null' description: >- Null when the market row does not record it. The city's rule on a short-term rental licence or permit. REQUIRED: an ordinance requires one. NOT_REQUIRED: the city has no requirement, so no roll exists. UNKNOWN: the survey did not cover the city. Null when the market row does not record it. coverage_reason: anyOf: - type: string enum: - LOADED_SERVED - LOADED_UNVALIDATED - LOADED_COUNTS_ONLY - REQUIRED_NOT_PUBLISHED - NO_REQUIREMENT - NOT_SURVEYED description: >- Why parcels of this jurisdiction carry, or do not carry, a short-term rental block. LOADED_SERVED: the city's roll is on file, matched to parcels and served, so every parcel inside carries a block, NONE when it has no record. LOADED_UNVALIDATED: the roll is on file and matched, but without a spot check, so the block is present with status null and coverage.served false. LOADED_COUNTS_ONLY: the roll is on file for counts only, because no parcel match is possible for the file, so no block. No block for REQUIRED_NOT_PUBLISHED (licence required, no roll published), NO_REQUIREMENT (no licence required) or NOT_SURVEYED (outside the survey). Null when the market row does not record it. - type: 'null' description: >- Null when the market row does not record it. Why parcels of this jurisdiction carry, or do not carry, a short-term rental block. LOADED_SERVED: the city's roll is on file, matched to parcels and served, so every parcel inside carries a block, NONE when it has no record. LOADED_UNVALIDATED: the roll is on file and matched, but without a spot check, so the block is present with status null and coverage.served false. LOADED_COUNTS_ONLY: the roll is on file for counts only, because no parcel match is possible for the file, so no block. No block for REQUIRED_NOT_PUBLISHED (licence required, no roll published), NO_REQUIREMENT (no licence required) or NOT_SURVEYED (outside the survey). Null when the market row does not record it. served: type: boolean description: >- True when parcels inside this jurisdiction carry a measured status (LICENSED, PENDING, EXPIRED or NONE). False when they carry a block with status null, or no block at all: coverage_reason says why. snapshot_only: type: boolean description: >- True when the roll came from a single pull and has no weekly feed (Fountain Hills, Cave Creek). Its dates are the pull date, and the API never sets feed_stale. licence_start: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The earliest possible date of a licence in this jurisdiction, the day its ordinance took effect, YYYY-MM-DD, for example 2025-10-01 for Houston. Null when unknown, or when the city requires no licence. snapshot_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The snapshot the served blocks read, YYYY-MM-DD: short_term_rental.data_as_of on every parcel inside. Null when no roll is on file. feed_stale: type: boolean description: >- True when this week's feed failed the freshness rule and the API serves the last good snapshot instead. Every block inside then carries coverage.feed_stale true. False otherwise. sources: type: array items: $ref: '#/components/schemas/StrCoverageSource' description: >- The city files behind this jurisdiction, each with its newest load date and its stale flag. Empty when no roll is on file. n_licensed: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels inside with status LICENSED on this snapshot. Null when no roll is on file. n_pending: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Parcels inside with status PENDING. Null when no roll is on file. n_expired: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Parcels inside with status EXPIRED. Null when no roll is on file. n_advertised: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels the city lists as advertised without a licence, Scottsdale only. The API counts them and never serves them as a status. Null when the city publishes no such list. share_unmatched: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The share of the city's records that matched no parcel, 0 to 1, for example 0.04. Null when no roll is on file. share_assumed: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The share of attributed parcels with attribution_basis ASSUMED, 0 to 1. ASSUMED means the attribution has no date, no name and no regime bound. Null when no roll is on file. required: - name - regime - coverage_reason - served - snapshot_only - licence_start - snapshot_date - feed_stale - sources - n_licensed - n_pending - n_expired - n_advertised - share_unmatched - share_assumed additionalProperties: false description: >- One city of the market in the short-term rental build. It says if the licence roll is on file and served, how fresh it is, and what it counts. It explains a null short_term_rental block on a parcel: the block is null where the API does not serve the jurisdiction. ParcelCoverage: type: object properties: parcel_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The deed data end that the parcel layer build used, YYYY-MM-DD. Null when the coverage row does not record it. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels in the layer for this market. Null when the coverage row does not record it. sale_mortgage_measured: type: boolean description: >- True when the delivery records a purchase mortgage on at least one priced last sale in five of the market. Then cash_sale_proxy, the sale.cash_sale filter and the cash-buyer quicklist are measured. False below that bar, as in the 2026 deliveries, which carry the column empty. Then cash_sale_proxy is null on every parcel, and the filter and the quicklist answer 422 cash_sale_unavailable. financing: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the delivery that valued the financing, lien and valuation slice, YYYY-MM-DD. Null when the coverage row does not record it. dated: type: boolean description: >- True while the Recorder & Mortgage and AVM datasets are not in the current delivery, so the slice stays at as_of. The API then stamps every value from the slice in meta.dated[]. dated_reason: description: Why the slice is dated. Null when dated is false. type: - string - 'null' n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with a row in the slice. Null when the coverage row does not record it. n_with_open_lien: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with at least one open lien at as_of. Null when the coverage row does not record it. n_free_and_clear: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with zero open liens at as_of. Null when the coverage row does not record it. n_avm: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with an AVM at as_of. Null when the coverage row does not record it. n_involuntary: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with an involuntary lien at as_of. Null when the coverage row does not record it. n_lenders: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Distinct raw lender spellings over the two lien tables, not registry ids. For registry ids, read meta.coverage[].lenders.n_lender_ids. Null when the coverage row does not record it. required: - as_of - dated - dated_reason - n_parcels - n_with_open_lien - n_free_and_clear - n_avm - n_involuntary - n_lenders additionalProperties: false - type: 'null' description: The financing slice. Null when this market has none. permits: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The effective date of the loaded permit snapshot, YYYY-MM-DD. Null when the coverage row does not record it. n_permits: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Permits served for this market. Null when the coverage row does not record it. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with at least one permit. Null when the coverage row does not record it. n_unmatched: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Permits in the county file that landed on no parcel of the market, so the API does not serve them. Null when the coverage row does not record it. jurisdictions: anyOf: - type: array items: type: object properties: jurisdiction: description: >- The issuing city or county, upper case. Null when the file names none. type: - string - 'null' n_permits: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Permits the jurisdiction issued, all time. Null when the coverage row does not record it. last_issue_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest issue date of the jurisdiction, YYYY-MM-DD. Null when no permit of the jurisdiction carries an issue date. windows_measured: description: >- True when the jurisdiction issued a permit in the 12 months before as_of. False when it did not: its feed is stale, so its parcels carry null 24-month and 36-month windows. The rule applies in every market. Read those null windows (n_permits_24m, n_open_permits_12m, major_work_36m, tags_24m, job_value_24m) as unmeasured, not as permit-free. The negative permit filters of the search leave such parcels out. Null only on a coverage row built before the flag existed. type: - boolean - 'null' required: - jurisdiction - n_permits - last_issue_date - windows_measured additionalProperties: false - type: 'null' description: >- The issuing jurisdictions, largest first, each with its permit count, its newest issue date and its windows_measured flag. Null when the coverage row does not record them. required: - as_of - n_permits - n_parcels - n_unmatched - jurisdictions additionalProperties: false - type: 'null' description: The permit snapshot. Null when this market has none. owner_profile: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the delivery the Owner Profile block comes from, YYYY-MM-DD. Null when the coverage row does not record it. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels carrying a profile. Null when the coverage row does not record it. n_multi: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels whose owner holds two or more properties. Null when the coverage row does not record it. n_portfolio_5: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels whose owner holds five or more. Null when the coverage row does not record it. required: - as_of - n_parcels - n_multi - n_portfolio_5 additionalProperties: false - type: 'null' description: The Owner Profile block. Null when this market has none. history: anyOf: - type: object properties: first_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The first weekly file the history lake replayed (the baseline FULL), YYYY-MM-DD. Null when the lake has no file. last_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last weekly file replayed, YYYY-MM-DD. Null when the lake has no file. zips: anyOf: - type: array items: type: string - type: 'null' description: >- The ZIP codes the history lake covers. A parcel outside them has no history: `GET /v1/properties/{id}/history` answers 422 history_unavailable and the history block is null. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels observed in the ZIP set. Null when the coverage row does not record it. n_events: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Typed events on record. Null when the coverage row does not record it. n_weeks: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Weekly files replayed. Null when the coverage row does not record it. domains: anyOf: - type: object propertyNames: type: string additionalProperties: type: object properties: first_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The first weekly file with the domain, YYYY-MM-DD. Null when the lake has no file for it. last_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last weekly file with the domain, YYYY-MM-DD. Null when the lake has no file for it. n_events: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Typed events of the domain on record. Null when the coverage row does not record it. required: - first_week - last_week - n_events additionalProperties: false - type: 'null' description: >- Per domain, the weeks the lake covers it. Valuation and financing end at the financing slice date, financing.as_of. The rest run to last_week. Null when the coverage row does not record them. required: - first_week - last_week - zips - n_parcels - n_events - n_weeks - domains additionalProperties: false - type: 'null' description: The history lake. Null when this market has none. required: - parcel_as_of - n_parcels - sale_mortgage_measured - financing - permits - owner_profile - history additionalProperties: false description: >- What the parcel products cover in one market. The parts are the parcel layer, the dated financing slice, the permit snapshot, the Owner Profile block and the history lake. Each part carries its as-of date and its counts, and is null where the market has none of it. The block itself is null where the market has no parcel product tables. StrCoverageSource: type: object properties: source: type: string description: >- The source code of one city file, for example S1 (the Scottsdale licensed roll), P1 (the Phoenix active permits layer) or COH (the Houston registry). snapshot_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the newest load of this source, YYYY-MM-DD. Null before the first load of this source. stale: type: boolean description: >- True when the newest load failed the freshness rule and the API still serves the previous snapshot. A load fails the rule when the count moved more than 30 percent, or when its newest date is more than 14 days old. required: - source - snapshot_date - stale additionalProperties: false description: >- One city file behind a jurisdiction's short-term rental data: the date of its newest load, and if that load is stale. headers: ETag: description: >- The entity tag of the answer, derived from the dataset version of the markets in the response and from the representation, not from the body. It moves only when a refresh rebuilds the tables of a market. On a JSON route, send it back as If-None-Match, and an unchanged dataset answers 304 with no body. The API streams an export whatever the tag. GET /v1/dataset runs no query, so it is the lowest-cost place to send the tag. On every 2xx and the 304, never on an error. schema: type: string X-Request-Id: description: >- The id of this call. The edge mints it and also sends it as zp-rid, the gateway's own name for it. The API keys its log line for the call on it, and every error body repeats it as request_id. Log it on every response, not only on errors. A refusal the gateway answers itself carries zp-rid and request_id alone. Those refusals are a 401, a 403 quota_exceeded and a 429 at the limit of the plan. schema: type: string X-Rows: description: >- How many rows the body carries: data.length on a list, 1 on a single record. The size of the body, not a charge. Absent on a streamed export, whose count the API knows only when the stream ends, and on a 304. schema: type: integer minimum: 0 X-Dataset-Version: description: >- The dataset version of every market in the response, as market=version pairs joined by commas (phx=1788469819 for one market). The header carries one pair per loaded market. The figures are the same as meta.coverage[].dataset_version, and you can read them without parsing the body. A version moves only when a refresh rebuilds the tables of the market, so fold the label into cache keys. On every 2xx and the 304, never on an error. Absent when the answer names no market: an empty deployment, or a GET /v1/coverage lookup outside every market. schema: type: string X-Data-End: description: >- The last deed date of every market in the response, as market=YYYY-MM-DD pairs joined by commas (phx=2026-08-12 for one market). The header carries one pair per loaded market. The dates are the same as meta.coverage[].data_end. On every 2xx and the 304, never on an error. Absent when the answer names no market: an empty deployment, or a GET /v1/coverage lookup outside every market. schema: type: string Retry-After: description: >- Whole seconds to wait before you retry, never below 1. On a 429, the seconds until the spent bucket refills. On a 503, 1 for pool_saturated and 5 for ledger_unavailable, and none for database_unavailable. On a 403 plan_limit for the name-search day cap, the seconds to the next UTC midnight, when the cap resets. The other plan limits carry none. The body repeats it as retry_after on the 429, the ledger refusal and the day cap. schema: type: integer minimum: 1 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- API key from the developer console (starts with zpka_). Create one at https://developers.investorlift.com/get-a-key. The same key works on POST /mcp. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.