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

# /hotpads/listings/search

> Search HotPads rental listings by location (city and state) with optional filters: rental category (apartments, houses, condos, townhomes, rooms, sublets, corporate housing), property type, price range, bedrooms, bathrooms, pets, amenities, laundry, furnished, square footage, keywords, restricted housing programs, promotions and sort order. Returns listings with address, coordinates, price and beds/baths/sqft ranges, property type, images, amenity highlights and posting dates.

**Price:** 20 credits per 200 results



## OpenAPI

````yaml /openapi/real-estate.json post /api/hotpads/listings/search
openapi: 3.1.0
info:
  title: Any Site API
  description: >+
    Any Site API provides programmatic access to data from LinkedIn, Instagram,
    Twitter, and other platforms.


    ## Authentication


    All API endpoints require an `access-token` header with a valid API token.
    Tokens can be created in the [dashboard](https://app.anysite.io/).


    ## Pricing


    Each endpoint has a credit cost listed in its description. Credits are
    deducted from your token balance per request.

  version: 0.0.1
servers: []
security:
  - AccessToken: []
paths:
  /api/hotpads/listings/search:
    post:
      tags:
        - /hotpads
      summary: /hotpads/listings/search
      description: >-
        Search HotPads rental listings by location (city and state) with
        optional filters: rental category (apartments, houses, condos,
        townhomes, rooms, sublets, corporate housing), property type, price
        range, bedrooms, bathrooms, pets, amenities, laundry, furnished, square
        footage, keywords, restricted housing programs, promotions and sort
        order. Returns listings with address, coordinates, price and
        beds/baths/sqft ranges, property type, images, amenity highlights and
        posting dates.


        **Price:** 20 credits per 200 results
      operationId: __api_hotpads_listings_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HotpadsSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HotpadsSearchListing'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HotpadsSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        location:
          type: string
          minLength: 1
        category:
          $ref: '#/components/schemas/HotpadsCategory'
          default: apartments
        home_type:
          anyOf:
            - items:
                $ref: '#/components/schemas/HotpadsHomeType'
              type: array
            - type: 'null'
        price_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        price_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        beds:
          anyOf:
            - $ref: '#/components/schemas/HotpadsBeds'
            - type: 'null'
        baths:
          anyOf:
            - $ref: '#/components/schemas/HotpadsBaths'
            - type: 'null'
        pets:
          anyOf:
            - items:
                $ref: '#/components/schemas/HotpadsPet'
              type: array
            - type: 'null'
        amenities:
          anyOf:
            - items:
                $ref: '#/components/schemas/HotpadsAmenity'
              type: array
            - type: 'null'
        laundry:
          anyOf:
            - items:
                $ref: '#/components/schemas/HotpadsLaundry'
              type: array
            - type: 'null'
        furnished:
          anyOf:
            - type: boolean
            - type: 'null'
        sqft_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        sqft_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        keywords:
          anyOf:
            - type: string
            - type: 'null'
        restricted_housing:
          anyOf:
            - $ref: '#/components/schemas/HotpadsRestriction'
            - type: 'null'
        has_promotions:
          anyOf:
            - type: boolean
            - type: 'null'
        sort:
          $ref: '#/components/schemas/HotpadsSort'
          default: newest
        count:
          type: integer
          minimum: 1
      type: object
      required:
        - location
        - count
    HotpadsSearchListing:
      properties:
        '@type':
          type: string
          default: HotpadsSearchListing
        id:
          type: string
        url:
          type: string
        property_type:
          anyOf:
            - type: string
            - type: 'null'
        listing_type:
          anyOf:
            - type: string
            - type: 'null'
        alias:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - $ref: '#/components/schemas/HotpadsAddress'
            - type: 'null'
        neighborhood:
          anyOf:
            - type: string
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        price_min:
          anyOf:
            - type: number
            - type: 'null'
        price_max:
          anyOf:
            - type: number
            - type: 'null'
        bed_min:
          anyOf:
            - type: number
            - type: 'null'
        bed_max:
          anyOf:
            - type: number
            - type: 'null'
        bath_min:
          anyOf:
            - type: number
            - type: 'null'
        bath_max:
          anyOf:
            - type: number
            - type: 'null'
        sqft_min:
          anyOf:
            - type: number
            - type: 'null'
        sqft_max:
          anyOf:
            - type: number
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
        photo_count:
          anyOf:
            - type: integer
            - type: 'null'
        has_special_offers:
          anyOf:
            - type: boolean
            - type: 'null'
        income_restricted:
          anyOf:
            - type: boolean
            - type: 'null'
        senior_housing:
          anyOf:
            - type: boolean
            - type: 'null'
        student_housing:
          anyOf:
            - type: boolean
            - type: 'null'
        military_housing:
          anyOf:
            - type: boolean
            - type: 'null'
        amenity_highlights:
          items:
            type: string
          type: array
          default: []
        activated_at:
          anyOf:
            - type: integer
            - type: 'null'
        updated_at:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
      required:
        - id
        - url
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    HotpadsCategory:
      type: string
      enum:
        - apartments
        - houses
        - condos
        - townhomes
        - rooms
        - sublets
        - corporate_housing
    HotpadsHomeType:
      type: string
      enum:
        - apartment
        - condo
        - duplex
        - house
        - townhouse
    HotpadsBeds:
      type: string
      enum:
        - studio
        - one_plus
        - two_plus
        - three_plus
        - four_plus
    HotpadsBaths:
      type: string
      enum:
        - one_plus
        - one_half_plus
        - two_plus
        - three_plus
        - four_plus
    HotpadsPet:
      type: string
      enum:
        - cats
        - dogs
    HotpadsAmenity:
      type: string
      enum:
        - cooling
        - heating
        - parking
        - gated_entry
        - doorman
        - fitness_center
        - swimming_pool
        - dishwasher
    HotpadsLaundry:
      type: string
      enum:
        - in_unit
        - shared
    HotpadsRestriction:
      type: string
      enum:
        - income
        - senior
        - student
        - military
    HotpadsSort:
      type: string
      enum:
        - recommended
        - newest
    HotpadsAddress:
      properties:
        '@type':
          type: string
          default: HotpadsAddress
        street:
          anyOf:
            - type: string
            - type: 'null'
        city:
          anyOf:
            - type: string
            - type: 'null'
        state:
          anyOf:
            - type: string
            - type: 'null'
        zip_code:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
      type: object
      required:
        - loc
        - msg
        - type
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: access-token
      description: API token from the dashboard

````