Apartment List

Description

Search for apartments in the US with personalized recommendations, just for you.

Details

Added5 months ago

Votes0

Total Installations0

Categoryreal estate

Websiteapartmentlist.com

https://partner.apartmentlist.com/.well-known/ai-plugin.json

{
    "schema_version": "v1",
    "name_for_human": "Apartment List",
    "name_for_model": "Apartment_Search_With_Apartment_List",
    "description_for_human": "Search for apartments in the US with personalized recommendations, just for you.",
    "description_for_model": "Tool for searching available apartment for rent in the US, you can search for apartments by city, state, amenities, prices, etc. The tool will return a list of properties that are relevant for the search query used.\nIf the user is not satisfied with the results, they can update their preferences for more personalized recommendations.",
    "auth": {
        "type": "service_http",
        "authorization_type": "bearer",
        "verification_tokens": {
            "openai": "375159b8727e4742956ad2a5e670d2b3"
        }
    },
    "api": {
        "type": "openapi",
        "url": "https://partner.apartmentlist.com/openai.yaml",
        "is_user_authenticated": false
    },
    "logo_url": "https://res.cloudinary.com/apartmentlist/image/upload/Logos/Logo_House.png",
    "contact_email": "plugin-help@apartmentlist.com.com",
    "legal_info_url": "https://www.apartmentlist.com/about/terms"
}

https://partner.apartmentlist.com/openai.yaml

openapi: 3.0.1
info:
  title: US Apartments for rent search API
  description: API for apartment search in the US, you can search for apartments by city, state, amenities, prices, etc.
  version: 1.0.0
servers:
  - url: https://partner.apartmentlist.com
paths:
  /api/open_ai/listings:
    get:
      operationId: findApartmentsEndpoint
      summary: Search for apartments for rent in the US
      parameters:
        - name: city
          in: query
          description: The city in which to search for apartments
          required: true
          schema:
            type: string
        - name: state
          in: query
          description: The state in which to search for apartments (two-letter state code). This parameter is required; the client must infer the state from the city if state is not provided in the prompt.
          required: true
          schema:
            type: string
          example: CA
        - name: neighborhood
          in: query
          description: The neighborhood in which to search for apartments
          schema:
            type: string
        - name: amenities
          in: query
          description: Amenities available at the property. 
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
              - has_pool
              - has_in_unit_laundry
              - is_dog_friendly
              - is_pet_friendly
              - is_cat_friendly
              - has_hardwood_floors
              - has_air_conditioning
              - has_parking
              - has_gym
              - has_garage
              - has_elevator
              - has_dishwasher
              - has_furnished_option
              - has_on_site_laundry
              - is_accessible
        - name: min_price
          in: query
          description: The minimum price of apartments to search for
          schema:
            type: number
            format: float
        - name: max_price
          in: query
          description: The maximum price of apartments to search for
          schema:
            type: number
            format: float
        - name: bedroom_count
          in: query
          description: The number of bedrooms the apartment has
          schema:
            type: number
            format: integer
        - name: move_in_date
          in: query
          description: The move-in date for the apartment
          schema:
            type: string
            format: date
        - name: limit
          in: query
          description: Maximum number of matching apartments to include in the search results
          schema:
            type: number
            format: integer
      responses:
        '200':
          description: A list of apartments that match the search criteria
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: The unique identifier of the property
                    name:
                      type: string
                      description: The name of the apartment complex. The name should embed the URL of the apartment complex listing.
                    address:
                      type: string
                      description: The street address of the apartment complex
                    city:
                      type: string
                      description: The city in which the apartment complex is located
                    state:
                      type: string
                      description: The state in which the apartment complex is located (two-letter state code)
                    zip:
                      type: string
                      description: The ZIP code of the apartment complex
                    amenities:
                      type: array
                      description: A list of amenities offered by the apartment complex
                      items:
                        type: string
                    price:
                      type: number
                      description: The monthly rent for the apartment
                      format: float
                    url:
                      type: string
                      description: The URL of the apartment complex listing. This URL should be embedded in the name of the apartment complex.
                    units:
                      type: array
                      description: A list of available units at the apartment complex
                      items:
                        type: object
                        properties:
                          price:
                            type: number
                            description: The monthly rent for the unit
                            format: float
                          move_in_date:
                            type: string
                            description: The earliest move-in date for the unit
                            format: date
                          bedrooms:
                            type: integer
                            description: The number of bedrooms in the unit
                          sqft:
                            type: string
                            description: Size of the unit in square feet.
        '400':
          description: Bad request - invalid search criteria provided
        '500':
          description: Internal server error - something went wrong on the server