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

# /apartmentlist/listings/search

> Search Apartment List rental listings by location ({state}/{city}): for each result returns name, geo, per-bedroom starting price and photo. Supports filters by bedrooms, bathrooms, price range, amenities, housing type, curated collection and move-in date.

**Price:** 20 credits



## OpenAPI

````yaml /openapi/real-estate.json post /api/apartmentlist/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/apartmentlist/listings/search:
    post:
      tags:
        - /apartmentlist
      summary: /apartmentlist/listings/search
      description: >-
        Search Apartment List rental listings by location ({state}/{city}): for
        each result returns name, geo, per-bedroom starting price and photo.
        Supports filters by bedrooms, bathrooms, price range, amenities, housing
        type, curated collection and move-in date.


        **Price:** 20 credits
      operationId: __api_apartmentlist_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/ApartmentlistListingsSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApartmentlistSearchListing'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ApartmentlistListingsSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        location:
          type: string
          minLength: 1
        count:
          type: integer
          minimum: 1
        beds:
          anyOf:
            - items:
                $ref: '#/components/schemas/ApartmentlistBeds'
              type: array
            - type: 'null'
        baths:
          anyOf:
            - $ref: '#/components/schemas/ApartmentlistBaths'
            - type: 'null'
        min_price:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        max_price:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        amenities:
          anyOf:
            - items:
                $ref: '#/components/schemas/ApartmentlistAmenity'
              type: array
            - type: 'null'
        occupancy_type:
          anyOf:
            - $ref: '#/components/schemas/ApartmentlistOccupancy'
            - type: 'null'
        collection:
          anyOf:
            - $ref: '#/components/schemas/ApartmentlistCollection'
            - type: 'null'
        move_in_date:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - location
        - count
    ApartmentlistSearchListing:
      properties:
        '@type':
          type: string
          default: ApartmentlistSearchListing
        id:
          type: string
        url:
          anyOf:
            - type: string
            - type: 'null'
        alias:
          anyOf:
            - type: string
            - type: 'null'
        name:
          anyOf:
            - type: string
            - type: 'null'
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
        price_studio:
          anyOf:
            - type: number
            - type: 'null'
        price_1br:
          anyOf:
            - type: number
            - type: 'null'
        price_2br:
          anyOf:
            - type: number
            - type: 'null'
        price_3br:
          anyOf:
            - type: number
            - type: 'null'
        show_price:
          anyOf:
            - type: boolean
            - type: 'null'
        rank:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
      required:
        - id
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    ApartmentlistBeds:
      type: string
      enum:
        - studio
        - '1'
        - '2'
        - '3'
    ApartmentlistBaths:
      type: string
      enum:
        - '1'
        - '2'
        - '3'
    ApartmentlistAmenity:
      type: string
      enum:
        - accessible
        - air_conditioning
        - bbq
        - balcony
        - bathtub
        - business_center
        - carpet
        - cat_friendly
        - ceiling_fan
        - dishwasher
        - dog_friendly
        - pet_friendly
        - pickleball
        - doorman
        - elevator
        - fireplace
        - furnished
        - garage
        - garbage_disposal
        - granite_counter
        - gym
        - hardwood_floors
        - heat
        - hot_tub
        - ice_maker
        - in_unit_laundry
        - on_site_laundry
        - parking
        - pool
        - stainless_steel
        - walk_in_closet
        - laundry_connections
    ApartmentlistOccupancy:
      type: string
      enum:
        - student
        - senior
    ApartmentlistCollection:
      type: string
      enum:
        - most_popular
        - best_rent_specials
        - luxury
        - best_in_budget
    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

````