# /apartments/listings

`POST /api/apartments/listings`

Price: 10 credits

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, ratings, pet policy, year built, unit count and lease options.

## How to use it

Accepts either the bare shortcode (`40n18nj`) or any listing URL containing it, including the slug-less `/listing/{shortcode}/` form. `rent_low`/`rent_high` are derived from the floor plans, so a property advertising `Call for Rent` returns them empty while `floor_plans` is still populated. Read `blended_rating` rather than `rating`: the renter-review block the source used to publish is gone, so everything fed by it now comes back empty, which means unavailable rather than 'this property has none'. That blended score is the operator's own and sits in a 3.0-5.0 band, so it will not surface badly-rated properties. `pets_allowed` is true when the property publishes a pet policy and null when it publishes none — a null is not a refusal. Single-unit condo and house listings have no property name of their own, so `name` falls back to the street address.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `listing` (string, required) — Apartments.com listing shortcode or a listing URL containing it (examples: "40n18nj", "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"; minLength: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "ApartmentsListing")
- `id` (string, required)
- `url` (string, required)
- `name` (string, nullable)
- `description` (string, nullable)
- `phone` (string, nullable)
- `address` (object, nullable)
  - `@type` (string) (default: "ApartmentsAddress")
  - `street` (string, nullable)
  - `city` (string, nullable)
  - `region` (string, nullable)
  - `postal_code` (string, nullable)
  - `country` (string, nullable)
- `geo` (object, nullable)
  - `@type` (string) (default: "ApartmentsGeo")
  - `latitude` (number, nullable)
  - `longitude` (number, nullable)
- `rent_low` (integer, nullable)
- `rent_high` (integer, nullable)
- `currency` (string, nullable)
- `availability` (string, nullable)
- `pets_allowed` (boolean, nullable)
- `year_built` (integer, nullable)
- `unit_count` (integer, nullable)
- `rating` (number, nullable)
- `rating_count` (integer, nullable)
- `blended_rating` (number, nullable)
- `community_rating` (number, nullable)
- `image` (string, nullable)
- `images` (array) (default: [])
- `community_amenities` (array) (default: [])
- `apartment_amenities` (array) (default: [])
- `floor_plans` (array) (default: [])
  - `@type` (string) (default: "ApartmentsFloorPlan")
  - `name` (string, nullable)
  - `beds` (integer, nullable)
  - `baths` (number, nullable)
  - `sqft` (integer, nullable)
  - `rent_low` (integer, nullable)
  - `rent_high` (integer, nullable)
- `reviews` (array) (default: [])
  - `@type` (string) (default: "ApartmentsReview")
  - `author` (string, nullable)
  - `text` (string, nullable)
  - `rating` (number, nullable)
  - `created_at` (string, nullable)
- `scores` (object) (default: {})
  - `*` (string)
- `lease_options` (array) (default: [])

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

Listing not found (well-formed but nonexistent shortcode)

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.