> ## Documentation Index
> Fetch the complete documentation index at: https://docs.propertydata.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Search by URL

> Search by URL



## OpenAPI

````yaml api-reference/zillow/openapi.json get /api/v1/search/by-url
openapi: 3.1.0
info:
  title: US Property Data
  description: US Property Data Documentation
  version: 1.0.0
servers:
  - url: https://us-property-data.p.rapidapi.com
    description: RapiAPI
security: []
paths:
  /api/v1/search/by-url:
    get:
      tags:
        - Search
      summary: Search by URL
      description: Search by URL
      operationId: getApiV1SearchBy-url
      parameters:
        - in: query
          name: url
          schema:
            type: string
            format: uri
            description: Zillow search or listing URL (must be from zillow.com domain)
            example: >-
              https://www.zillow.com/queens-new-york-ny/?searchQueryState=%7B%22pagination%22%3A%7B%7D%2C%22isMapVisible%22%3Atrue%2C%22mapBounds%22%3A%7B%22west%22%3A-73.8138451751709%2C%22east%22%3A-73.6629548248291%2C%22south%22%3A40.60563319578654%2C%22north%22%3A40.71410704445532%7D%2C%22regionSelection%22%3A%5B%7B%22regionId%22%3A270915%2C%22regionType%22%3A17%7D%5D%2C%22filterState%22%3A%7B%22sort%22%3A%7B%22value%22%3A%22globalrelevanceex%22%7D%7D%2C%22isListVisible%22%3Atrue%2C%22mapZoom%22%3A13%7D
          required: true
        - in: query
          name: page
          schema:
            type: integer
            exclusiveMinimum: 0
            description: Page number for pagination
            default: 1
            example: 1
          required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  cost:
                    type: number
                    description: Cost of the request
                    example: 1
                  total:
                    type: number
                    description: Total number of properties matching the search criteria
                    example: 792
                  has_more:
                    type: boolean
                    description: Whether there are more data to fetch
                    example: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        zpid:
                          type: string
                          description: Unique Zillow property ID
                          example: '456346178'
                        palsId:
                          type: string
                          description: Internal Zillow listing identifier
                          example: 6955001_S1787431
                        id:
                          type: string
                          description: Primary listing ID (usually same as zpid)
                          example: '456346178'
                        rawHomeStatusCd:
                          type: string
                          description: Raw home status code returned by Zillow
                          example: ForSale
                        marketingStatusSimplifiedCd:
                          type: string
                          description: Simplified marketing status text for display
                          example: For Sale by Agent
                        imgSrc:
                          type: string
                          description: Main image URL of the property listing
                          example: >-
                            https://photos.zillowstatic.com/fp/79ae0ba2dffd7afad218b1b9d1499a4a-p_e.jpg
                        hasImage:
                          type: boolean
                          description: Indicates whether the listing has at least one image
                          example: true
                        detailUrl:
                          type: string
                          description: Full Zillow URL to the property detail page
                          example: >-
                            https://www.zillow.com/homedetails/33-221st-Bch-UNIT-1-Breezy-Pt-NY-11697/456346178_zpid/
                        statusType:
                          type: string
                          description: >-
                            Normalized property status used by backend
                            (FOR_SALE, FOR_RENT, SOLD)
                          example: FOR_SALE
                        statusText:
                          type: string
                          description: Human-readable status text shown on listing card
                          example: Condo for sale
                        countryCurrency:
                          type: string
                          description: Currency symbol used for the listing price
                          example: $
                        price:
                          type: string
                          description: Formatted listing price as display text
                          example: $1,200,000
                        unformattedPrice:
                          type: number
                          description: Numeric listing price without formatting
                          example: 1200000
                        address:
                          type: string
                          description: Full formatted property address
                          example: 33 221st Bch UNIT 1, Breezy Pt, NY 11697
                        addressStreet:
                          type: string
                          description: Street portion of the property address
                          example: 33 221st Bch UNIT 1
                        addressCity:
                          type: string
                          description: City name of the property location
                          example: Breezy Pt
                        addressState:
                          type: string
                          description: State abbreviation of the property location
                          example: NY
                        addressZipcode:
                          type: string
                          description: ZIP / postal code of the property location
                          example: '11697'
                        isUndisclosedAddress:
                          type: boolean
                          description: >-
                            Indicates whether the exact address is hidden for
                            privacy reasons
                          example: false
                        shouldShowRequestOnPrice:
                          type: boolean
                          description: >-
                            Indicates whether price should be hidden and
                            replaced by a request prompt
                          example: false
                        beds:
                          type: number
                          description: Number of bedrooms in the property
                          example: 4
                        baths:
                          type: number
                          description: Number of bathrooms in the property
                          example: 3
                        area:
                          type: number
                          description: Living area size in square feet
                          example: 2800
                        latLong:
                          type: object
                          properties:
                            latitude:
                              type: number
                              description: Latitude coordinate of the property location
                              example: 40.55535
                            longitude:
                              type: number
                              description: Longitude coordinate of the property location
                              example: -73.92914
                          description: Geographic coordinates of the property
                        isZillowOwned:
                          type: boolean
                          description: Indicates whether the property is owned by Zillow
                          example: false
                        flexFieldText:
                          type: string
                          description: >-
                            Highlighted feature or short description tag for the
                            listing
                          example: Private beach
                        contentType:
                          type: string
                          description: Type of listing content returned by Zillow
                          example: homeInsight
                        hdpData:
                          type: object
                          properties:
                            homeInfo:
                              type: object
                              properties:
                                zpid:
                                  type: number
                                  description: >-
                                    Unique Zillow Property ID (ZPID) used to
                                    identify the property
                                  example: 456346178
                                streetAddress:
                                  type: string
                                  description: Street address of the property
                                  example: 33 221st Bch UNIT 1
                                zipcode:
                                  type: string
                                  description: ZIP or postal code of the property location
                                  example: '11697'
                                city:
                                  type: string
                                  description: City where the property is located
                                  example: Breezy Pt
                                state:
                                  type: string
                                  description: >-
                                    State or region where the property is
                                    located
                                  example: NY
                                latitude:
                                  type: number
                                  description: Latitude coordinate of the property location
                                  example: 40.55535
                                longitude:
                                  type: number
                                  description: >-
                                    Longitude coordinate of the property
                                    location
                                  example: -73.92914
                                price:
                                  type: number
                                  description: Current listing price of the property
                                  example: 1200000
                                datePriceChanged:
                                  type: number
                                  description: >-
                                    Timestamp (in milliseconds) when the price
                                    was last changed
                                  example: 1763539200000
                                bathrooms:
                                  type: number
                                  description: Number of bathrooms in the property
                                  example: 3
                                bedrooms:
                                  type: number
                                  description: Number of bedrooms in the property
                                  example: 4
                                livingArea:
                                  type: number
                                  description: Total interior living area in square feet
                                  example: 2800
                                homeType:
                                  type: string
                                  description: Type of home
                                  example: CONDO
                                homeStatus:
                                  type: string
                                  description: Current listing status of the property
                                  example: FOR_SALE
                                daysOnZillow:
                                  type: number
                                  description: >-
                                    Number of days the property has been listed
                                    on Zillow
                                  example: 141
                                isFeatured:
                                  type: boolean
                                  description: >-
                                    Indicates whether the listing is featured or
                                    promoted
                                  example: false
                                shouldHighlight:
                                  type: boolean
                                  description: >-
                                    Indicates whether the listing should be
                                    visually highlighted in search results
                                  example: false
                                rentZestimate:
                                  type: number
                                  description: >-
                                    Estimated monthly rental value (Rent
                                    Zestimate) for the property
                                  example: 4572
                                listing_sub_type:
                                  type: object
                                  properties:
                                    is_FSBA:
                                      type: boolean
                                      description: >-
                                        Indicates whether the listing is "For
                                        Sale By Agent"
                                      example: true
                                  description: >-
                                    Additional subtype information for the
                                    listing
                                priceReduction:
                                  type: string
                                  description: >-
                                    Formatted text describing the latest price
                                    reduction
                                  example: $195,000 (Nov 19)
                                isUnmappable:
                                  type: boolean
                                  description: >-
                                    Indicates whether the property location
                                    cannot be displayed on the map
                                  example: false
                                isPreforeclosureAuction:
                                  type: boolean
                                  description: >-
                                    Indicates whether the property is a
                                    pre-foreclosure or auction listing
                                  example: false
                                homeStatusForHDP:
                                  type: string
                                  description: >-
                                    Listing status displayed on the Home Detail
                                    Page (HDP)
                                  example: FOR_SALE
                                priceForHDP:
                                  type: number
                                  description: >-
                                    Price value displayed on the Home Detail
                                    Page (HDP)
                                  example: 1200000
                                priceChange:
                                  type: number
                                  description: >-
                                    Numeric amount of the most recent price
                                    change (negative indicates a price drop)
                                  example: -195000
                                timeOnZillow:
                                  type: number
                                  description: >-
                                    Total time (in milliseconds) the property
                                    has been active on Zillow
                                  example: 12192296000
                                isNonOwnerOccupied:
                                  type: boolean
                                  description: >-
                                    Indicates whether the property is not
                                    currently occupied by the owner
                                  example: true
                                isPremierBuilder:
                                  type: boolean
                                  description: >-
                                    Indicates whether the listing is from a
                                    premier builder partner
                                  example: false
                                isZillowOwned:
                                  type: boolean
                                  description: >-
                                    Indicates whether the property is owned by
                                    Zillow
                                  example: false
                                currency:
                                  type: string
                                  description: Currency code used for price values
                                  example: USD
                                country:
                                  type: string
                                  description: Country where the property is located
                                  example: USA
                                unit:
                                  type: string
                                  description: Unit or apartment number within the building
                                  example: Unit 1
                                isShowcaseListing:
                                  type: boolean
                                  description: >-
                                    Indicates whether the listing is a premium
                                    showcase listing
                                  example: false
                              description: >-
                                Home detail information displayed on the Zillow
                                Home Detail Page (HDP)
                          description: >-
                            Additional home detail page (HDP) data associated
                            with this listing
                        pgapt:
                          type: string
                          description: Primary status group label used by Zillow
                          example: ForSale
                        sgapt:
                          type: string
                          description: Secondary status group label used by Zillow
                          example: For Sale (Broker)
                        shouldShowZestimateAsPrice:
                          type: boolean
                          description: >-
                            Indicates whether Zestimate should be displayed
                            instead of the listing price
                          example: false
                        has3DModel:
                          type: boolean
                          description: >-
                            Indicates whether the listing includes a 3D virtual
                            tour model
                          example: false
                        hasVideo:
                          type: boolean
                          description: Indicates whether the listing includes a video tour
                          example: false
                        isHomeRec:
                          type: boolean
                          description: >-
                            Indicates whether the listing is a Zillow home
                            recommendation
                          example: false
                        hasAdditionalAttributions:
                          type: boolean
                          description: >-
                            Indicates whether the listing has additional broker
                            or source attributions
                          example: true
                        isFeaturedListing:
                          type: boolean
                          description: >-
                            Indicates whether the listing is marked as a
                            featured listing
                          example: false
                        isShowcaseListing:
                          type: boolean
                          description: >-
                            Indicates whether the listing is a premium showcase
                            listing
                          example: false
                        relaxed:
                          type: boolean
                          description: >-
                            Internal Zillow flag related to relaxed filtering
                            rules
                          example: true
                        brokerName:
                          type: string
                          description: Name of the listing broker or brokerage
                          example: 'Listing by: Douglas Elliman'
                        carouselPhotosComposable:
                          type: object
                          properties:
                            baseUrl:
                              type: string
                              description: >-
                                Base URL template used to generate property
                                photo URLs. The {photoKey} placeholder is
                                replaced with each photo key.
                              example: >-
                                https://photos.zillowstatic.com/fp/{photoKey}-p_e.jpg
                            communityBaseUrl:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Base URL template used to generate community
                                photo URLs (if the listing belongs to a
                                community)
                              example: null
                            photoData:
                              type: array
                              items:
                                type: object
                                properties:
                                  photoKey:
                                    type: string
                                    description: >-
                                      Unique identifier key for each listing
                                      photo, used with baseUrl to build the full
                                      image URL
                                    example: 79ae0ba2dffd7afad218b1b9d1499a4a
                              description: >-
                                List of photo metadata for the property image
                                carousel
                            communityPhotoData:
                              type:
                                - array
                                - 'null'
                              items:
                                type: string
                              description: >-
                                List of photo keys or URLs for community-level
                                images associated with the listing
                              example: null
                            isStaticUrls:
                              type: boolean
                              description: >-
                                Indicates whether the photo URLs are already
                                fully resolved static URLs instead of using
                                templates
                              example: false
                          description: Photo carousel data for the listing images
                        ma:
                          type: boolean
                          description: >-
                            Internal Zillow metadata flag (purpose varies by
                            listing)
                          example: false
                        isPaidBuilderNewConstruction:
                          type: boolean
                          description: >-
                            Indicates whether this is a paid new-construction
                            builder listing
                          example: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Bad request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: >-
                      Invalid API key. Go to https://docs.rapidapi.com/docs/keys
                      for more info.
        '403':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: You are not subscribed to this API.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Request failed with status 500: Internal Server Error'
                  status_code:
                    type: number
                    example: 500
                  cost:
                    type: number
                    example: 0
                  explain:
                    type: string
                    example: >-
                      Oops, it looks like there was an issue processing your
                      request. Don't worry, you won't be charged for this
                      request
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-rapidapi-key
      description: Rapid API Key

````