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

> Get full Apartments.com rental listing details by shortcode (or listing URL): name, description, address, geo, rent range, floor plans (beds/baths/sqft/rent), amenities, photos, reviews, ratings, pet policy, year built, lease options and walk/transit scores.

**Price:** 10 credits

**⚠️ Common errors:** 412: Listing not found (well-formed but nonexistent shortcode)



## OpenAPI

````yaml /openapi/real-estate.json post /api/apartments/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/apartments/listings:
    post:
      tags:
        - /apartments
      summary: /apartments/listings
      description: >-
        Get full Apartments.com rental listing details by shortcode (or listing
        URL): name, description, address, geo, rent range, floor plans
        (beds/baths/sqft/rent), amenities, photos, reviews, ratings, pet policy,
        year built, lease options and walk/transit scores.


        **Price:** 10 credits


        **⚠️ Common errors:** 412: Listing not found (well-formed but
        nonexistent shortcode)
      operationId: __api_apartments_listings_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApartmentsListingsPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApartmentsListing'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ApartmentsListingsPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        listing:
          type: string
          minLength: 1
      type: object
      required:
        - listing
    ApartmentsListing:
      properties:
        '@type':
          type: string
          default: ApartmentsListing
        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'
        pets_allowed:
          anyOf:
            - type: boolean
            - type: 'null'
        year_built:
          anyOf:
            - type: integer
            - type: 'null'
        unit_count:
          anyOf:
            - type: integer
            - type: 'null'
        rating:
          anyOf:
            - type: number
            - type: 'null'
        rating_count:
          anyOf:
            - type: integer
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
        images:
          items:
            type: string
          type: array
          default: []
        community_amenities:
          items:
            type: string
          type: array
          default: []
        apartment_amenities:
          items:
            type: string
          type: array
          default: []
        floor_plans:
          items:
            $ref: '#/components/schemas/ApartmentsFloorPlan'
          type: array
          default: []
        reviews:
          items:
            $ref: '#/components/schemas/ApartmentsReview'
          type: array
          default: []
        scores:
          additionalProperties:
            type: string
          type: object
          default: {}
        lease_options:
          items:
            type: string
          type: array
          default: []
      type: object
      required:
        - id
        - url
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    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
    ApartmentsFloorPlan:
      properties:
        '@type':
          type: string
          default: ApartmentsFloorPlan
        name:
          anyOf:
            - type: string
            - type: 'null'
        beds:
          anyOf:
            - type: integer
            - type: 'null'
        baths:
          anyOf:
            - type: number
            - type: 'null'
        sqft:
          anyOf:
            - type: integer
            - type: 'null'
        rent_low:
          anyOf:
            - type: integer
            - type: 'null'
        rent_high:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
    ApartmentsReview:
      properties:
        '@type':
          type: string
          default: ApartmentsReview
        author:
          anyOf:
            - type: string
            - type: 'null'
        text:
          anyOf:
            - type: string
            - type: 'null'
        rating:
          anyOf:
            - type: number
            - type: 'null'
        created_at:
          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

````