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

# /apartments/listings/search

> Search Apartments.com rental listings by location (city-state): for each result returns name, address, geo, rent range, per-bedroom pricing, amenities, move-in specials, photo and phone. Supports filters by bedrooms, home type and price range.

**Price:** 10 credits per 40 results



## OpenAPI

````yaml /openapi/real-estate.json post /api/apartments/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/apartments/listings/search:
    post:
      tags:
        - /apartments
      summary: /apartments/listings/search
      description: >-
        Search Apartments.com rental listings by location (city-state): for each
        result returns name, address, geo, rent range, per-bedroom pricing,
        amenities, move-in specials, photo and phone. Supports filters by
        bedrooms, home type and price range.


        **Price:** 10 credits per 40 results
      operationId: __api_apartments_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/ApartmentsListingsSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApartmentsSearchListing'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ApartmentsListingsSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        location:
          type: string
          minLength: 1
        count:
          type: integer
          minimum: 1
        bedrooms:
          anyOf:
            - $ref: '#/components/schemas/ApartmentsBedrooms'
            - type: 'null'
        home_type:
          anyOf:
            - $ref: '#/components/schemas/ApartmentsHomeType'
            - type: 'null'
        min_price:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
        max_price:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
      type: object
      required:
        - location
        - count
    ApartmentsSearchListing:
      properties:
        '@type':
          type: string
          default: ApartmentsSearchListing
        id:
          type: string
        url:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        phone:
          anyOf:
            - type: string
            - type: 'null'
        address:
          anyOf:
            - $ref: '#/components/schemas/ApartmentsAddress'
            - type: 'null'
        geo:
          anyOf:
            - $ref: '#/components/schemas/ApartmentsGeo'
            - type: 'null'
        rent_low:
          anyOf:
            - type: integer
            - type: 'null'
        rent_high:
          anyOf:
            - type: integer
            - type: 'null'
        currency:
          anyOf:
            - type: string
            - type: 'null'
        availability:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
        amenities:
          items:
            type: string
          type: array
          default: []
        specials:
          items:
            type: string
          type: array
          default: []
        bed_rents:
          items:
            $ref: '#/components/schemas/ApartmentsSearchBedRent'
          type: array
          default: []
      type: object
      required:
        - id
        - url
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    ApartmentsBedrooms:
      type: string
      enum:
        - studio
        - '1'
        - '2'
        - '3'
        - '4'
    ApartmentsHomeType:
      type: string
      enum:
        - apartments
        - houses
        - condos
        - townhomes
    ApartmentsAddress:
      properties:
        '@type':
          type: string
          default: ApartmentsAddress
        street:
          anyOf:
            - type: string
            - type: 'null'
        city:
          anyOf:
            - type: string
            - type: 'null'
        region:
          anyOf:
            - type: string
            - type: 'null'
        postal_code:
          anyOf:
            - type: string
            - type: 'null'
        country:
          anyOf:
            - type: string
            - type: 'null'
      type: object
    ApartmentsGeo:
      properties:
        '@type':
          type: string
          default: ApartmentsGeo
        latitude:
          anyOf:
            - type: number
            - type: 'null'
        longitude:
          anyOf:
            - type: number
            - type: 'null'
      type: object
    ApartmentsSearchBedRent:
      properties:
        '@type':
          type: string
          default: ApartmentsSearchBedRent
        beds:
          anyOf:
            - type: string
            - type: 'null'
        price:
          anyOf:
            - type: integer
            - 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

````