/apartmentlist/listings

POST /api/apartmentlist/listings

Price: 10 credits

Get full Apartment List rental listing details by listing URL (or /{state}/{city}/{slug} path): name, description, address, geo, phone, images, virtual tours, community/unit amenities, top amenities, walk and transit scores, parking, office hours, pet policy, fees, floor plans with units (base/total price, fees, lease length, availability, sqft), market average rent, nearby schools and points of interest, resident reviews, and similar listings.

How to use it

Fetch a single Apartment List rental community by its listing URL or /{state}/{city}/{slug} path (the alias returned by apartmentlist/listings/search). Returns one listing with name, description, address, geo, phone, images, virtual_tours (3D tour links), community_amenities, unit_amenities, top_amenities, walk_score, transit_score, parking, office_hours, pets/pet_policy, fees, floor_plans (beds/baths/sqft/price + units with base_price/total_price/required_fees/lease_length/availability/apply_url), average_rent, schools, pois, reviews and similar_listings.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — Apartment List listing URL or /{state}/{city}/{slug} path (examples: "/co/denver/ladora-modern-apartments", "https://www.apartmentlist.com/co/denver/ladora-modern-apartments"; minLength: 1)

Response

• @type string (default: "ApartmentlistListing")
• id string required
• url string required
• alias string nullable
• name string nullable
• description string nullable
• highlight string nullable
• formatted_address string nullable
• street_address string nullable
• city string nullable
• state string nullable
• zip string nullable
• county string nullable
• neighborhood string nullable
• latitude number nullable
• longitude number nullable
• phone string nullable
• management_company string nullable
• source_name string nullable
• occupancy_types array (default: [])
• show_price boolean nullable
• has_unit_level_availability boolean nullable
• tour_booking_allowed boolean nullable
• updated_at integer nullable
• availability_checked_at integer nullable
• image string nullable
• images array (default: [])
• virtual_tours array (default: [])
  • @type string (default: "ApartmentlistVirtualTour")
  • provider string nullable
  • link string required
  • tags array (default: [])
• community_amenities array (default: [])
• unit_amenities array (default: [])
• specials array (default: [])
  • @type string (default: "ApartmentlistSpecial")
  • text string nullable
  • special_type string nullable
  • highlighted boolean nullable
  • monthly_price_discount number nullable
  • estimated_value number nullable
  • expires_at integer nullable
• application_fee string nullable
• additional_fees string nullable
• deposit_fee string nullable
• move_in_fees string nullable
• lease_terms string nullable
• utilities_included string nullable
• income_requirement string nullable
• income_multiplier number nullable
• walk_score object nullable
  • @type string (default: "ApartmentlistScore")
  • score integer nullable
  • description string nullable
  • summary string nullable
  • link string nullable
• transit_score object nullable
  • @type string (default: "ApartmentlistScore")
  • score integer nullable
  • description string nullable
  • summary string nullable
  • link string nullable
• top_amenities array (default: [])
  • @type string (default: "ApartmentlistTopAmenity")
  • name string required
  • group string nullable
  • group_rank number nullable
  • filter_param string nullable
  • image string nullable
• parking array (default: [])
  • @type string (default: "ApartmentlistParking")
  • category string nullable
  • comment string nullable
  • space_fee number nullable
  • spaces integer nullable
  • assigned_available boolean nullable
  • assigned_has_fee boolean nullable
• office_hours array (default: [])
  • @type string (default: "ApartmentlistOfficeHours")
  • day string required
  • opens_at integer nullable
  • closes_at integer nullable
• pet_policy object nullable
  • @type string (default: "ApartmentlistPetPolicy")
  • allowed boolean nullable
  • allowed_pets array (default: [])
  • deposit string nullable
  • rent string nullable
  • fee string nullable
  • restrictions 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
• floor_plans array (default: [])
  • @type string (default: "ApartmentlistFloorPlan")
  • id integer nullable
  • name string nullable
  • beds integer nullable
  • baths number nullable
  • sqft integer nullable
  • sqft_max integer nullable
  • price number nullable
  • price_max number nullable
  • image string nullable
  • available_unit_count integer nullable
  • units array (default: [])
    • @type string (default: "ApartmentlistUnit")
    • id integer nullable
    • name string nullable
    • price number nullable
    • price_max number nullable
    • base_price number nullable
    • total_price number nullable
    • required_fees number nullable
    • sqft integer nullable
    • lease_length integer nullable
    • availability string nullable
    • available_on string nullable
    • apply_url string nullable
    • unit_rental_id string nullable
• schools array (default: [])
  • @type string (default: "ApartmentlistSchool")
  • name string nullable
  • level string nullable
  • school_type string nullable
  • rating integer nullable
  • parents_rating number nullable
  • enrollment integer nullable
  • distance number nullable
  • url string nullable
  • latitude number nullable
  • longitude number nullable
• pois array (default: [])
  • @type string (default: "ApartmentlistPoi")
  • name string nullable
  • category string nullable
  • latitude number nullable
  • longitude number nullable
  • distance number nullable
• reviews array (default: [])
  • @type string (default: "ApartmentlistListingReview")
  • text string nullable
  • rating number nullable
  • review_type string nullable
  • created_at integer nullable
• similar_listings array (default: [])
  • @type string (default: "ApartmentlistSimilarListing")
  • id string required
  • url string nullable
  • alias string nullable
  • name string nullable
  • street_address string nullable
  • city string nullable
  • state string nullable
  • zip string nullable
  • lowest_price number nullable
  • available_unit_count integer nullable
  • image string nullable

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 — Listing not found (well-formed but nonexistent listing URL/slug) 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.