/apartmentlist/locations

POST /api/apartmentlist/locations

Price: 1 credit

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.

How to use it

Fetch Apartment List rental-market summary for a location by its numeric location_id (obtain it via apartmentlist/locations/search). Returns average_rent (price_studio/price_1br/price_2br/price_3br + trend), avg/median price and sqft, property_count, unit_count and amenity_percentages.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location_id integer required — Apartment List numeric location id (examples: 660574; >: 0)
• location_name string — Location display name (default: "")

Response

• @type string (default: "ApartmentlistLocationSummary")
• location_id integer nullable
• location_name string nullable
• average_rent object nullable
  • @type string (default: "ApartmentlistAverageRent")
  • price_studio number nullable
  • price_1br number nullable
  • price_2br number nullable
  • price_3br number nullable
  • trend string nullable
  • pricing_date string nullable
• avg_price number nullable
• avg_sqft integer nullable
• median_price number nullable
• median_sqft integer nullable
• property_count integer nullable
• unit_count integer nullable
• amenity_percentages object (default: {})
  • * number

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 — Location not found (unknown location id) 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 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 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 Wait at least 30 seconds, then retry.

Response 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.