# Apartments Property

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/apartments/property` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 2 credits per call |
| **Documentation** | https://www.piloterr.com/library/apartments-property |

## Description

Extract a full Apartments.com rental listing from a property URL, including amenities, gallery, description, geolocation, and unit details via browser rendering.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/apartments/property' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Lookup 141 E 33rd St, New York

```json
{
  "id": "p6b4mes",
  "url": "https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/",
  "image": "https://images1.apartments.com/i2/SF9HSqkGqXN0cjmR2cUNbgLuxyXklZLpKYtInYim0XI/111/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-primary-photo.jpg?p=1",
  "phone": "8555266751",
  "title": "$7,210",
  "units": [],
  "images": [
    "https://images1.apartments.com/i2/SF9HSqkGqXN0cjmR2cUNbgLuxyXklZLpKYtInYim0XI/111/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-primary-photo.jpg?p=1",
    "https://images1.apartments.com/i2/_LYYrJa6ncHlDFoi81j_UsjuW84Nvn4w9YGihAPQA3o/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1",
    "https://images1.apartments.com/i2/XSVQGO_3LitnwCCtEhZTwYhxNmk86nNac9DzNVS_eg8/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1",
    "https://images1.apartments.com/i2/KCjnNj_AfdQg2j-NlhNv0snlvJb2qptQy8_wG0jfEb4/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1",
    "https://images1.apartments.com/i2/Fof83ipViTC_uNqRZlf41AfpD7t1xs4eGFBN78nzXNY/117/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1"
  ],
  "address": "New York, NY 10016",
  "bedrooms": "2",
  "amenities": [
    "Wi-Fi",
    "Air Conditioning",
    "Heating",
    "Dishwasher",
    "Kitchen",
    "Microwave",
    "Oven",
    "Refrigerator",
    "Freezer",
    "Furnished",
    "Doorman",
    "Elevator",
    "Corporate Suites",
    "Fitness Center"
  ],
  "bathrooms": "1.5",
  "rent_range": null,
  "description": "141 E 33rd St Unit SI FL16-ID43\n\n1 - 12 Month Lease , Available Aug 9\n\nFeel at home wherever you choose to live with Blueground. You’ll love this sophisticated Kips Bay furnished two bedroom apartment with its modern decor, fully equipped kitchen, and bright living room with great high floor views. Ideally located, you’re close to all the best that New York has to offer! (ID #NYC43)\n\nThe advertised rate of $7,210/month is the lowest available price, based on a 12 month(s) stay with a move-in date of August 9, 2026. \n\nRates vary depending on the duration of stay, season, and other parameters. For exact pricing and additional pricing components, please visit our website and enter your desired move-in and move-out dates. The rate is applicable when billed upfront; it can be higher if billed in multiple payments.\nBrokers are welcome to reach out.\n\nWere you looking for an unfurnished lease? Try Blueground instead and upgrade from unfurnished to furnished living:\n  - Furnished at rates comparable to unfurnished\n  - No setup or furniture costs - save thousands\n  - Move-in ready - save time, just bring your suitcase\n\nDesigned with you in mind\n\nGorgeous furniture, fully equipped kitchen, smart TV, and a premium wireless speaker are just a few of the amenities you’ll find inside this two bedroom apartment. Ideally located in New York, you’ll find a lot to love outside as well. When you’re ready to relax, you’ll be happy to discover every Blueground bedroom comes with superior quality mattresses, fully stocked linens, and cozy towels. We handle everything so you can simply show up and start living. \n\nSleeping arrangements\n\n      Queen Bed, 63in/160cm\n      Queen Bed, 63in/160cm\n\nAmenities\n\nBuilding amenities unique to this two bedroom apartment include an on-site:\n\n  - Doorman\n  - Dryer in building\n  - Elevator\n  - Washing machine in building\n  - Pets allowed\n\nArrival and ongoing support\n\nThe entire apartment is yours to enjoy!\n\nThroughout your stay, you’ll have access to our Client Experience team through the Blueground App. You can schedule additional cleanings, submit maintenance requests, and view our neighborhood recommendations with just a few taps.\n\nWe’ll share all details upon confirmation of your stay.\n\nIdeally Located\n\nThis furnished property is situated in Kips Bay. Stretching from the East River to Lexington Avenue, the peaceful neighborhood offers convenience and easy access to the rest of the city. Several hospitals are located here, making it a hub for medical care. Kips Bay offers dining options for every budget as well as numerous cinemas and fitness centers. During the weekends, locals stroll alongside the water, take the water taxi to another borough, or hang out in one of the parks, such as Bellevue South. From here, Rockefeller Center is only 20 minutes away by subway.\n\nOther things to note\n\nThis Blueground apartment has flexible lease options, allowing you to book it for one month, a year, or more.\nPets are welcome, though weight limits and breed restrictions apply and may incur fees.\nBrokes CYOF.\nWe take great pride in ensuring every photo displayed is shot in our own units with our actual furnishings. That said, we regularly refresh our decor and furniture arrangement, which may differ from what’s pictured.\n [SI]",
  "geolocation": {
    "latitude": 40.74576,
    "longitude": -73.97978
  },
  "square_feet": "850 sq ft"
}
```

## Documentation

## Overview
Extract the full public profile of any Apartments.com rental listing. Returns photos, amenities, bedroom/bathroom counts, square footage, description, geolocation, and contact phone.

Apartments.com property pages are JavaScript SPAs. Gallery images, amenities, and unit details load client-side after the initial HTML shell. Piloterr uses **website rendering** to load the page in a browser, wait for the listing to hydrate, and scrape structured JSON from the rendered DOM.

## Quickstart
```
GET https://api.piloterr.com/v2/apartments/property?query=https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Full Apartments.com property URL |

## Response fields
| Field | Type | Description |
|---|---|---|
| `id` | string | Apartments.com listing ID |
| `url` | string | Canonical property URL |
| `title` | string | Display title (often the headline price) |
| `phone` | string \| null | Contact phone |
| `address` | string | Formatted address |
| `bedrooms` | string \| null | Bedroom count label |
| `bathrooms` | string \| null | Bathroom count label |
| `square_feet` | string \| null | Area string (e.g. `850 sq ft`) |
| `rent_range` | string \| null | Rent range when available |
| `description` | string \| null | Full listing description |
| `image` | string \| null | Main photo URL |
| `images` | array | Photo gallery URLs |
| `amenities` | array | Amenity labels |
| `units` | array | Available unit rows when exposed |
| `geolocation` | object | `{ latitude, longitude }` |

## Notes
- Targets **apartments.com** (US).
- `title` may reflect the headline rent rather than the building name on some listings.
- `units` may be empty on single-unit listings.
- `rent_range` may be `null` when only one price tier is shown.

## Main use cases
- Enrich CRM records with amenities, photos, and square footage
- Extract full listing descriptions for market analysis
- Monitor individual rentals for price and availability changes
- Build rental comparison tools with geolocated apartment data