Scrappa's GET /api/apartmentlist/listing returns the full record of one Apartment List property. Send slug or rental_id from search, exactly one of them.
What you get
Name, address parts, geo, phone, website_url, the written description, fees (deposit, application, additional and move-in costs as text), pet_policy for cats and dogs, specials, income_requirement, lease_terms, parking, storage, utilities_included, year_built, year_remodeled, total_units, virtual_tours, amenity lists, photos, every floorplan with its available units and prices, and faq.
Property manager
There is no agent or agency profile page on Apartment List. The management company and the agent fields are returned in manager (management_company, listing_agent, brokerage, office_name, office_phone, agent_name, contact_name). Fields the property does not publish are null.
Prices and fees
Money text is cleaned ($50, not $$50). A price the property hides is null, never 0. Unit price, base_price and total_price are numbers in US dollars.
Slug or rental id
A slug (/tx/austin/polaris-on-the-park) costs one lookup. A rental_id (p191304) costs two, because it is resolved to a slug first. A property that does not exist returns 404.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
2 optional filters available.
string
Optional
Listing slug from search, for example /tx/austin/polaris-on-the-park. Send this or rental_id.
/tx/austin/polaris-on-the-park
string
Optional
Rental id from search, for example p191304. Send this or slug.
1234567890
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: YOUR_API_KEY_HERE"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
<?php
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park', options)
.then(response => {
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
return response.text();
})
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park',
headers: {
x-api-key: 'YOUR_API_KEY_HERE',
}
};
try {
const response = await axios(options);
console.log(response.data);
} catch (error) {
console.error('Error:', error.message);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'
begin
response = http.request(request)
puts response.body
rescue => e
puts "Error: #{e.message}"
end
import http.client
import json
conn = http.client.HTTPSConnection("scrappa.co")
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
conn.request("GET", "/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
public class ApiExample {
public static void main(String[] args) {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park")
.addHeader("x-api-key", "YOUR_API_KEY_HERE")
.build();
try (Response response = client.newCall(request).execute()) {
if (response.isSuccessful()) {
System.out.println(response.body().string());
} else {
System.out.println("Error: " + response.code());
}
} catch (IOException e) {
System.out.println("Error: " + e.getMessage());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park", nil)
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error making request:", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error reading response:", err)
return
}
fmt.Println(string(body))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park"
using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");
try
{
var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
use reqwest::Client;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::new();
let response = client
.get("https://scrappa.co/api/apartmentlist/listing?slug=%2Ftx%2Faustin%2Fpolaris-on-the-park")
.header("x-api-key", "YOUR_API_KEY_HERE")
.send()
.await?;
println!("{}", response.text().await?);
Ok(())
}
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
success
listing
meta
{
"success": true,
"listing": {
"rental_id": "p191304",
"slug": "/tx/austin/polaris-on-the-park",
"url": "https://www.apartmentlist.com/tx/austin/polaris-on-the-park",
"name": "Polaris on the Park",
"rental_type": "apartment",
"address": {
"formatted": "1720 Woodward Street, Austin, TX 78741",
"street": "1720 Woodward Street",
"cross_street": null,
"neighborhood": "Parker Lane",
"city": "Austin",
"county": "Austin",
"state": "TX",
"zip": "78741"
},
"geo": {
"lat": 30.219922,
"lon": -97.743986
},
"phone": "(555) 010-0100",
"website_url": "http://www.polarisonthepark.com/",
"description": "Discover the charm of Polaris on the Park where your pets are as welcome as you are.",
"fees": {
"deposit": "250.00",
"application": "$50",
"additional": null,
"move_in": null
},
"pet_policy": {
"allowed": true,
"allowed_pets": [
"cats",
"dogs"
],
"details": null,
"cats": {
"deposit": "$300",
"rent": "$10",
"fee": "$300",
"limit": null,
"restrictions": null
},
"dogs": {
"deposit": "$300",
"rent": "$10 per pet",
"fee": "$300",
"limit": null,
"restrictions": null
},
"general": null
},
"specials": [],
"income_requirement": {
"text": "Must have 3x the rent in total household income (before taxes)",
"multiplier": 3
},
"lease_terms": "6, 12 months",
"parking": {
"details": "Open lot: included in lease",
"options": [
{
"comment": "Off-street parking;Parking Lot",
"spaces": null,
"space_fee": null
}
]
},
"storage": "Storage: $40-$50/month",
"year_built": 1969,
"year_remodeled": 2015,
"total_units": 242,
"bed_range": [
1,
2,
3
],
"price_range": {
"lowest": 899,
"highest": 1499,
"by_bed_count": {
"1": {
"min": 899,
"max": 899
}
}
},
"units_available": 35,
"floorplans": [
{
"floorplan_id": 8983421,
"name": "2 Bedroom",
"bed": 2,
"bath": 1.5,
"sqft": 904,
"sqft_max": 904,
"price": 1049,
"units": []
}
],
"photos": [
"https://cdn.apartmentlist.com/image/upload/c_fill,dpr_auto,f_auto,g_center,h_415,q_auto,w_640/4d2d7bc54a662f16cebd8dac28ade93c.jpg"
],
"manager": {
"management_company": "Urban Flats Multifamily Real Estate",
"listing_agent": null,
"brokerage": null,
"office_name": null,
"office_phone": null,
"agent_name": null,
"contact_name": null,
"source_name": "show_me_the_rent"
},
"faq": [
{
"question": "Does Polaris on the Park allow pets?",
"answer": "Yes, cats and dogs are allowed."
}
]
},
"meta": {
"endpoint_family": "listing",
"billable": true,
"attempts": 1
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
No property exists with that slug or rental id (`not_found`). Non-billable.
{
"meta": {
"attempts": 1,
"billable": false,
"retryable": false,
"endpoint_family": "listing"
},
"error": {
"code": "not_found",
"message": "No Apartment List record exists with that identifier."
},
"success": false
}Validation Error
A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored (`request_rejected` is the same failure raised by the source). Non-billable.
{
"errors": {
"sort": [
"The selected sort is invalid."
]
},
"message": "The selected sort is invalid."
}Source Unavailable
Apartment List could not be reached in time, answered with an error, or its page layout changed (`upstream_unavailable`, `upstream_blocked`, `deadline_exhausted`, `parser_drift`). Retryable and never billed. Clients are never rate limited.
{
"meta": {
"attempts": 6,
"billable": false,
"retryable": true,
"endpoint_family": "listing"
},
"error": {
"code": "upstream_unavailable",
"message": "Apartment List is temporarily unavailable. Please retry."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.