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

> Get Apartment List market rent summary for a location by numeric location id: average rent by bedroom type with month-over-month trend, average and median price and square footage, total property/unit counts, and the share of listings offering each amenity.

**Price:** 1 credit

**⚠️ Common errors:** 412: Location not found (unknown location id)



## OpenAPI

````yaml /openapi/real-estate.json post /api/apartmentlist/locations
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/locations:
    post:
      tags:
        - /apartmentlist
      summary: /apartmentlist/locations
      description: >-
        Get Apartment List market rent summary for a location by numeric
        location id: average rent by bedroom type with month-over-month trend,
        average and median price and square footage, total property/unit counts,
        and the share of listings offering each amenity.


        **Price:** 1 credit


        **⚠️ Common errors:** 412: Location not found (unknown location id)
      operationId: __api_apartmentlist_locations_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApartmentlistLocationsPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApartmentlistLocationSummary'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ApartmentlistLocationsPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        location_id:
          type: integer
          exclusiveMinimum: 0
        location_name:
          type: string
          default: ''
      type: object
      required:
        - location_id
    ApartmentlistLocationSummary:
      properties:
        '@type':
          type: string
          default: ApartmentlistLocationSummary
        location_id:
          anyOf:
            - type: integer
            - type: 'null'
        location_name:
          anyOf:
            - type: string
            - type: 'null'
        average_rent:
          anyOf:
            - $ref: '#/components/schemas/ApartmentlistAverageRent'
            - type: 'null'
        avg_price:
          anyOf:
            - type: number
            - type: 'null'
        avg_sqft:
          anyOf:
            - type: integer
            - type: 'null'
        median_price:
          anyOf:
            - type: number
            - type: 'null'
        median_sqft:
          anyOf:
            - type: integer
            - type: 'null'
        property_count:
          anyOf:
            - type: integer
            - type: 'null'
        unit_count:
          anyOf:
            - type: integer
            - type: 'null'
        amenity_percentages:
          additionalProperties:
            type: number
          type: object
          default: {}
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    ApartmentlistAverageRent:
      properties:
        '@type':
          type: string
          default: ApartmentlistAverageRent
        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'
        trend:
          anyOf:
            - type: string
            - type: 'null'
        pricing_date:
          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

````