housedata-dev API

openapi: 3.1.0
info:
  title: housedata-dev API
  version: '2026-10-30'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-30: 21 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; housedata-dev has published no machine-readable contract that
    the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 1
    documentation: 20
    pages-with-code: 5
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-30'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://housedata.dev/docs
  - https://housedata.dev/listings
  - https://housedata.dev/zestimate
  - https://housedata.dev/market-data
  - https://housedata.dev/rentals
paths:
  /autocomplete:
    get:
      operationId: get_autocomplete
      tags:
      - Autocomplete
      summary: Places Zillow knows for a partial name
      x-source: https://housedata.dev/docs
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
        description: What the user typed.
      - name: types
        in: query
        required: false
        schema:
          type: string
        description: default REGIONS — Result types, comma-separated.
      - name: count
        in: query
        required: false
        schema:
          type: integer
        description: 1–20 · default 5
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAutocompleteResponse'
      x-evidence:
        kind: documentation
  /batch:
    post:
      operationId: post_batch
      tags:
      - Batch
      summary: Many queries in one call — 10 per call on Basic and Pro, 50 on Ultra, 100 on Mega
      x-source: https://housedata.dev/docs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBatchRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostBatchResponse'
      x-evidence:
        kind: documentation
  /building:
    get:
      operationId: get_building
      tags:
      - Building
      summary: A rental building
      x-source: https://housedata.dev/docs
      parameters:
      - name: buildingId
        in: query
        required: false
        schema:
          type: string
        description: The buildingId on a rental /search row (Zillow's lot id).
      - name: lat
        in: query
        required: false
        schema:
          type: number
      - name: lng
        in: query
        required: false
        schema:
          type: number
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBuildingResponse'
      x-evidence:
        kind: documentation
  /building/floor-plans:
    get:
      operationId: get_building_floor_plans
      tags:
      - Building
      summary: Floor plans, units and amenities of a rental building
      x-source: https://housedata.dev/docs
      parameters:
      - name: buildingId
        in: query
        required: false
        schema:
          type: string
        description: The buildingId on a rental /search row (Zillow's lot id).
      - name: lat
        in: query
        required: false
        schema:
          type: number
      - name: lng
        in: query
        required: false
        schema:
          type: number
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBuildingFloorPlansResponse'
      x-evidence:
        kind: documentation
  /market:
    get:
      operationId: get_market
      tags:
      - Market
      summary: Market statistics for a region — monthly, up to 100 months
      x-source: https://housedata.dev/docs
      parameters:
      - name: regionId
        in: query
        required: false
        schema:
          type: string
        description: A Zillow region id (from /region or /autocomplete).
      - name: location
        in: query
        required: false
        schema:
          type: string
        description: A city, ZIP, neighborhood or county as typed into Zillow — resolved to its region.
      - name: months
        in: query
        required: false
        schema:
          type: integer
        description: 1–100 · default 12
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMarketResponse'
      x-evidence:
        kind: documentation
  /mortgage/rates:
    get:
      operationId: get_mortgage_rates
      tags:
      - Mortgage
      summary: Today's mortgage rates
      x-source: https://housedata.dev/docs
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMortgageRatesResponse'
      x-evidence:
        kind: documentation
  /property:
    get:
      operationId: get_property
      tags:
      - Property
      summary: GET /property
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://zillow-full-data-api.p.rapidapi.com/property?zpid=64947237"  -H "X-RapidAPI-Key: YOUR_KEY"  -H "X-RapidAPI-Host:
          zillow-full-data-api.p.rapidapi.com" Queries — one call is one query against your plan''s monthly quota; a batch call counts one per
          item. A 4xx answer is not counted. Batch size — per call, by plan: Basic 10 · Pro 10 · Ultra 50 · Mega 100 . A larger batch is refused
          whole '
    post:
      operationId: post_property
      tags:
      - Property
      summary: Full property record by zpid (JSON body)
      x-source: https://housedata.dev/docs
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPropertyRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostPropertyResponse'
      x-evidence:
        kind: documentation
  /property/agent:
    get:
      operationId: get_property_agent
      tags:
      - Property
      summary: The listing agent's full profile
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyAgentResponse'
      x-evidence:
        kind: documentation
  /property/comps:
    get:
      operationId: get_property_comps
      tags:
      - Property
      summary: Comparable homes
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyCompsResponse'
      x-evidence:
        kind: documentation
  /property/facts:
    get:
      operationId: get_property_facts
      tags:
      - Property
      summary: The facts for one home
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyFactsResponse'
      x-evidence:
        kind: documentation
  /property/nearby:
    get:
      operationId: get_property_nearby
      tags:
      - Property
      summary: Nearby homes
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyNearbyResponse'
      x-evidence:
        kind: documentation
  /property/photos:
    get:
      operationId: get_property_photos
      tags:
      - Property
      summary: The photo gallery
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      - name: size
        in: query
        required: false
        schema:
          type: string
        description: one of full — full adds a media block with each photo in every size Zillow serves (~45 KB).
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyPhotosResponse'
      x-evidence:
        kind: documentation
  /property/price-history:
    get:
      operationId: get_property_price_history
      tags:
      - Property
      summary: Price history — listings, price cuts, sales
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyPriceHistoryResponse'
      x-evidence:
        kind: documentation
  /property/schools:
    get:
      operationId: get_property_schools
      tags:
      - Property
      summary: Assigned schools with ratings
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertySchoolsResponse'
      x-evidence:
        kind: documentation
  /property/scores:
    get:
      operationId: get_property_scores
      tags:
      - Property
      summary: Walk, transit and bike scores
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyScoresResponse'
      x-evidence:
        kind: documentation
  /property/tax-history:
    get:
      operationId: get_property_tax_history
      tags:
      - Property
      summary: Tax history — assessed value and tax paid by year
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyTaxHistoryResponse'
      x-evidence:
        kind: documentation
  /property/top-agents:
    get:
      operationId: get_property_top_agents
      tags:
      - Property
      summary: Top-selling agents around this home, ranked
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyTopAgentsResponse'
      x-evidence:
        kind: documentation
  /property/zestimate:
    get:
      operationId: get_property_zestimate
      tags:
      - Property
      summary: Zestimate, range, 30-day change and value history
      x-source: https://housedata.dev/docs
      parameters:
      - name: zpid
        in: query
        required: true
        schema:
          type: string
        description: The Zillow property id — the number before _zpid in any Zillow property URL, and on every /search row.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPropertyZestimateResponse'
      x-evidence:
        kind: documentation
  /region:
    get:
      operationId: get_region
      tags:
      - Region
      summary: Region lookup — id, type, parents, centre, boundaries
      x-source: https://housedata.dev/docs
      parameters:
      - name: regionId
        in: query
        required: false
        schema:
          type: string
        description: A Zillow region id (from /region or /autocomplete).
      - name: location
        in: query
        required: false
        schema:
          type: string
        description: A city, ZIP, neighborhood or county as typed into Zillow — resolved to its region.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRegionResponse'
      x-evidence:
        kind: documentation
  /search:
    post:
      operationId: post_search
      tags:
      - Search
      summary: Listings for a place — for sale, for rent or sold
      x-source: https://housedata.dev/docs
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSearchRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSearchResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetAutocompleteResponse:
      type: object
      properties:
        regionId:
          type: string
        name:
          type: string
        type:
          type: string
        city:
          type: string
        state:
          type: string
        zip:
          type: string
        centre:
          type: object
    PostBatchRequest:
      type: object
      properties:
        concurrency:
          type: integer
          description: 1–12 · default 6
        queries:
          type: array
          description: Up to 10 items on Basic and Pro, 50 on Ultra, 100 on Mega
      required:
      - queries
    PostBatchResponse:
      type: object
      properties:
        ok:
          type: boolean
        status:
          type: integer
        result:
          type: object
    GetBuildingResponse:
      type: object
      properties:
        name:
          type: string
        address:
          type: string
        type:
          type: string
        unit_summary:
          type: object
        pet_policy:
          type: string
        contact:
          type: object
    GetBuildingFloorPlansResponse:
      type: object
      properties:
        floor_plans:
          type: array
        unit_amenities:
          type: array
        building_amenities:
          type: array
        fees:
          type: object
        leasing_contact:
          type: object
    GetMarketResponse:
      type: object
      properties:
        temperature:
          type: string
        listings:
          type: object
        sales:
          type: object
        forecast:
          type: object
        latest:
          type: object
    GetMortgageRatesResponse:
      type: object
      properties:
        product:
          type: string
        rate:
          type: number
        apr:
          type: number
        disclaimer:
          type: string
    PostPropertyRequest:
      type: object
      properties:
        zpid:
          type: string
        address:
          type: string
        url:
          type: string
        fields:
          type: string
        photos:
          type: string
    PostPropertyResponse:
      type: object
      properties:
        price:
          type: string
        zestimate:
          type: string
        rentZestimate:
          type: string
        address:
          type: string
        coordinates:
          type: string
        facts:
          type: string
        priceHistory:
          type: string
        taxHistory:
          type: string
        schools:
          type: string
        agent:
          type: string
        broker:
          type: string
        mls:
          type: string
        walkScore:
          type: string
        transitScore:
          type: string
        bikeScore:
          type: string
        nearby:
          type: string
        openHouses:
          type: string
        engagementCounts:
          type: string
        description:
          type: string
        photos:
          type: string
    GetPropertyAgentResponse:
      type: object
      properties:
        name:
          type: string
        license:
          type: string
        phone:
          type: string
        email:
          type: string
        website:
          type: string
        brokerage:
          type: string
        bio:
          type: string
        socialLinks:
          type: string
        zilowProfile:
          type: string
        rating:
          type: string
        reviewCount:
          type: string
        broker:
          type: string
        mls:
          type: string
    GetPropertyCompsResponse:
      type: object
      properties:
        zpid:
          type: string
        address:
          type: string
        price:
          type: string
        beds:
          type: string
        baths:
          type: string
        livingArea:
          type: string
        image:
          type: string
    GetPropertyFactsResponse:
      type: object
      properties:
        beds:
          type: string
        baths:
          type: string
        livingArea:
          type: string
        yearBuilt:
          type: string
        homeType:
          type: string
        homeSubtype:
          type: string
        lot:
          type: string
        stories:
          type: string
        parking:
          type: string
        garage:
          type: string
        heating:
          type: string
        cooling:
          type: string
        appliances:
          type: string
        hoaPerMonth:
          type: string
        annualTax:
          type: string
        assessedValue:
          type: string
        onMarketDate:
          type: string
        newConstruction:
          type: string
        status:
          type: string
        price:
          type: string
        daysOnZillow:
          type: string
    GetPropertyNearbyResponse:
      type: object
      properties:
        zpid:
          type: string
        price:
          type: string
        beds:
          type: string
        baths:
          type: string
        area:
          type: string
        status:
          type: string
        type:
          type: string
        address:
          type: string
        image:
          type: string
    GetPropertyPhotosResponse:
      type: object
      properties:
        photoUrl:
          type: string
        heroImage:
          type: string
    GetPropertyPriceHistoryResponse:
      type: object
      properties:
        date:
          type: string
        price:
          type: string
        changeRate:
          type: string
        pricePerSqFt:
          type: string
        source:
          type: string
    GetPropertySchoolsResponse:
      type: object
      properties:
        name:
          type: string
        level:
          type: string
        grades:
          type: string
        distance:
          type: string
        rating:
          type: string
        studentTeacherRatio:
          type: string
        enrollment:
          type: string
        themedRatings:
          type: string
        address:
          type: string
    GetPropertyScoresResponse:
      type: object
      properties:
        walkScore:
          type: string
        transitScore:
          type: string
        bikeScore:
          type: string
    GetPropertyTaxHistoryResponse:
      type: object
      properties:
        year:
          type: string
        assessedValue:
          type: string
        taxPaid:
          type: string
        yearOverYearRate:
          type: string
    GetPropertyTopAgentsResponse:
      type: object
      properties:
        name:
          type: string
        zillow_id:
          type: string
        sales_count:
          type: integer
        min_sale_price:
          type: number
        max_sale_price:
          type: number
        average_sale_price:
          type: number
        median_sale_price:
          type: number
        sales_in_price_range:
          type: integer
        bio:
          type: string
        avatar:
          type: string
        business_name:
          type: string
        languages:
          type: array
        reviews:
          type: integer
    GetPropertyZestimateResponse:
      type: object
      properties:
        zestimate:
          type: string
        low:
          type: string
        high:
          type: string
        change30Day:
          type: string
        rentZestimate:
          type: string
        zestimateHistory:
          type: string
        priceHistory:
          type: string
    GetRegionResponse:
      type: object
      properties:
        regionId:
          type: string
        name:
          type: string
        type:
          type: string
        state:
          type: string
        city:
          type: string
        centre:
          type: object
        boundaries:
          type: object
    PostSearchRequest:
      type: object
      properties:
        location:
          type: string
          description: A city, ZIP, neighborhood or county as typed into Zillow. Required unless regionId is given.
        regionId:
          type: string
          description: A Zillow region id from /autocomplete, instead of location.
        status:
          type: string
          description: one of forSale, forRent, sold · default forSale
        sort:
          type: string
          description: one of relevance, daysOn, price, beds, baths, livingArea, lotArea, yearBuilt, recentlyChanged, featured, rentalPriorityScore
        sortAscending:
          type: boolean
          description: default false
        page:
          type: integer
          description: ≥ 1 · default 1
        pageSize:
          type: integer
          description: 1–40 · default 20
        fields:
          type: string
          description: Projection applied to each result's property
    PostSearchResponse:
      type: object
      properties:
        zpid:
          type: string
        price:
          type: number
        beds:
          type: integer
        baths:
          type: number
        area:
          type: integer
        status:
          type: string
        type:
          type: string
        address:
          type: string
        resultType:
          type: string
        matchingHomeCount:
          type: integer
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-RapidAPI-Key
security:
- apiKey: []
tags:
- name: Autocomplete
- name: Batch
- name: Building
- name: Market
- name: Mortgage
- name: Property
- name: Region
- name: Search