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

> Search by Coordinates



## OpenAPI

````yaml api-reference/zillow/openapi.json get /api/v1/search/by-coordinates
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-coordinates:
    get:
      tags:
        - Search
      summary: Search by Coordinates
      description: Search by Coordinates
      operationId: getApiV1SearchBy-coordinates
      parameters:
        - in: query
          name: latitude
          schema:
            type: string
            minLength: 1
            description: Latitude of the center point for the search area
            example: '38.876174'
          required: true
        - in: query
          name: longitude
          schema:
            type: string
            minLength: 1
            description: Longitude of the center point for the search area
            example: '-77.012171'
          required: true
        - in: query
          name: page
          schema:
            type: integer
            exclusiveMinimum: 0
            description: Page number for pagination
            default: 1
            example: 1
          required: false
        - in: query
          name: listing_status
          schema:
            type: string
            enum:
              - for_sale
              - for_rent
              - sold
            description: |
              Property listing status

              - `for_sale`: For Sale
              - `for_rent`: For Rent
              - `sold`: Sold
            default: for_sale
            example: for_sale
          required: false
        - in: query
          name: sort_by
          schema:
            type: string
            enum:
              - globalrelevanceex
              - priced
              - pricea
              - days
              - beds
              - baths
              - size
              - lot
            description: |
              Sort results by the specified criteria

              - `globalrelevanceex`: Homes for You
              - `priced`: Price (High to Low)
              - `pricea`: Pirce (Low to High)
              - `days`: Newest
              - `beds`: Bedrooms
              - `baths`: Bathrooms
              - `size`: Square Feet
              - `lot`: Lot Size
            default: globalrelevanceex
            example: globalrelevanceex
          required: false
        - in: query
          name: list_price_range
          schema:
            type: string
            description: |-
              list_price_range filter in format **min,max**

              Example `50000,1000000` means price from $50,000 to $1,000,000
            example: 50000,1000000
          required: false
        - in: query
          name: monthly_payment_range
          schema:
            type: string
            description: |-
              **Only applicable when listing_status = for_sale**

              monthly_payment_range filter in format **min,max**

              Example `50000,1000000` means price from $50,000 to $1,000,000
            example: 50000,1000000
          required: false
        - in: query
          name: monthly_down_payment
          schema:
            type: integer
            exclusiveMinimum: 0
            description: >-
              **Only applicable when listing_status = for_sale**



              Down payment is how much you're required to put down on a house is
              determined by the type of loan you get, but it generally ranges
              from 3% to 20% of the purchase price of the home
            example: 1000
          required: false
        - in: query
          name: monthly_credit_score
          schema:
            type: string
            enum:
              - CS720_AND_ABOVE
              - CS660_719
              - CS620_659
              - CS580_619
              - CS579_AND_BELOW
            description: |
              **Only applicable when listing_status = for_sale**

              Monthly payment credit score

              - `CS720_AND_ABOVE`: 720 & above
              - `CS660_719`: 660-719
              - `CS620_659`: 620-659
              - `CS580_619`: 580-619
              - `CS579_AND_BELOW`: 579 or below
          required: false
        - in: query
          name: number_of_bedrooms
          schema:
            type: integer
            exclusiveMinimum: 0
            description: >-
              Filter by minimum number of bedrooms. The value represents the
              lower bound. For example, if `1` is provided, the query will
              return properties with 1 or more bedrooms (bedrooms >= 1)
            example: 1
          required: false
        - in: query
          name: is_extract_match_bedroom
          schema:
            type: boolean
            description: Use exact match bedrooms
            example: true
          required: false
        - in: query
          name: number_of_bathrooms
          schema:
            type: integer
            exclusiveMinimum: 0
            description: >-
              Filter by minimum number of bathrooms. The value represents the
              lower bound. For example, if `1` is provided, the query will
              return properties with 1 or more bathrooms (bathrooms >= 1)
            example: 1
          required: false
        - in: query
          name: home_types
          schema:
            type: string
            description: |
              Filter listings by home type

              You can use one or multiple values separated by commas `,`


              - `houses`: Houses
              - `townhomes`: Townhomes
              - `multi_family`: Multi Family
              - `condos_co_ops`: Condos/Co-ops
              - `lots_land`: Lots/Land
              - `apartments`: Apartments
              - `manufactured`: Manufactured
            example: houses,townhomes
            default: >-
              houses,townhomes,multi_family,condos_co_ops,lots_land,apartments,manufactured
          required: false
        - in: query
          name: max_hoa
          schema:
            type: integer
            exclusiveMinimum: 0
            description: >-
              **Only applicable when listing_status = for_sale or sold**



              HOA fees are monthly or annual charges that cover the costs of
              maintaining and improving shared spaces. HOA fees are common
              within condos and some single-family home neighborhoods. Co-ops
              also have monthly fees (Common Charges and Maintenance Fees),
              which may also include real estate taxes and a portion of the
              building's underlying mortgage
            example: 2000
          required: false
        - in: query
          name: listing_type
          schema:
            type: string
            description: >
              **Only applicable when listing_status = for_sale**


              Filter listings by listing type


              You can use one or multiple values separated by commas `,`



              - `owner_posted`: Owner Posted

              - `agent_listed`: Agent Listed

              - `new_construction`: New Construction

              - `foreclosures`: Foreclosures - These properties are currently
              listed for sale. They are owned by a bank or a lender who took
              ownership through foreclosure proceedings. These are also known as
              bank-owned or real estate owned (REO).

              - `auctions`: Auctions

              - `foreclosed`: Foreclosed - These properties are owned by a bank
              or a lender who took ownership through foreclosure proceedings.
              They may soon be listed for sale.

              - `pre_foreclosures`: Pre Foreclosures - The lender initiated
              foreclosure proceedings on these properties because the owner(s)
              were in default on their loan obligations. Pre-foreclosures also
              include properties for which a foreclosure auction is scheduled.
            example: owner_posted,agent_listed
            default: owner_posted,agent_listed,new_construction,foreclosures,auctions
          required: false
        - in: query
          name: property_status
          schema:
            type: string
            description: >
              **Only applicable when listing_status = for_sale**


              Filter listings by property status


              You can use one or multiple values separated by commas `,`



              - `comming_soon`: Comming soon - Coming Soon listings are homes
              that will soon be on the market. The listing agent for these homes
              has added a Coming Soon note to alert buyers in advance.

              - `accepting_backup_offers`: Accepting backup offers

              - `pending_and_under_contract`: Pending & under contract - Sellers
              of these homes have accepted a buyer's offer; however, the home
              has not closed.
            example: comming_soon,accepting_backup_offers
            default: comming_soon
          required: false
        - in: query
          name: tours
          schema:
            type: string
            description: |
              **Only applicable when listing_status = for_sale or for_rent**

              Filter listing by tours

              You can use one or multiple values separated by commas `,`


              - `must_have_open_house`: Must have open house (For Sale Only)
              - `must_have_3d_tour`: Must have 3D Tour
              - `must_have_showcase`: Must have Showcase (For Sale Only)
              - `instant_tour_available`: Instant Tour Available (For Rent Only)
            example: must_have_open_house,must_have_3d_tour
          required: false
        - in: query
          name: parking_spots
          schema:
            type: integer
            exclusiveMinimum: 0
            description: >-
              Filter by minimum number of parking spots. The value represents
              the lower bound. For example, if `1` is provided, the query will
              return properties with 1 or more parking spots (parking spots >=
              1)
            example: 1
          required: false
        - in: query
          name: must_have_garage
          schema:
            type: boolean
            description: Must have garage
            example: true
          required: false
        - in: query
          name: square_feet_range
          schema:
            type: string
            description: |-
              square_feet_range filter in format **min,max**

              Example `500,2000` square feet from 500 to 2000
            example: 500,2000
          required: false
        - in: query
          name: lot_size_range
          schema:
            type: string
            description: |-
              lot_size_range filter in format **min,max**

              Example: `1000,2000` lot size from 1000 sqft to 2000 sqft
            example: 1000,2000
          required: false
        - in: query
          name: year_built_range
          schema:
            type: string
            description: |-
              year_built_range filter in format **min,max**

              Example: `2015,2020` year built from 2015 to 2020
            example: 2015,2020
          required: false
        - in: query
          name: basement
          schema:
            type: string
            description: |
              Filter listings by basement

              You can use one or multiple values separated by commas `,`


              - `finished`: Finished
              - `unfinished`: Unfinished
            example: finished,unfinished
          required: false
        - in: query
          name: is_single_story_only
          schema:
            type: boolean
            description: Single-story only
            example: true
          required: false
        - in: query
          name: fifty_five_plus_communities
          schema:
            type: string
            enum:
              - include
              - do_not_show
              - only_show
            description: |
              55+ Communities

              - `include`: Include
              - `do_not_show`: Don't show
              - `only_show`: Only show
            default: include
            example: include
          required: false
        - in: query
          name: other_amenities
          schema:
            type: string
            description: >
              Filter listings by other amenities


              You can use one or multiple values separated by commas `,`



              - `must_have_ac`: Must have A/C

              - `must_have_pool`: Must have pool

              - `waterfront`: Waterfront

              - `on_site_parking`: On-site Parking (For Rent Only)

              - `in_unit_laundry`: In-unit Laundry (For Rent Only)

              - `accepts_zillow_applications`: Accepts Zillow Applications (For
              Rent Only)

              - `income_restricted`: Income restricted (For Rent Only)

              - `hardwood_floors`: Hardwood Floors (For Rent Only)

              - `disabled_access`: Disabled Access (For Rent Only)

              - `utilities_included`: Utilities Included (For Rent Only)

              - `short_term_lease_available`: Short term lease available (For
              Rent Only)

              - `furnished`: Furnished (For Rent Only)

              - `outdoor_space`: Outdoor space (For Rent Only)

              - `controlled_access`: Controlled access (For Rent Only)

              - `high_speed_internet`: High speed internet (For Rent Only)

              - `elevator`: Elevator (For Rent Only)

              - `apartment_community`: Apartment Community (For Rent Only)
            example: must_have_ac,must_have_pool
          required: false
        - in: query
          name: view
          schema:
            type: string
            description: |
              Filter listings by view

              You can use one or multiple values separated by commas `,`


              - `city`: City
              - `mountain`: Mountain
              - `park`: Park
              - `water`: Water
            example: city, mountain
          required: false
        - in: query
          name: days_on_zillow
          schema:
            type: string
            enum:
              - '1'
              - '7'
              - '30'
              - '90'
              - 6m
              - 12m
              - 24m
              - 36m
            description: |
              **Only applicable when listing_status = for_sale or for_rent**

              Days on Zillow filter

              - `1`: Listed within the last 1 day
              - `7`: Listed within the last 7 days
              - `30`: Listed within the last 30 days
              - `90`: Listed within the last 90 days
              - `6m`: Listed within the last 6 months
              - `12m`: Listed within the last 12 months
              - `24m`: Listed within the last 24 months
              - `36m`: Listed within the last 36 months
          required: false
        - in: query
          name: keywords
          schema:
            type: string
            description: 'MLS #, yard, etc.'
          required: false
        - in: query
          name: move_in_date
          schema:
            type: string
            pattern: ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
            description: |-
              **Only applicable when listing_status = for_rent**

              Desired move-in date. Format `YYYY-MM-DD` (ISO 8601)
            example: '2026-01-31'
          required: false
        - in: query
          name: pets
          schema:
            type: string
            description: |
              **Only applicable when listing_status = for_rent**

              Filter listings by pets

              You can use one or multiple values separated by commas `,`


              - `allows_large_dogs`: Allows large dogs
              - `allows_small_dogs`: Allows small dogs
              - `allows_cats`: Allows cats
              - `no_pets`: No pets
            example: allows_large_dogs,allows_cats
          required: false
        - in: query
          name: sold_in_last
          schema:
            type: string
            enum:
              - '1'
              - '7'
              - '30'
              - '90'
              - 6m
              - 12m
              - 24m
              - 36m
            description: |
              **Only applicable when listing_status = sold**

              Filter listings by how recently they were sold

              - `1`: Sold within the last 1 day
              - `7`: Sold within the last 7 days
              - `30`: Sold within the last 30 days
              - `90`: Sold within the last 90 days
              - `6m`: Sold within the last 6 months
              - `12m`: Sold within the last 12 months
              - `24m`: Sold within the last 24 months
              - `36m`: Sold within the last 36 months
          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

````