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

# Get Property Detail

> Get Property Detail



## OpenAPI

````yaml api-reference/zillow/openapi.json get /api/v1/property/detail
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/property/detail:
    get:
      tags:
        - Property
      summary: Get Property Detail
      description: Get Property Detail
      operationId: getApiV1PropertyDetail
      parameters:
        - in: query
          name: zpid
          schema:
            type: string
            pattern: ^\d+$
            minLength: 1
            description: Unique Zillow Property ID (ZPID) used to identify the property
            example: '58916071'
          required: true
      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
                  data:
                    type: object
                    properties:
                      zpid:
                        type: number
                        description: >-
                          Unique Zillow Property ID (ZPID) used to identify the
                          property
                        example: 58916071
                      palsId:
                        type: string
                        description: Internal PALS listing identifier from Zillow
                        example: '175008_24148539'
                      country:
                        type: string
                        description: Country where the property is located
                        example: USA
                      latitude:
                        type: number
                        description: Latitude coordinate of the property location
                        example: 41.530857
                      longitude:
                        type: number
                        description: Longitude coordinate of the property location
                        example: -72.85068
                      photoCount:
                        type: number
                        description: Total number of photos available for the property
                        example: 27
                      affordabilityEstimate:
                        type: object
                        properties:
                          totalMonthlyCost:
                            type: number
                            description: >-
                              Estimated total monthly housing cost including
                              mortgage, taxes, and insurance
                            example: 2669
                        description: >-
                          Estimated monthly affordability information for the
                          property
                      foreclosureTypes:
                        type: object
                        properties:
                          isBankOwned:
                            type: boolean
                            description: >-
                              Indicates whether the property is currently owned
                              by a bank or financial institution.
                            example: false
                          isForeclosedNFS:
                            type: boolean
                            description: >-
                              Indicates whether the property is a foreclosed
                              listing that is not for sale (NFS).
                            example: false
                          isPreforeclosure:
                            type: boolean
                            description: >-
                              Indicates whether the property is in a
                              pre-foreclosure stage.
                            example: false
                          isAnyForeclosure:
                            type: boolean
                            description: >-
                              Indicates whether the property is involved in any
                              type of foreclosure process.
                            example: false
                          wasNonRetailAuction:
                            type: boolean
                            description: >-
                              Indicates whether the property was previously sold
                              through a non-retail (auction) sale.
                            example: false
                          wasForeclosed:
                            type: boolean
                            description: >-
                              Indicates whether the property has been foreclosed
                              in the past.
                            example: false
                        description: >-
                          Foreclosure or auction status information for the
                          property
                      postingUrl:
                        type:
                          - string
                          - 'null'
                        description: External URL where the listing is originally posted
                        example: null
                      parentRegion:
                        type: object
                        properties:
                          name:
                            type: string
                            description: Name of the parent region such as ZIP code or area
                            example: '06451'
                          regionId:
                            type: number
                            description: Zillow region identifier of the parent region
                            example: 60318
                        description: Parent geographic region information
                      hdpTypeDimension:
                        type: string
                        description: >-
                          Listing category dimension used by Zillow (e.g.,
                          ForSale, ForRent)
                        example: ForSale
                      hideClimateRiskScore:
                        type: boolean
                        description: >-
                          Indicates whether the climate risk score is hidden for
                          this property
                        example: true
                      listingTypeDimension:
                        type: string
                        description: Type of listing such as agent listing or owner listing
                        example: For Sale by Agent
                      city:
                        type: string
                        description: City where the property is located
                        example: Meriden
                      state:
                        type: string
                        description: State where the property is located
                        example: CT
                      streetAddress:
                        type: string
                        description: Street address of the property
                        example: 105 Riverside Drive
                      zipcode:
                        type: string
                        description: ZIP or postal code of the property
                        example: '06451'
                      homeStatus:
                        type: string
                        description: Current listing status of the property
                        example: FOR_SALE
                      homeType:
                        type: string
                        description: >-
                          Type of home such as single family, condo, or
                          townhouse
                        example: SINGLE_FAMILY
                      responsivePhotos:
                        type: array
                        items:
                          type: object
                          properties:
                            caption:
                              type: string
                              description: >-
                                Optional caption or description text associated
                                with the photo.
                              example: ''
                            subjectType:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Type of subject shown in the photo (e.g.,
                                interior, exterior, kitchen), if available.
                              example: null
                            url:
                              type: string
                              description: Direct URL to the default resolution image.
                              example: >-
                                https://photos.zillowstatic.com/fOriginalPhotoSchemap/8f24528d660fba5242539f7cad2a88b8-p_d.jpg
                            mixedSources:
                              type: object
                              properties:
                                jpeg:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        description: >-
                                          URL of the JPEG image source at the
                                          specified width.
                                        example: >-
                                          https://photos.zillowstatic.com/fp/8f24528d660fba5242539f7cad2a88b8-cc_ft_192.jpg
                                      width:
                                        type: number
                                        description: Pixel width of the JPEG image variant.
                                        example: 192
                                webp:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        description: >-
                                          URL of the WebP image source at the
                                          specified width.
                                        example: >-
                                          https://photos.zillowstatic.com/fp/8f24528d660fba5242539f7cad2a88b8-cc_ft_192.webp
                                      width:
                                        type: number
                                        description: Pixel width of the WebP image variant.
                                        example: 192
                              required:
                                - jpeg
                                - webp
                              description: >-
                                Collection of alternative image sources and
                                formats (JPEG/WebP) at multiple resolutions.
                        description: >-
                          Responsive photo set for different screen sizes and
                          resolutions
                      attributionInfo:
                        type: object
                        properties:
                          trueStatus:
                            type:
                              - string
                              - 'null'
                            description: >-
                              Status or verification label indicating the
                              authenticity or listing status provided by the
                              data source.
                            example: null
                          agentName:
                            type: string
                            description: >-
                              Full name of the real estate agent associated with
                              the listing.
                            example: Thomas Mele
                          agentEmail:
                            type:
                              - string
                              - 'null'
                            description: Email address of the listing agent.
                            example: null
                          agentPhoneNumber:
                            type: string
                            description: Contact phone number of the listing agent.
                            example: 203-718-3305
                          brokerName:
                            type: string
                            description: >-
                              Name of the brokerage or real estate company
                              representing the listing.
                            example: Dorrance Realty
                          mlsId:
                            type: string
                            description: >-
                              Unique identifier of the listing in the Multiple
                              Listing Service (MLS).
                            example: '24148539'
                          attributionTitle:
                            type:
                              - string
                              - 'null'
                            description: >-
                              Title or role used for attribution, such as agent
                              or broker designation.
                            example: null
                          mlsName:
                            type: string
                            description: >-
                              Name of the Multiple Listing Service (MLS)
                              providing the listing data.
                            example: Smart MLS
                        description: Listing attribution and source information
                      comingSoonOnMarketDate:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Date when the property will become active on the
                          market
                        example: null
                      contingentListingType:
                        type:
                          - string
                          - 'null'
                        description: Type of contingency applied to the listing, if any
                        example: null
                      listing_sub_type:
                        type: object
                        properties:
                          is_FSBA:
                            type: boolean
                            description: >-
                              Indicates whether the property is listed as For
                              Sale By Agent (FSBA).
                            example: false
                          is_FSBO:
                            type: boolean
                            description: >-
                              Indicates whether the property is listed as For
                              Sale By Owner (FSBO).
                            example: false
                          is_bankOwned:
                            type: boolean
                            description: >-
                              Indicates whether the property is owned by a bank
                              or lender.
                            example: false
                          is_comingSoon:
                            type: boolean
                            description: >-
                              Indicates whether the listing is marked as coming
                              soon.
                            example: false
                          is_forAuction:
                            type: boolean
                            description: >-
                              Indicates whether the property is listed for
                              auction.
                            example: false
                          is_foreclosure:
                            type: boolean
                            description: >-
                              Indicates whether the property is a foreclosure
                              listing.
                            example: false
                          is_newHome:
                            type: boolean
                            description: >-
                              Indicates whether the property is a newly built
                              home.
                            example: false
                          is_openHouse:
                            type: boolean
                            description: >-
                              Indicates whether the listing currently has an
                              open house scheduled.
                            example: false
                          is_pending:
                            type: boolean
                            description: >-
                              Indicates whether the listing is pending under
                              contract.
                            example: false
                        description: Detailed subtype classification of the listing
                      dateSoldString:
                        type: string
                        description: Date when the property was last sold
                        example: '2010-11-16'
                      lastSoldPrice:
                        type: number
                        description: Last recorded sale price of the property
                        example: 200000
                      isShowcaseListing:
                        type: boolean
                        description: Indicates whether this is a Zillow Showcase listing
                        example: false
                      originalPhotos:
                        type: array
                        items:
                          type: object
                          properties:
                            caption:
                              type: string
                              description: >-
                                Optional caption or description text associated
                                with the original photo.
                              example: ''
                            mixedSources:
                              type: object
                              properties:
                                jpeg:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        description: >-
                                          URL of the JPEG image source at the
                                          specified width.
                                        example: >-
                                          https://photos.zillowstatic.com/fp/8f24528d660fba5242539f7cad2a88b8-cc_ft_192.jpg
                                      width:
                                        type: number
                                        description: Pixel width of the JPEG image variant.
                                        example: 192
                                webp:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        description: >-
                                          URL of the WebP image source at the
                                          specified width.
                                        example: >-
                                          https://photos.zillowstatic.com/fp/8f24528d660fba5242539f7cad2a88b8-cc_ft_192.webp
                                      width:
                                        type: number
                                        description: Pixel width of the WebP image variant.
                                        example: 192
                              required:
                                - jpeg
                                - webp
                              description: >-
                                Collection of available image sources and
                                formats (JPEG/WebP) for the original photo,
                                provided in multiple resolutions.
                        description: Original high-resolution photos of the property
                      richMedia:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Additional rich media content such as virtual tours or
                          videos
                        example: null
                      bedrooms:
                        type: number
                        description: Number of bedrooms in the property
                        example: 2
                      bathrooms:
                        type: number
                        description: Number of bathrooms in the property
                        example: 2
                      livingAreaValue:
                        type: number
                        description: Living area size of the property in square feet
                        example: 1476
                      price:
                        type: number
                        description: Current listing price of the property
                        example: 389999
                      listingAccountUserId:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Identifier of the user account that created the
                          listing
                        example: null
                      isUndisclosedAddress:
                        type: boolean
                        description: >-
                          Indicates whether the exact address is hidden from
                          public view
                        example: false
                      address:
                        type: object
                        properties:
                          streetAddress:
                            type: string
                            description: Street portion of the property address
                            example: 105 Riverside Drive
                          zipcode:
                            type: string
                            description: ZIP or postal code of the address
                            example: '06451'
                          city:
                            type: string
                            description: City of the address
                            example: Meriden
                          state:
                            type: string
                            description: State of the address
                            example: CT
                        description: Full structured address of the property
                      hdpUrl:
                        type: string
                        description: Relative URL path to the Zillow Home Details Page
                        example: >-
                          /homedetails/105-Riverside-Dr-Meriden-CT-06451/58916071_zpid/
                      tourViewCount:
                        type: number
                        description: Number of times the property tour has been viewed
                        example: 0
                      hasApprovedThirdPartyVirtualTourUrl:
                        type: boolean
                        description: >-
                          Indicates whether an approved third-party virtual tour
                          is available
                        example: false
                      listedBy:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                Role or type of the listing party (e.g., listing
                                agent, broker, or owner).
                              example: LISTING_AGENT
                            elements:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    description: >-
                                      Type of listing detail element (such as
                                      name, phone, or license identifier).
                                    example: NAME
                                  text:
                                    type: string
                                    description: >-
                                      Display text value for the corresponding
                                      listing detail element.
                                    example: Thomas Mele
                        description: List of agents or brokers representing the property
                      priceChange:
                        type:
                          - string
                          - 'null'
                        description: Formatted description of the most recent price change
                        example: null
                      priceChangeDate:
                        type:
                          - string
                          - 'null'
                        description: Timestamp when the price was last changed
                        example: null
                      priceChangeDateString:
                        type:
                          - string
                          - 'null'
                        description: Human-readable date when the price was last changed
                        example: null
                      formattedChip:
                        type: object
                        properties:
                          location:
                            type: array
                            items:
                              type: object
                              properties:
                                fullValue:
                                  type: string
                                  description: >-
                                    Formatted location string used for display
                                    chips in the user interface.
                                  example: 105 Riverside Drive
                        description: Formatted badge or label displayed on the listing
                      resoFacts:
                        type: object
                        properties:
                          bathrooms:
                            type: number
                            description: Total number of bathrooms in the property.
                            example: 2
                          bathroomsFull:
                            type: number
                            description: >-
                              Number of full bathrooms with a sink, toilet, and
                              bathtub or shower.
                            example: 2
                          bathroomsThreeQuarter:
                            type:
                              - number
                              - 'null'
                            description: >-
                              Number of three-quarter bathrooms (sink, toilet,
                              and shower only).
                            example: null
                          bathroomsHalf:
                            type: number
                            description: Number of half bathrooms (sink and toilet only).
                            example: 0
                          bathroomsOneQuarter:
                            type:
                              - number
                              - 'null'
                            description: >-
                              Number of quarter bathrooms (typically a toilet or
                              shower only).
                            example: null
                          bathrbedroomsooms:
                            type: number
                            description: >-
                              Combined or mis-typed field representing a
                              bathroom or bedroom-related count from source
                              data.
                            example: 2
                          homeType:
                            type: string
                            description: >-
                              Primary type of the home (e.g., single family,
                              condo, townhouse).
                            example: SingleFamily
                          lotSize:
                            type: string
                            description: >-
                              Formatted size of the lot including unit of
                              measurement.
                            example: 0.83 Acres
                          pricePerSquareFoot:
                            type: number
                            description: >-
                              Listing price divided by the interior living area
                              in square feet.
                            example: 264
                          yearBuilt:
                            type: number
                            description: Year the property was originally constructed.
                            example: 1986
                          propertySubType:
                            type: array
                            items:
                              type: string
                            description: >-
                              List of property sub-types describing the
                              residence classification.
                            example:
                              - Single Family Residence
                          carportParkingCapacity:
                            type:
                              - number
                              - 'null'
                            description: Number of parking spaces available in a carport.
                            example: null
                          coveredParkingCapacity:
                            type:
                              - number
                              - 'null'
                            description: >-
                              Number of covered parking spaces available on the
                              property.
                            example: null
                          garageParkingCapacity:
                            type:
                              - number
                              - 'null'
                            description: Number of parking spaces available in a garage.
                            example: null
                          hasAttachedGarage:
                            type:
                              - boolean
                              - 'null'
                            description: >-
                              Indicates whether the property has an attached
                              garage.
                            example: null
                          hasCarport:
                            type:
                              - boolean
                              - 'null'
                            description: Indicates whether the property includes a carport.
                            example: null
                          hasGarage:
                            type: boolean
                            description: >-
                              Indicates whether the property includes any type
                              of garage.
                            example: false
                          hasOpenParking:
                            type:
                              - boolean
                              - 'null'
                            description: >-
                              Indicates whether the property includes open
                              (uncovered) parking.
                            example: null
                          openParkingCapacity:
                            type:
                              - boolean
                              - 'null'
                            description: >-
                              Indicates whether open parking capacity
                              information is available.
                            example: null
                          parkingCapacity:
                            type: number
                            description: >-
                              Total number of parking spaces available on the
                              property.
                            example: 0
                          parkingFeatures:
                            type: array
                            items: {}
                            description: >-
                              List of parking-related features or amenities
                              associated with the property.
                            example: []
                        description: Detailed property facts and features from RESO data
                      currency:
                        type: string
                        description: Currency used for all price values
                        example: USD
                      listingFeedID:
                        type:
                          - string
                          - 'null'
                        description: Identifier of the listing feed source
                        example: null
                      ssid:
                        type: number
                        description: Search session identifier associated with this listing
                        example: 175
                      listingProvider:
                        type:
                          - string
                          - 'null'
                        description: Name or identifier of the listing data provider
                        example: null
                      livingArea:
                        type: number
                        description: Total interior living area in square feet
                        example: 1476
                      isPreforeclosureAuction:
                        type: boolean
                        description: >-
                          Indicates whether the property is in pre-foreclosure
                          or auction status
                        example: false
                      monthlyHoaFee:
                        type:
                          - string
                          - 'null'
                        description: Monthly homeowners association (HOA) fee
                        example: null
                      zestimate:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Zillow estimated market value (Zestimate) of the
                          property
                        example: null
                      lotAreaUnits:
                        type: number
                        description: Lot area measurement units value
                        example: 0.83
                      lotSize:
                        type: number
                        description: Total lot size in square feet
                        example: 36154
                      rentZestimate:
                        type:
                          - string
                          - 'null'
                        description: Zillow estimated monthly rental value (Rent Zestimate)
                        example: null
                      description:
                        type: string
                        description: >-
                          Full public description of the property provided in
                          the listing
                        example: >-
                          Experience comfort, space, and convenience at 105
                          Riverside Drive...
                      whatILove:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Owner-provided personal notes about what they love
                          about the home
                        example: null
                      homeInsights:
                        type: array
                        items:
                          type: object
                          properties:
                            insights:
                              type: array
                              items:
                                type: object
                                properties:
                                  modelId:
                                    type: string
                                    description: >-
                                      Identifier of the machine learning model
                                      that generated the insight tags.
                                    example: z-nrt-pdc-llm-tags
                                  treatmentId:
                                    type: string
                                    description: >-
                                      Experiment or treatment identifier
                                      associated with the generated insights.
                                    example: model_0
                                  phrases:
                                    type: array
                                    items:
                                      type: string
                                    description: >-
                                      List of highlighted descriptive phrases or
                                      selling points extracted from the listing
                                      content.
                                    example:
                                      - Off-street parking
                                      - Warm and welcoming atmosphere
                                      - Functional outdoor space
                                      - Sufficient counter space
                                      - Ample cabinetry
                                      - Curb appeal
                        description: >-
                          Automated insights and highlights generated for the
                          property
                      timeOnZillow:
                        type: string
                        description: >-
                          Human-readable duration the property has been listed
                          on Zillow
                        example: 8 days
                      daysOnZillow:
                        type: number
                        description: Number of days the property has been active on Zillow
                        example: 8
                      pageViewCount:
                        type: number
                        description: Total number of times the listing page has been viewed
                        example: 1706
                      favoriteCount:
                        type: number
                        description: >-
                          Number of users who have saved this property as a
                          favorite
                        example: 105
                      sellingSoon:
                        type: array
                        items:
                          type: object
                          properties:
                            modelId:
                              type: string
                              description: >-
                                Identifier of the predictive model used to
                                estimate the likelihood that the property will
                                be sold soon.
                              example: v0
                            treatmentId:
                              type: string
                              description: >-
                                Identifier of the experiment or treatment
                                variant applied for the selling-soon prediction.
                              example: model_0
                            percentile:
                              type: number
                              description: >-
                                Percentile score representing how likely this
                                property is to sell soon compared to other
                                listings.
                              example: 0.98
                        description: >-
                          Predicted or flagged selling-soon signals for the
                          property
                      mlsid:
                        type: string
                        description: MLS (Multiple Listing Service) listing identifier
                        example: '24148539'
                      ouid:
                        type: string
                        description: MLS organization unique identifier
                        example: M00000127
                      propertyTypeDimension:
                        type: string
                        description: Human-readable property type classification
                        example: Single Family
                      hiResImageLink:
                        type: string
                        description: >-
                          Direct link to a high-resolution primary property
                          image
                        example: >-
                          https://photos.zillowstatic.com/fp/8f24528d660fba5242539f7cad2a88b8-p_f.jpg
                      isPremierBuilder:
                        type: boolean
                        description: >-
                          Indicates whether the property is listed by a premier
                          builder
                        example: false
                      timeZone:
                        type: string
                        description: Time zone of the property location
                        example: America/New_York
                      tourEligibility:
                        type: object
                        properties:
                          isPropertyTourEligible:
                            type: boolean
                            description: >-
                              Indicates whether this property is eligible for
                              scheduling a tour.
                            example: true
                          propertyTourOptions:
                            type: object
                            properties:
                              isFinal:
                                type: boolean
                                description: >-
                                  Indicates whether the tour availability data
                                  is final and no further updates are expected.
                                example: true
                              tourAvailability:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      description: >-
                                        Date on which property tours are
                                        available.
                                      example: '2026-01-21'
                                    status:
                                      type: string
                                      description: >-
                                        Availability status of tours for the
                                        given date.
                                      example: AVAILABLE
                                    times:
                                      type: array
                                      items:
                                        type: string
                                      description: >-
                                        List of available time slots for
                                        scheduling a tour on the given date.
                                      example:
                                        - '11:00:00'
                                        - '11:30:00'
                                        - '12:00:00'
                                        - '12:30:00'
                                        - '13:00:00'
                                        - '13:30:00'
                                description: >-
                                  List of available tour dates, statuses, and
                                  time slots for this property.
                              tourType:
                                type: string
                                description: >-
                                  Type of tour booking supported for this
                                  property (for example, instant booking or
                                  request-based).
                                example: INSTANT_BOOK
                            description: >-
                              Tour booking options and availability information
                              for the property.
                        description: Information about tour scheduling and eligibility
                      mortgageZHLRates:
                        type: object
                        description: >-
                          Current mortgage interest rates provided by Zillow
                          Home Loans
                        example:
                          fifteenYearFixedBucket:
                            rate: 5.41
                            rateSource: ZGMI
                            lastUpdated: 1768978184261
                          thirtyYearFixedBucket:
                            rate: 6.044
                            rateSource: ZGMI
                            lastUpdated: 1768978184261
                          arm5Bucket:
                            rate: 6.277
                            rateSource: ZGMI
                            lastUpdated: 1768978184261
                      propertyTaxRate:
                        type: number
                        description: Annual property tax rate as a percentage
                        example: 2.13
                      cityId:
                        type: number
                        description: Internal Zillow city identifier
                        example: 11
                      stateId:
                        type: number
                        description: Internal Zillow state identifier
                        example: 105
                      boroughId:
                        type:
                          - number
                          - 'null'
                        description: Internal borough identifier (if applicable)
                        example: null
                      countyId:
                        type: number
                        description: Internal Zillow county identifier
                        example: 2815
        '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

````