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

> Get full HotPads rental pad (single unit) details by short id and unit (or pad URL): address, coordinates, neighborhood, price and beds/baths/sqft, property type, description, amenities, pet policies, photos, videos, 3D tours, costs and lease terms, special offers, property manager, floor plans, nearby schools (GreatSchools rating and grades) and listing dates.

**Price:** 1 credit

**⚠️ Common errors:** 412: Listing not found (well-formed but nonexistent pad short id/unit)



## OpenAPI

````yaml /openapi/real-estate.json post /api/hotpads/listings
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:
    post:
      tags:
        - /hotpads
      summary: /hotpads/listings
      description: >-
        Get full HotPads rental pad (single unit) details by short id and unit
        (or pad URL): address, coordinates, neighborhood, price and
        beds/baths/sqft, property type, description, amenities, pet policies,
        photos, videos, 3D tours, costs and lease terms, special offers,
        property manager, floor plans, nearby schools (GreatSchools rating and
        grades) and listing dates.


        **Price:** 1 credit


        **⚠️ Common errors:** 412: Listing not found (well-formed but
        nonexistent pad short id/unit)
      operationId: __api_hotpads_listings_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HotpadsListingsPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HotpadsListing'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HotpadsListingsPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        listing:
          type: string
          minLength: 1
      type: object
      required:
        - listing
    HotpadsListing:
      properties:
        '@type':
          type: string
          default: HotpadsListing
        id:
          type: string
        unit:
          anyOf:
            - type: string
            - type: 'null'
        url:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        property_type:
          anyOf:
            - type: string
            - type: 'null'
        listing_type:
          anyOf:
            - type: string
            - type: 'null'
        alias:
          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'
        unit_count:
          anyOf:
            - type: integer
            - type: 'null'
        is_furnished:
          anyOf:
            - type: boolean
            - type: 'null'
        lease_terms:
          anyOf:
            - type: string
            - type: 'null'
        amenities:
          items:
            type: string
          type: array
          default: []
        amenity_highlights:
          items:
            type: string
          type: array
          default: []
        pet_policies:
          items:
            $ref: '#/components/schemas/HotpadsPetPolicy'
          type: array
          default: []
        image:
          anyOf:
            - type: string
            - type: 'null'
        images:
          items:
            type: string
          type: array
          default: []
        photo_count:
          anyOf:
            - type: integer
            - type: 'null'
        videos:
          items:
            type: string
          type: array
          default: []
        tour_urls:
          items:
            type: string
          type: array
          default: []
        costs_fees_note:
          anyOf:
            - type: string
            - type: 'null'
        special_offers:
          items:
            type: string
          type: array
          default: []
        property_manager:
          anyOf:
            - type: string
            - type: 'null'
        property_manager_contact:
          anyOf:
            - type: string
            - type: 'null'
        property_manager_phone:
          anyOf:
            - type: string
            - type: 'null'
        property_manager_website:
          anyOf:
            - type: string
            - type: 'null'
        models:
          items:
            $ref: '#/components/schemas/HotpadsUnit'
          type: array
          default: []
        schools:
          items:
            $ref: '#/components/schemas/HotpadsSchool'
          type: array
          default: []
        listed_at:
          anyOf:
            - type: integer
            - type: 'null'
        created_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
    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
    HotpadsPetPolicy:
      properties:
        '@type':
          type: string
          default: HotpadsPetPolicy
        pet_type:
          anyOf:
            - type: string
            - type: 'null'
        pet_size:
          anyOf:
            - type: string
            - type: 'null'
        allowed:
          anyOf:
            - type: boolean
            - type: 'null'
      type: object
    HotpadsUnit:
      properties:
        '@type':
          type: string
          default: HotpadsUnit
        id:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        type:
          anyOf:
            - type: string
            - type: 'null'
        model_type:
          anyOf:
            - type: string
            - type: 'null'
        bed_count:
          anyOf:
            - type: number
            - type: 'null'
        bath_count:
          anyOf:
            - type: number
            - type: 'null'
        price_min:
          anyOf:
            - type: number
            - type: 'null'
        price_max:
          anyOf:
            - type: number
            - type: 'null'
        sqft:
          anyOf:
            - type: number
            - type: 'null'
        availability_date:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    HotpadsSchool:
      properties:
        '@type':
          type: string
          default: HotpadsSchool
        name:
          anyOf:
            - type: string
            - type: 'null'
        type:
          anyOf:
            - type: string
            - type: 'null'
        rating:
          anyOf:
            - type: integer
            - type: 'null'
        low_grade:
          anyOf:
            - type: string
            - type: 'null'
        high_grade:
          anyOf:
            - type: string
            - type: 'null'
        is_private:
          anyOf:
            - type: boolean
            - type: 'null'
        phone:
          anyOf:
            - type: string
            - type: 'null'
        student_count:
          anyOf:
            - type: integer
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        address:
          anyOf:
            - $ref: '#/components/schemas/HotpadsAddress'
            - 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

````