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

# Summarise deal activity

> One row of totals for an area: counts by kind, buyer status and purchase channel, investors, parcels, typical prices, hold time and profit.

One row of totals for the same location and filters that [`GET /v1/deals`](/api-reference/endpoints/deals-list) takes.
The location is a radius, a viewport, a parcel, a ZIP list or a postal city. So the header and the table below it always
agree.

## Use it when

You need the totals above a map or a table, or any total a paged list does not carry. It also costs no credits, so it is
a good first request when you check a key.

## Read the response

* `by_kind`, `by_buyer_status`, `by_year` and `by_scale` each sum to `n_deals`. **`by_investor_kind` does not**: a
  deal counts under every kind its investor carries. So a landlord who also flips counts twice. Deals whose buyer has
  no investor id count in the `kind: null` bucket.
* **`by_channel` does not sum to `n_deals` either.** It counts the deals by the channel the investor bought through.
  Each bucket reads one flag on the deal row:

  * `from_wholesaler`: `bought_from_wholesaler` is true.
  * `from_investor`: `bought_from_investor` is true, that is, the seller carried an investor id.
  * `distressed`: `bought_distressed` is true.
  * `auction`: `bought_auction_kind` is not null.

  A known wholesaler who is also a registered investor counts in two buckets. So does a distressed deed bought at
  auction. `auction` is null, never 0, where a market the location covers has `meta.coverage[].auction_counted` false.
* `other_or_unknown` is the deals in none of the four channel buckets. Deals whose purchase deed is unknown count
  there too. So `n_deals` minus that count is the deals in at least one bucket. It is not a count of purchases from a
  homeowner, because a contract assignment leaves no deed.
* `n_parcels` counts each parcel once even when it carries several deals, so it is at most `n_deals`.
  `n_investors` counts registered investors only.
* Medians are exact, not estimated. `median_bought_price` and `total_volume` use priced purchases only, and
  `n_unpriced` counts the unpriced purchases the API left out. `median_sold_price`, `median_hold_days` and
  `median_gross_profit` use resold deals only. Each is null when nothing qualifies.
* `meta.geometry` echoes the location the API computed the counts over. So you can ask for the header and the list
  under it with the same shape. [The envelope](/api-reference/objects/envelope) describes it.
* `by_year` groups the deals by purchase date, oldest first. Deals with no purchase date form one bucket with
  `year: null` at the end. `n_undated` counts them.
* `by_scale` has a `scale: null` row and `by_investor_kind` has a `kind: null` row. Both rows are for buyers without
  an investor id.

## Gotchas

* The same default exclusions as `/v1/deals` apply. So the numbers match the list and the cells under the same
  parameters.
* A 20 mile radius takes one to three seconds: about 400,000 deals and four exact medians. A 2 mile radius takes well
  under a second, and so does one ZIP. A whole city is a county-sized query and waits in the same queue as the large
  radii.
* `price_min` and `price_max` drop unpriced deals unless you pass `include_unpriced=true`. `bought_after` and
  `bought_before` drop undated deals unless you pass `include_undated=true`. Both flags change `n_unpriced` and
  `n_undated` to match.

## Related

[The calls behind a map](/guides/walkthroughs/map) shows this beside the cells.


## OpenAPI

````yaml GET /v1/deals/summary
openapi: 3.1.0
info:
  title: God Mode API
  version: 0.33.1
  description: >-
    You have a house to sell, usually a wholesale contract. You want to know
    **who nearby buys houses like this one and how to reach them**. County deed
    records already hold the answer. This API reads them 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`).


    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-six
    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: 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: 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:
  /v1/deals/summary:
    get:
      tags:
        - deals
      summary: Summarise deal activity around a location
      description: >-
        The headline numbers for an area: deals by kind, investors, parcels,
        typical prices, hold time and profit. Also the breakdown by year, by
        investor scale, by investor kind and by purchase channel.


        It takes exactly the location and the filters of `/v1/deals`, so the
        header and the table below it agree. The location is a radius, a
        viewport, a parcel, or a ZIP list or postal city. A paged list carries
        no totals, so this route serves them.


        [Which totals sum to what, and the median
        rules](https://developers.investorlift.com/api-reference/endpoints/deals-summary).
      operationId: getDealSummary
      parameters:
        - schema:
            minItems: 1
            type: array
            items:
              type: string
              enum:
                - flip
                - wholesale
                - hold
                - long_hold
                - other
                - build
              description: >-
                What occurred on the deal. flip: bought, fixed and resold within
                about a year at a profit-shaped margin; wholesale: bought and
                resold in under 30 days, or a chain resale or round trip within
                90 (a double close); hold: bought and still owned at data_end, a
                confirmed holding or an un-resold purchase; long_hold: held over
                a year, then sold (a landlord exit); other: an investor resale
                that is not a clean flip. Reasons: a loss, a thin margin, a
                builder's new home resold, an iBuyer resale, or a chain resale
                of 3 to 12 months; build: a registered investor bought a lot or
                teardown, built a house on it during the hold, then sold. A
                builder's finished home bought and resold is other. On data
                built after 2026-09-17 the kind keeps only a single-family
                parcel held over 90 days, its house complete by the sale year. A
                market built on or before 2026-09-17 (meta.coverage[].loaded_at)
                counts every lot-to-build resale by a registered investor as a
                build until its next build.
          in: query
          name: kind
          required: false
          description: >-
            Deal kinds to keep (comma list or repeated key). Default: every
            kind.
        - schema:
            type: integer
            minimum: 0
            maximum: 9007199254740991
          in: query
          name: price_min
          required: false
          description: >-
            Minimum bought price, inclusive, integer dollars. When you set
            price_min or price_max, the API drops null-priced rows unless
            include_unpriced=true.
        - schema:
            type: integer
            minimum: 0
            maximum: 9007199254740991
          in: query
          name: price_max
          required: false
          description: Maximum bought price, inclusive, integer dollars.
        - schema:
            type: string
          in: query
          name: bought_after
          required: false
          description: >-
            Keep deals bought on or after this date. When you set bought_after
            or bought_before, the API drops null-date rows unless
            include_undated=true.
        - schema:
            type: string
          in: query
          name: bought_before
          required: false
          description: Keep deals bought on or before this date.
        - schema:
            type: string
          in: query
          name: sold_after
          required: false
          description: 'Resold deals only: sold on or after this date.'
        - schema:
            type: string
          in: query
          name: sold_before
          required: false
          description: 'Resold deals only: sold on or before this date.'
        - schema:
            minItems: 1
            type: array
            items:
              type: string
              enum:
                - SFR
                - CONDO_TH
                - OTHER
              description: >-
                Parcel segment: SFR, CONDO_TH (condo or townhouse) or OTHER, a
                mixed bucket of manufactured, multi-family, land and commercial
                parcels.
          in: query
          name: segment
          required: false
          description: 'Parcel segments to keep. Default: every segment.'
        - schema:
            type: integer
            minimum: 0
            maximum: 50
          in: query
          name: beds_min
          required: false
          description: Minimum bedrooms, inclusive.
        - schema:
            type: integer
            minimum: 0
            maximum: 1000000
          in: query
          name: sqft_min
          required: false
          description: Minimum living area in square feet, inclusive, 0 to 1,000,000.
        - schema:
            type: integer
            minimum: 0
            maximum: 1000000
          in: query
          name: sqft_max
          required: false
          description: Maximum living area in square feet, inclusive, 0 to 1,000,000.
        - schema:
            minItems: 1
            type: array
            items:
              type: string
              enum:
                - FLIPPER
                - WHOLESALER
                - LANDLORD
                - BUILDER
                - IBUYER
              description: >-
                Investor kind, the primary one of kinds[] (an investor can carry
                several), for display only. FLIPPER: buys, renovates and
                resells. WHOLESALER: buys to resell quickly, often through a
                double close. LANDLORD: buys and holds rentals. BUILDER: builds
                on lots it buys. IBUYER: Opendoor, Offerpad or Zillow.
          in: query
          name: investor_kind
          required: false
          description: >-
            Keep investors that carry at least one listed kind. The check reads
            any of their kinds[], never the primary kind. Default: every kind.
            Buyers without an investor id pass unless registered_only=true.
        - schema:
            minItems: 1
            type: array
            items:
              type: string
              enum:
                - FLIPPER
                - WHOLESALER
                - LANDLORD
                - BUILDER
                - IBUYER
              description: >-
                Investor kind, the primary one of kinds[] (an investor can carry
                several), for display only. FLIPPER: buys, renovates and
                resells. WHOLESALER: buys to resell quickly, often through a
                double close. LANDLORD: buys and holds rentals. BUILDER: builds
                on lots it buys. IBUYER: Opendoor, Offerpad or Zillow.
          in: query
          name: investor_kind_exclude
          required: false
          description: >-
            Drop investors that carry any listed kind. The API checks kinds[]
            after investor_kind. investor_kind_exclude=WHOLESALER removes
            investors who also wholesale.
        - schema:
            type: string
            enum:
              - STRONG
              - PROBABLE
              - WEAK
          in: query
          name: investor_confidence_min
          required: false
          description: >-
            Minimum registry confidence in the investor kind: STRONG, PROBABLE
            or WEAK (WEAK admits everything).
        - schema:
            minItems: 1
            type: array
            items:
              type: string
              enum:
                - individual
                - small
                - mid
                - large
                - institutional
              description: >-
                Investor scale: individual (one person, no entity), small (fewer
                than 10 investment deals), mid (10 to 99), large (100 to 999) or
                institutional. An institutional investor is an iBuyer, a
                production builder, a bulk landlord with 500 or more holdings,
                or a known brand from a list. The registry counts the deals
                inside the area loaded for the market
                (meta.coverage[].universe_kind), so in a ZIP market the tier is
                a floor.
          in: query
          name: scale
          required: false
          description: >-
            Scale tiers to keep. Default: every tier except institutional. An
            explicit list replaces the default entirely. scale=institutional
            alone returns only institutional.
            scale=individual,small,mid,large,institutional returns everyone.
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: include_public
          required: false
          description: >-
            Include public-body investors (counties, cities, housing
            authorities) and their deals. Default false: every list endpoint
            hides them.
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: include_unpriced
          required: false
          description: >-
            Keep null-priced rows when you set price_min or price_max (default
            false).
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: include_undated
          required: false
          description: >-
            Keep null-date rows when you set bought_after or bought_before
            (default false).
        - schema:
            type: integer
            minimum: 1
            maximum: 600
          in: query
          name: active_within_months
          required: false
          description: >-
            Keep investors whose last purchase is at most this many months
            before data_end (data_end minus last_bought_on). Sales and transfers
            do not count. No default.
        - schema:
            type: integer
            minimum: 1
            maximum: 1000000
          in: query
          name: investor_deals_min
          required: false
          description: >-
            Minimum purchase events of that investor inside the geometry, 1 to
            1,000,000. The API applies it after the other filters.
        - schema:
            type: integer
            minimum: 0
            maximum: 1000000
          in: query
          name: holds_min
          required: false
          description: >-
            Investor filter: keep investors who hold at least this many parcels
            across the whole market at the deed data end
            (meta.coverage[].data_end). The count is the investor's n_holds:
            confirmed holdings plus un-resold purchases inside the area loaded
            for the market, not the holdings inside the geometry. Range 0 to
            1,000,000, inclusive. For example, holds_min=20 keeps the larger
            portfolios. Buyers without an investor id pass unless
            registered_only=true.
        - schema:
            type: integer
            minimum: 0
            maximum: 1000000
          in: query
          name: holds_max
          required: false
          description: >-
            Investor filter: keep investors who hold at most this many parcels
            across the whole market at the deed data end (n_holds). Range 0 to
            1,000,000, inclusive. holds_max=0 keeps the investors that hold
            nothing. Beside holds_min the pair is a band. Buyers without an
            investor id pass unless registered_only=true.
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: buys_wholesale
          required: false
          description: >-
            Investor filter: at least one bought-from-wholesaler deal in the 36
            months before data_end.
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: buys_at_auction
          required: false
          description: >-
            Investor filter: true keeps investors who bought at least one house
            at a foreclosure auction in the 24 months before data_end. A
            foreclosure auction is a trustee's sale or an Arizona sheriff's
            sale, and the filter reads investor.auction.is_active_auction_buyer.
            These buyers pay cash within a day and buy without an inspection.
            False keeps registered investors who did not. Buyers without an
            investor id pass unless registered_only=true. The API answers 422
            auction_unavailable in a market that does not publish its auction
            counts (meta.coverage[].auction_counted false).
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: buys_reo
          required: false
          description: >-
            Investor filter: true keeps investors who bought at least one house
            from a lender, servicer or agency after a foreclosure. The window is
            the 24 months before data_end, and the filter reads
            investor.auction.is_active_reo_buyer. A bank-owned (REO) sale gave
            the buyer weeks, an inspection and the option to finance: the weaker
            cash signal beside buys_at_auction. False keeps registered investors
            who did not, and buys_at_auction=true&buys_reo=false is the
            cash-only set. Buyers without an investor id pass unless
            registered_only=true. The API answers 422 auction_unavailable where
            the market does not publish its auction counts.
        - schema:
            minItems: 1
            type: array
            items:
              type: string
              enum:
                - TRUSTEE_SALE
                - SHERIFF_SALE
                - HOA_TRUSTEE_SALE
                - TAX_SALE
                - TAX_LIEN_DEED
              description: >-
                The kind of auction the purchase deed records: TRUSTEE_SALE and
                SHERIFF_SALE count toward buys_at_auction, and the API shows the
                other three but never counts them. TRUSTEE_SALE: a lender's
                foreclosure sale by the trustee, cash and final on the day,
                without redemption. In Arizona the buyer pays a $10,000 deposit
                and the full bid by 5 pm the next business day. In Texas it is
                the first-Tuesday courthouse sale, in Washington the Friday sale
                at the county's designated place under RCW 61.24. SHERIFF_SALE:
                a judicial sale under court order. In Arizona it is an HOA or
                judgment-lien sale, cash but subject to the first mortgage and
                to a 30-day or 6-month redemption. In Washington it is a
                judicial mortgage foreclosure or lien sale under RCW 6.21, with
                an 8-month or 1-year redemption. In Washington the sale is
                subject to the senior lien only when it is a lien sale.
                HOA_TRUSTEE_SALE: a Texas homeowners association foreclosure
                recorded as a trustee's deed, cash, subject to the first lien
                and to a 180-day redemption. TAX_SALE: a Texas constable or
                taxing-unit tax sale, cash, with a 180-day or 2-year redemption.
                In Washington it is the county treasurer's deed after the tax
                foreclosure judgment, with no redemption after the sale.
                TAX_LIEN_DEED: an Arizona treasurer's deed to a tax-lien holder,
                mostly vacant land, not an auction of the house.
          in: query
          name: bought_auction_kind
          required: false
          description: >-
            Deal filter: keep deals whose purchase deed was a third-party
            auction purchase of one of the listed kinds (comma list or repeated
            key). For example, bought_auction_kind=TRUSTEE_SALE keeps houses
            bought at a foreclosure sale. The API drops deals bought any other
            way and deals without a buy deed. The API answers 422
            auction_unavailable where the market does not publish its auction
            counts.
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: bought_from_wholesaler
          required: false
          description: >-
            Deal filter: bought through a documented double close from a
            wholesaler, or from a known wholesaler. Assignments leave no deed,
            so absence is not evidence.
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: bought_distressed
          required: false
          description: >-
            Deal filter: the buy leg was a distressed sale. That is a
            foreclosure, trustee, sheriff or tax instrument, a deed in lieu, or
            a deed the feed flags as REO. It is wider than bought_auction_kind,
            which keeps only third-party auction purchases.
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: registered_only
          required: false
          description: >-
            Keep only rows whose buyer carries an investor id (investor.id is
            not null).
        - schema:
            minItems: 1
            type: array
            items:
              type: string
              enum:
                - registered
                - unclassified
                - excluded
                - unknown
              description: >-
                The buyer's standing in the registry: registered (has an
                investor id), unclassified, excluded or unknown (the deed names
                no buyer). Unclassified: a named buyer the registry did not
                classify as an investor, usually a household. Excluded: a named
                buyer the registry deliberately left out. Those are custodian
                trusts, relocation companies, auction houses and ambiguous
                surnames.
          in: query
          name: buyer_status
          required: false
          description: Buyer statuses to keep.
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: str_operator
          required: false
          description: >-
            Investor filter: true keeps investors that hold at least one parcel
            with a business-use short-term-rental licence attributed to them.
            That is the str roll-up's n_holdings at 1 or more. False keeps
            investors with none. Buyers without an investor id pass unless
            registered_only=true. The API answers 422 str_unavailable when a
            market in play has no short-term rental tables
            (meta.coverage[].str_as_of null).
        - schema:
            type: integer
            minimum: 1
            maximum: 100000
          in: query
          name: str_holdings_min
          required: false
          description: >-
            Investor filter: at least this many of the investor's holdings carry
            a business-use short-term-rental licence attributed to them (the str
            roll-up's n_holdings), 1 or more. Buyers without an investor id pass
            unless registered_only=true. The API answers 422 str_unavailable
            when a market in play has no short-term rental tables.
        - schema:
            type: string
            pattern: ^len_[0-9a-f]{12}$
          in: query
          name: financed_by
          required: false
          description: >-
            Investor filter: keep investors with at least one recorded loan from
            this lender, as the main borrower of the mortgage or the open lien.
            The value is a lender id, len_ followed by 12 hex characters, for
            example len_d2028f0766fc from GET /v1/lenders/search. The match is
            investor_id on the lender's loan rows. The count is a floor: the
            recorded history sees about one loan in five. Buyers without an
            investor id pass unless registered_only=true. The API answers 422
            lenders_unavailable when a market in play has no lender registry
            with the borrower match (meta.coverage[].lenders null or
            borrowers_measured false).
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: uses_private_lender
          required: false
          description: >-
            Investor filter: true keeps investors with a loan from a private
            lender, recorded in the 24 months before the lender registry's slice
            date (meta.coverage[].lenders.as_of). A private lender is a
            hard-money lender by name or behaviour (is_hard_money) or an
            investor lender by behaviour (is_investor_lender). A lender whose
            class reads INDIVIDUAL or PRIVATE also counts as private. False
            keeps registered investors with none such, and the result is a floor
            of a partial feed. Buyers without an investor id pass unless
            registered_only=true. The API answers 422 lenders_unavailable when a
            market in play has no lender registry with the borrower match.
        - schema:
            type: string
            pattern: ^inv_[0-9a-f]{12}$
          in: query
          name: investor_id
          required: false
          description: >-
            Scope the rows to one buyer (the drawer's "Activity here"). The API
            follows an old id from an earlier data refresh to the investor that
            superseded it and echoes the old id in meta.resolved_from. A retired
            id is 410 gone.
        - schema:
            type: string
            pattern: ^deal_[0-9a-f]{32}$
          in: query
          name: deal_id
          required: false
          description: Scope the rows to one deal.
        - schema:
            type: number
            minimum: -90
            maximum: 90
          in: query
          name: lat
          required: false
          description: >-
            Point latitude (with lng). With radius_miles it is the search
            geometry. With bbox it is the reference point only.
        - schema:
            type: number
            minimum: -180
            maximum: 180
          in: query
          name: lng
          required: false
          description: Point longitude (with lat).
        - schema:
            type: number
            minimum: 0.25
            maximum: 20
          in: query
          name: radius_miles
          required: false
          description: >-
            Search radius in miles around the point or around the centre of the
            property_id parcel, 0.25 to 20 (default 2). Not allowed with bbox.
        - schema:
            type: string
          in: query
          name: bbox
          required: false
          description: >-
            Viewport as west,south,east,north (WGS84 degrees). West must be less
            than east, south less than north, and the diagonal at most 40 mi. It
            must intersect a loaded market's coverage bbox (422 outside_coverage
            otherwise). It can carry lat + lng (without radius_miles) as the
            reference point for distances and sort=distance.
        - schema:
            type: string
            pattern: ^prop_[0-9a-f]{32}$
          in: query
          name: property_id
          required: false
          description: >-
            Parcel geometry: search around the centre of that parcel, with
            radius_miles. Not allowed with lat, lng or bbox.
        - schema:
            minItems: 1
            maxItems: 50
            type: array
            items:
              type: string
              pattern: ^\d{5}$
          in: query
          name: zip
          required: false
          description: >-
            Place geometry: the parcels of these 5-digit ZIP codes, as a comma
            list or a repeated key, up to 50. On the deal and investor routes
            the Free and Starter plans take exactly one ZIP, and more is 403
            plan_limit. You can add lat + lng as the reference point for
            distances. Not with radius_miles, bbox, property_id or city. A ZIP
            that no parcel of a loaded market carries is 422 outside_coverage
            (zips_unknown in the body).
        - schema:
            type: string
            minLength: 1
            maxLength: 100
          in: query
          name: city
          required: false
          description: >-
            Place geometry: the parcels whose postal city is this one, as the
            county records it ("Scottsdale"). Case does not matter: the API
            compares the value folded upper case. Never the short-term rental
            jurisdiction (meta.coverage[].str.jurisdictions[]). You can add lat
            + lng as the reference point, but not radius_miles, bbox,
            property_id or zip. On the deal and investor routes of the Free and
            Starter plans a city-wide search is 403 plan_limit. A city that no
            parcel of a loaded market carries is 422 outside_coverage.
        - schema:
            minItems: 1
            type: array
            items:
              type: string
              enum:
                - LICENSED
                - PENDING
                - EXPIRED
              description: >-
                The short-term rental status a holding must carry for the API to
                keep the row: the block's status. LICENSED means an active
                licence or permit, PENDING an application on file with none
                active, and EXPIRED every record on the parcel inactive. The API
                keeps a row when any of the values matches. Rows that are not
                holdings (flips, wholesales, resold purchases) carry no block
                and never match. The API serves NONE on rows, but NONE is not
                filterable in this release (400 for the value).
          in: query
          name: str_status
          required: false
          description: >-
            Keep only holdings whose short-term rental status matches one of the
            values (comma list or repeated key): LICENSED, PENDING or EXPIRED,
            the block's status. The API serves NONE on rows, but NONE is not
            filterable in this release (400 for the value). The API applies the
            filter before it cuts the page. Rows that are not holdings never
            match. 422 str_unavailable when a market in play has no short-term
            rental tables (meta.coverage[].str_as_of null). Default: every row.
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: str_business_use
          required: false
          description: >-
            With true, keep only hold rows whose licence is a business use
            attributed to the current owner: the UI's short-term rental deal
            type. With false, keep only hold rows whose licence is not one: a
            person's own home with a casita permit, or a prior owner's permit.
            Without str_status the test covers LICENSED and PENDING records, the
            only ones where business_use is true. Combine it with str_status to
            widen or narrow. The API applies the filter before it cuts the page.
            Rows that are not holdings never match. 422 str_unavailable when a
            market in play has no short-term rental tables
            (meta.coverage[].str_as_of null). Default: every row.
      responses:
        '200':
          description: Header statistics for the geometry.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DealSummaryStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
                additionalProperties: false
                description: Header statistics for the geometry.
              example:
                data:
                  n_deals: 1200
                  by_kind:
                    flip: 214
                    wholesale: 92
                    hold: 822
                    long_hold: 31
                    other: 33
                    build: 8
                  by_buyer_status:
                    registered: 1176
                    unclassified: 14
                    excluded: 9
                    unknown: 1
                  by_channel:
                    from_wholesaler: 125
                    from_investor: 242
                    distressed: 28
                    auction: 20
                    other_or_unknown: 925
                  n_investors: 871
                  n_parcels: 1028
                  n_unpriced: 159
                  n_undated: 0
                  median_bought_price: 490000
                  median_sold_price: 569500
                  total_volume: 682783819
                  median_hold_days: 134
                  median_gross_profit: 106000
                  by_year:
                    - year: 2024
                      'n': 461
                      flip: 97
                      wholesale: 32
                      hold: 287
                      long_hold: 24
                      other: 14
                      build: 7
                    - year: 2025
                      'n': 451
                      flip: 103
                      wholesale: 33
                      hold: 294
                      long_hold: 7
                      other: 13
                      build: 1
                    - year: 2026
                      'n': 288
                      flip: 14
                      wholesale: 27
                      hold: 241
                      long_hold: 0
                      other: 6
                      build: 0
                  by_scale:
                    - scale: individual
                      'n': 140
                    - scale: small
                      'n': 680
                    - scale: mid
                      'n': 243
                    - scale: large
                      'n': 113
                    - scale: null
                      'n': 24
                  by_investor_kind:
                    - kind: LANDLORD
                      'n': 1089
                    - kind: FLIPPER
                      'n': 449
                    - kind: WHOLESALER
                      'n': 261
                    - kind: BUILDER
                      'n': 152
                    - kind: null
                      'n': 24
                meta:
                  generated_at: '2026-09-03T21:40:00.000Z'
                  reference_point:
                    lat: 33.476917
                    lng: -111.920385
                  geometry:
                    kind: radius
                    lat: 33.476917
                    lng: -111.920385
                    radius_miles: 2
                    bbox: null
                    property_id: null
                    zip: null
                    city: null
                  coverage:
                    - market: phx
                      state: AZ
                      counties:
                        - fips: '04013'
                          name: Maricopa
                          data_end: '2026-08-12'
                        - fips: '04021'
                          name: Pinal
                          data_end: '2026-08-06'
                      bbox:
                        - -113.332773
                        - 32.46915
                        - -110.455491
                        - 33.999503
                      data_end: '2026-08-12'
                      build_run_id: 1
                      registry_run: 7
                      registry_version: v4-metro-review-fixes
                      dataset_version: 1788469819
                      loaded_at: '2026-09-03T21:10:18.682Z'
                      metro_buy_to_resale_ratio: 0.7192
                      universe_kind: metro
                      universe_zips: null
                      point_tolerance_miles: 20
                      n_parcels: null
                      listings_data_end: '2026-08-31'
                      agents_data_end: '2026-08-31'
                      wholesale_as_of: '2026-09-09'
                      str_as_of: null
                      str: null
                      auction_counted: true
                      parcel_as_of: null
                      address_as_of: null
                      parcel: null
                      lenders: null
                  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
          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 (dataset_unavailable, geometry_conflict,
            geometry_required, invalid_cursor, invalid_id, market_required,
            quicklist_unavailable, sort_requires_point, unknown_parameter,
            validation_error)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                geometry_conflict:
                  summary: Geometry conflict
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#geometry_conflict
                    title: Geometry conflict
                    status: 400
                    code: geometry_conflict
                    detail: >-
                      You cannot combine radius_miles with bbox. Send one
                      geometry only.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                geometry_required:
                  summary: Geometry required
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#geometry_required
                    title: Geometry required
                    status: 400
                    code: geometry_required
                    detail: >-
                      The request needs one geometry: lat and lng with
                      radius_miles, bbox, property_id, zip (a list) or city.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                invalid_cursor:
                  summary: Invalid cursor
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#invalid_cursor
                    title: Invalid cursor
                    status: 400
                    code: invalid_cursor
                    detail: >-
                      The API issued the cursor for another query. Restart from
                      page 1.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                invalid_id:
                  summary: Invalid id
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#invalid_id
                    title: Invalid id
                    status: 400
                    code: invalid_id
                    detail: >-
                      An investor id is inv_ followed by 12 hex characters. The
                      prefix is part of the id.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                market_required:
                  summary: Market required
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#market_required
                    title: Market required
                    status: 400
                    code: market_required
                    detail: >-
                      inv_0a20a550f33b exists in 2 loaded markets. Pass market=.
                      The codes are in markets[].
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                    markets:
                      - phx
                      - hou
                    errors:
                      - param: market
                        message: one of phx, hou
                        code: market_required
                sort_requires_point:
                  summary: Sort requires a reference point
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#sort_requires_point
                    title: Sort requires a reference point
                    status: 400
                    code: sort_requires_point
                    detail: >-
                      sort=distance needs a reference point: add lat and lng, or
                      property_id.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                unknown_parameter:
                  summary: Unknown parameter
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#unknown_parameter
                    title: Unknown parameter
                    status: 400
                    code: unknown_parameter
                    detail: >-
                      The query carries a parameter this endpoint does not
                      define: kind[]. Write the list as kind=flip,hold or as
                      repeated keys.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                    errors:
                      - param: kind[]
                        message: unknown parameter
                        code: unknown_parameter
                validation_error:
                  summary: Validation error
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#validation_error
                    title: Validation error
                    status: 400
                    code: validation_error
                    detail: radius_miles must be 20 or less.
                    instance: /v1/deals/summary
                    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: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '403':
          description: >-
            Forbidden (payment_overdue, plan_limit, quota_exceeded,
            subscription_required)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                plan_limit:
                  summary: Plan limit
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#plan_limit
                    title: Plan limit
                    status: 403
                    code: plan_limit
                    detail: >-
                      The free plan searches within 5 miles of a point, a
                      viewport up to 10 miles across, or one ZIP code. Your zip
                      parameter lists 2 ZIP codes. Upgrade in the developer
                      console for city-wide and multi-ZIP searches.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                    tier: free
                    limit: geometry
                    max_radius_miles: 5
                    max_bbox_diagonal_miles: 10
                    max_zips: 1
                quota_exceeded:
                  summary: Quota exceeded
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#quota_exceeded
                    title: Quota exceeded
                    status: 403
                    code: quota_exceeded
                    detail: >-
                      Your requests spent the plan's credits for this billing
                      period (5000 of 5000). Wait for the period to reset on the
                      subscription's billing date, or upgrade in the developer
                      console.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                    used: 5000
                    line: 5000
                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: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                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: /v1/deals/summary
                    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: /v1/deals/summary
                    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: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '410':
          description: >-
            Gone: a retired investor, agent or lender id, with superseded_by
            (gone)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                gone:
                  summary: Gone
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#gone
                    title: Gone
                    status: 410
                    code: gone
                    detail: >-
                      The registry retired investor inv_003c1db2782c in run 8
                      (RETIRED). No current investor holds its names. Use
                      /v1/investors/search instead.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                    superseded_by: null
                    reason: RETIRED
                    market: phx
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '422':
          description: >-
            Unprocessable (addresses_unavailable, agents_unavailable,
            ambiguous_address, ambiguous_apn, auction_unavailable,
            cash_sale_unavailable, dated_refused, history_unavailable,
            lenders_unavailable, listings_unavailable, outside_coverage,
            parcels_unavailable, str_unavailable, wholesale_unavailable)
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                agents_unavailable:
                  summary: Agents unavailable
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#agents_unavailable
                    title: Agents unavailable
                    status: 422
                    code: agents_unavailable
                    detail: >-
                      This market has no published agent registry. See
                      meta.coverage[].agents_data_end.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                auction_unavailable:
                  summary: Auction counts unavailable
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#auction_unavailable
                    title: Auction counts unavailable
                    status: 422
                    code: auction_unavailable
                    detail: >-
                      This market has no published foreclosure-auction counts:
                      its registry predates them. So the API cannot answer
                      buys_at_auction, buys_reo and bought_auction_kind there,
                      and meta.coverage[].auction_counted is false for it. Drop
                      the parameter to list every row.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                lenders_unavailable:
                  summary: Lenders unavailable
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#lenders_unavailable
                    title: Lenders unavailable
                    status: 422
                    code: lenders_unavailable
                    detail: >-
                      Market hou has no published lender registry
                      (meta.coverage[].lenders is null there). The API still
                      serves the financing block on parcels where the slice is.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                    markets:
                      - hou
                listings_unavailable:
                  summary: Listings unavailable
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#listings_unavailable
                    title: Listings unavailable
                    status: 422
                    code: listings_unavailable
                    detail: >-
                      You gave listing_status for a market with no published
                      listing tables. See meta.coverage[].listings_data_end.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                outside_coverage:
                  summary: Outside coverage
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#outside_coverage
                    title: Outside coverage
                    status: 422
                    code: outside_coverage
                    detail: >-
                      The point 40.712776, -74.005974 is outside every loaded
                      market's point tolerance (loaded: phx, hou). See
                      meta.coverage[].bbox and point_tolerance_miles on any list
                      response.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                str_unavailable:
                  summary: Short-term rental data unavailable
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#str_unavailable
                    title: Short-term rental data unavailable
                    status: 422
                    code: str_unavailable
                    detail: >-
                      This market has no published short-term rental tables. See
                      meta.coverage[].str_as_of.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                wholesale_unavailable:
                  summary: Wholesale transactions unavailable
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#wholesale_unavailable
                    title: Wholesale transactions unavailable
                    status: 422
                    code: wholesale_unavailable
                    detail: >-
                      This market has no published Investorlift wholesale
                      tables. See meta.coverage[].wholesale_as_of.
                    instance: /v1/deals/summary
                    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: /v1/deals/summary
                    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: /v1/deals/summary
                    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, ledger_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: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                ledger_unavailable:
                  summary: Ledger unavailable
                  value:
                    type: >-
                      https://developers.investorlift.com/guides/concepts/errors#ledger_unavailable
                    title: Ledger unavailable
                    status: 503
                    code: ledger_unavailable
                    detail: >-
                      The credit ledger is unreachable. The API charged nothing.
                      Retry in 5 seconds.
                    instance: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
                    retry_after: 5
                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: /v1/deals/summary
                    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: /v1/deals/summary
                    request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
components:
  schemas:
    DealSummaryStats:
      type: object
      properties:
        n_deals:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Deal rows inside the geometry after the filters.
        by_kind:
          type: object
          properties:
            flip:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: 'Flips: bought, fixed and resold within about a year.'
            wholesale:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: >-
                Wholesales: resold in under 30 days, or a chain resale or round
                trip within 90.
            hold:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: 'Holds: bought and held at the deed data end.'
            long_hold:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: 'Long holds: held over a year, then sold.'
            other:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: 'Other investor resales: not a clean flip.'
            build:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: >-
                Builds: lots or teardowns a registered investor bought, built
                on, then sold, under the bounds of the build kind. A market
                built on or before 2026-09-17 (meta.coverage[].loaded_at) counts
                every lot-to-build resale by a registered investor as a build
                until its next build.
          required:
            - flip
            - wholesale
            - hold
            - long_hold
            - other
            - build
          additionalProperties: false
          description: Rows per deal kind.
        by_buyer_status:
          $ref: '#/components/schemas/ByBuyerStatus'
        by_channel:
          $ref: '#/components/schemas/ByChannel'
        n_investors:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Distinct registered investors behind those rows.
        n_parcels:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: 'Distinct parcels: a parcel with several deals counts once.'
        n_unpriced:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Rows with no price on the deed.
        n_undated:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Rows with no purchase date.
        median_bought_price:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: Whole US dollars.
            - type: 'null'
          description: Median purchase price over priced rows, whole dollars.
        median_sold_price:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: Whole US dollars.
            - type: 'null'
          description: Median resale price over priced resold rows.
        total_volume:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: Whole US dollars.
            - type: 'null'
          description: Sum of purchase prices over priced rows, whole dollars.
        median_hold_days:
          description: Median days from purchase to resale over resold rows.
          type:
            - number
            - 'null'
        median_gross_profit:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: Whole US dollars.
            - type: 'null'
          description: Median sold minus bought over resold rows, whole dollars.
        by_year:
          type: array
          items:
            $ref: '#/components/schemas/SummaryYear'
          description: >-
            Deals per purchase year and kind, oldest year first. Undated deals
            form one bucket with year null at the end. The buckets sum to
            n_deals.
        by_scale:
          type: array
          items:
            type: object
            properties:
              scale:
                anyOf:
                  - type: string
                    enum:
                      - individual
                      - small
                      - mid
                      - large
                      - institutional
                    description: >-
                      Investor scale: individual (one person, no entity), small
                      (fewer than 10 investment deals), mid (10 to 99), large
                      (100 to 999) or institutional. An institutional investor
                      is an iBuyer, a production builder, a bulk landlord with
                      500 or more holdings, or a known brand from a list. The
                      registry counts the deals inside the area loaded for the
                      market (meta.coverage[].universe_kind), so in a ZIP market
                      the tier is a floor.
                  - type: 'null'
                description: >-
                  Investor scale tier. Null for buyers without an investor id.
                  Investor scale: individual (one person, no entity), small
                  (fewer than 10 investment deals), mid (10 to 99), large (100
                  to 999) or institutional. An institutional investor is an
                  iBuyer, a production builder, a bulk landlord with 500 or more
                  holdings, or a known brand from a list. The registry counts
                  the deals inside the area loaded for the market
                  (meta.coverage[].universe_kind), so in a ZIP market the tier
                  is a floor.
              'n':
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                description: Deals whose buyer is in this tier.
            required:
              - scale
              - 'n'
            additionalProperties: false
            description: One scale tier.
          description: >-
            Rows per investor scale tier, individual first. Buyers without an
            investor id form a scale: null bucket last. The buckets sum to
            n_deals.
        by_investor_kind:
          type: array
          items:
            type: object
            properties:
              kind:
                anyOf:
                  - type: string
                    enum:
                      - FLIPPER
                      - WHOLESALER
                      - LANDLORD
                      - BUILDER
                      - IBUYER
                    description: >-
                      Investor kind, the primary one of kinds[] (an investor can
                      carry several), for display only. FLIPPER: buys, renovates
                      and resells. WHOLESALER: buys to resell quickly, often
                      through a double close. LANDLORD: buys and holds rentals.
                      BUILDER: builds on lots it buys. IBUYER: Opendoor,
                      Offerpad or Zillow.
                  - type: 'null'
                description: >-
                  Investor kind. Null for buyers without an investor id.
                  Investor kind, the primary one of kinds[] (an investor can
                  carry several), for display only. FLIPPER: buys, renovates and
                  resells. WHOLESALER: buys to resell quickly, often through a
                  double close. LANDLORD: buys and holds rentals. BUILDER:
                  builds on lots it buys. IBUYER: Opendoor, Offerpad or Zillow.
              'n':
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                description: Deals whose buyer carries this kind.
            required:
              - kind
              - 'n'
            additionalProperties: false
            description: One investor kind.
          description: >-
            Rows per investor kind, largest first. Buyers without an investor id
            form a kind: null bucket. A deal counts under every kind its
            investor carries, so the buckets overlap and do not sum to n_deals.
      required:
        - n_deals
        - by_kind
        - by_buyer_status
        - by_channel
        - n_investors
        - n_parcels
        - n_unpriced
        - n_undated
        - median_bought_price
        - median_sold_price
        - total_volume
        - median_hold_days
        - median_gross_profit
        - by_year
        - by_scale
        - by_investor_kind
      additionalProperties: false
      description: >-
        Headline numbers for the geometry after the filters, with the per-year
        breakdown by kind.
    Meta:
      type: object
      properties:
        generated_at:
          type: string
          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 an id in the request was an old id from an earlier data
            refresh: the old ids the API followed, in order. The ids are the
            investor id, from the path or the investor_id filter, the agent id
            and the lender id. The lender id comes from the path of the lender
            routes, the financed_by filter or filters.financing.lender_id. Store
            the id the response carries, not the old one.
          type: array
          items:
            type: string
            pattern: ^(inv|agt|len)_[0-9a-f]{12}$
            description: >-
              An investor id (inv_...), a listing agent id (agt_...) or a lender
              id (len_...).
        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.
      required:
        - generated_at
        - coverage
        - terms
      additionalProperties: false
      description: >-
        Response metadata: when the API produced it, which markets it covers,
        and how fresh they are.
    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.
    ByBuyerStatus:
      type: object
      properties:
        registered:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Rows whose buyer carries an investor id.
        unclassified:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Rows whose buyer has a name but no investor classification (usually
            a household).
        excluded:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Rows whose buyer the registry deliberately left out: custodian
            trusts, relocation companies, auction houses and ambiguous surnames.
        unknown:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Rows with no named buyer on the deed.
      required:
        - registered
        - unclassified
        - excluded
        - unknown
      additionalProperties: false
      description: Deal rows inside the geometry after the shared filters, by buyer status.
    ByChannel:
      type: object
      properties:
        from_wholesaler:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Rows whose bought_from_wholesaler is true: bought through a
            documented double close from a wholesaler, or from a known
            wholesaler. A contract assignment leaves no deed, so a row outside
            this count can be a wholesale buy too.
        from_investor:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Rows whose bought_from_investor is true: the seller carried an
            investor id.
        distressed:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Rows whose bought_distressed is true: the purchase deed was a
            distressed sale (foreclosure, trustee, tax).
        auction:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            - type: 'null'
          description: >-
            Rows whose bought_auction_kind is not null: the purchase deed was a
            third-party auction purchase of any kind. The shown-but-not-counted
            kinds HOA_TRUSTEE_SALE, TAX_SALE and TAX_LIEN_DEED count here, so
            this is not the count behind buys_at_auction. Null, never 0, where
            any market the location covers has meta.coverage[].auction_counted
            false. That market has no published auction counts, and such a
            purchase counts under distressed alone.
        other_or_unknown:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Rows in none of the four buckets: bought_from_wholesaler,
            bought_from_investor and bought_distressed each false or null, and
            bought_auction_kind null. A deal whose purchase deed is unknown
            lands here. Not a count of purchases from a homeowner: a contract
            assignment leaves no deed, so a wholesale buy can sit here too.
      required:
        - from_wholesaler
        - from_investor
        - distressed
        - auction
        - other_or_unknown
      additionalProperties: false
      description: >-
        Deal rows inside the geometry after the shared filters, by the channel
        the investor bought through. Each named bucket counts the rows whose own
        flag is true. So one deal can sit in several, and the five do not sum to
        n_deals. Examples: a known wholesaler who is also a registered investor,
        or a distressed deed bought at auction. The bucket other_or_unknown is
        the rows in none of the four, so n_deals minus it is the rows in at
        least one.
    SummaryYear:
      type: object
      properties:
        year:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            - type: 'null'
          description: >-
            Four-digit purchase year, for example 2024. Null for the bucket of
            deals with no purchase date. That bucket comes last.
        'n':
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Deals bought that year after the filters.
        flip:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Of those, flips.
        wholesale:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Of those, wholesales.
        hold:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Of those, parcels an investor still holds.
        long_hold:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Of those, held over a year and then resold.
        other:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Of those, other investor resales.
        build:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Of those, builds, under the bounds of the build kind. A market built
            on or before 2026-09-17 (meta.coverage[].loaded_at) counts every
            lot-to-build resale by a registered investor as a build until its
            next build.
      required:
        - year
        - 'n'
        - flip
        - wholesale
        - hold
        - long_hold
        - other
        - build
      additionalProperties: false
      description: Deals bought in one year, by kind.
    MetaGeometry:
      type: object
      properties:
        kind:
          type: string
          enum:
            - radius
            - bbox
            - place
          description: >-
            Which location ran: radius, bbox or place. A radius is a point with
            radius_miles, or a property_id request, which runs around the parcel
            centroid. 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.
        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'
      required:
        - kind
        - lat
        - lng
        - radius_miles
        - bbox
        - property_id
        - 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
                    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
          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
          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
              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
              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
              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
              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
              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
              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
                      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.
                recordings_through:
                  anyOf:
                    - type: string
                      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.
                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.
                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.
                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
          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.
    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
              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
              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
              description: Calendar date, YYYY-MM-DD.
            - type: 'null'
          description: The deed data end that the parcel layer build used, YYYY-MM-DD.
        n_parcels:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            - type: 'null'
          description: Parcels in the layer for this market.
        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
                      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.
                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.
                  type:
                    - string
                    - 'null'
                n_parcels:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Parcels with a row in the slice.
                n_with_open_lien:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Parcels with at least one open lien at as_of.
                n_free_and_clear:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Parcels with zero open liens at as_of.
                n_avm:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Parcels with an AVM at as_of.
                n_involuntary:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Parcels with an involuntary lien at as_of.
                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.
              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
                      description: Calendar date, YYYY-MM-DD.
                    - type: 'null'
                  description: >-
                    The effective date of the loaded permit snapshot,
                    YYYY-MM-DD.
                n_permits:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Permits served for this market.
                n_parcels:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Parcels with at least one permit.
                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.
                jurisdictions:
                  anyOf:
                    - type: array
                      items:
                        type: object
                        properties:
                          jurisdiction:
                            type:
                              - string
                              - 'null'
                          n_permits:
                            anyOf:
                              - type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              - type: 'null'
                          last_issue_date:
                            anyOf:
                              - type: string
                                description: Calendar date, YYYY-MM-DD.
                              - type: 'null'
                          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.
              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
                      description: Calendar date, YYYY-MM-DD.
                    - type: 'null'
                  description: >-
                    The date of the delivery the Owner Profile block comes from,
                    YYYY-MM-DD.
                n_parcels:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Parcels carrying a profile.
                n_multi:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Parcels whose owner holds two or more properties.
                n_portfolio_5:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Parcels whose owner holds five or more.
              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
                      description: Calendar date, YYYY-MM-DD.
                    - type: 'null'
                  description: >-
                    The first weekly file the history lake replayed (the
                    baseline FULL).
                last_week:
                  anyOf:
                    - type: string
                      description: Calendar date, YYYY-MM-DD.
                    - type: 'null'
                  description: The last weekly file replayed.
                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.
                n_events:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Typed events on record.
                n_weeks:
                  anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  description: Weekly files replayed.
                domains:
                  anyOf:
                    - type: object
                      propertyNames:
                        type: string
                      additionalProperties:
                        type: object
                        properties:
                          first_week:
                            anyOf:
                              - type: string
                                description: Calendar date, YYYY-MM-DD.
                              - type: 'null'
                          last_week:
                            anyOf:
                              - type: string
                                description: Calendar date, YYYY-MM-DD.
                              - type: 'null'
                          n_events:
                            anyOf:
                              - type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              - type: 'null'
                        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.
              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 carries its as-of date and counts.
    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
              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
      description: >-
        API key from the developer console (starts with zpka_). Create one at
        https://developers.investorlift.com/get-a-key.

````

## Related topics

- [Summarise deal activity around a location](/api-reference/deals/summarise-deal-activity-around-a-location.md)
- [The twenty-six tools](/mcp/tools.md)
- [Deal counts per hex cell](/api-reference/endpoints/deals-cells.md)
- [List one investor's deals](/api-reference/endpoints/investors-deals.md)
- [List deals around a location](/api-reference/endpoints/deals-list.md)
