Apartments.com Property API
Returns one Apartments.com building in full: rent range, rent by bedroom count, current special, amenities, phone, photos, description and its rating.
GET /v1/apartments/propertyLast updated November 2026Maintained by the SocialCrawl team
When to use the Apartments.com Property API
Use it with a building's link when you need its full description, every photo and its rating.
From the API reference
Returns one Apartments.com building in full by its link. Each building is a Place: place.id is the Apartments.com listing id, place.name the building name, place.address the full address, with coordinates, photos, the phone number and the listing link; place.ext.listing carries the lowest monthly rent (status for_rent, home type apartment), and place.ext.apartments the highest rent, availability, the lowest rent for each bedroom count, the current special and the amenities. Beds and baths stay null on the listing because each floor plan differs. The record adds the full description, every photo and the star rating with its count (place.rating, place.reviews_count) where the listing shows one.
95 platforms behind one API
What can you do with the Property API?
The Property endpoint gives you structured Apartments.com data with computed fields in a single request. No scraping infrastructure to build or maintain.
Example Request
# GET /v1/apartments/property: 1 credit per call. Cache hits are free and failed calls are refunded.
# Check the price first for 0 credits: add dry_run=1 to the query. Nothing is fetched or charged.
# --max-time 60: the API's own time limit for this endpoint.
# --retry 3: retries timeouts, 429 and 5xx, honoring Retry-After.
# -o response.json keeps only the final attempt's body.
# One Idempotency-Key per request, reused on every retry, so a retried call is never charged twice.
IDEMPOTENCY_KEY=$(od -An -N16 -tx1 /dev/urandom | tr -d ' \n')
curl -sS --max-time 60 --retry 3 -o response.json \
-H "x-api-key: YOUR_API_KEY" \
-H "Idempotency-Key: $IDEMPOTENCY_KEY" \
"https://www.socialcrawl.dev/v1/apartments/property?url=https%3A%2F%2Fwww.apartments.com%2Floyola-junction-i-austin-tx%2F940ms65%2F" && cat response.json# GET /v1/apartments/property: 1 credit per call. Cache hits are free and failed calls are refunded.
# Check the price first for 0 credits: add dry_run=1 to the query. Nothing is fetched or charged.
import os
import random
import time
import uuid
import requests
API_KEY = os.environ.get("SOCIALCRAWL_API_KEY", "YOUR_API_KEY")
TIMEOUT_S = 60 # the API's own time limit for this endpoint.
MAX_RETRIES = 3
URL = "https://www.socialcrawl.dev/v1/apartments/property"
def backoff(attempt):
# Exponential backoff with jitter: about 1 s, 2 s, then 4 s.
return 2 ** attempt * (0.5 + random.random() / 2)
def socialcrawl(params):
# One Idempotency-Key per request, reused on every retry, so a retried call is never charged twice.
idempotency_key = str(uuid.uuid4())
for attempt in range(MAX_RETRIES + 1):
try:
res = requests.get(
URL,
params=params,
headers={"x-api-key": API_KEY, "Idempotency-Key": idempotency_key},
timeout=TIMEOUT_S,
)
body = res.json()
except (requests.RequestException, ValueError):
# A timeout, a dropped connection or a non-JSON gateway page: retry with the same key.
if attempt == MAX_RETRIES:
raise
time.sleep(backoff(attempt))
continue
if body["success"]:
return body
error = body["error"]
# Branch on error["type"], never on the message text.
if error["type"] == "RESOURCE_NOT_FOUND":
return None # refunded: nothing to read
retry_after = res.headers.get("Retry-After")
# SERVICE_UNAVAILABLE without Retry-After is a withdrawn endpoint: permanent.
permanent = error["type"] == "SERVICE_UNAVAILABLE" and retry_after is None
if not error.get("retryable") or permanent or attempt == MAX_RETRIES:
raise RuntimeError(f"{error['type']}: {error['message']} (request_id {body['request_id']})")
# Retry-After (seconds) wins; otherwise back off.
time.sleep(float(retry_after) if retry_after else backoff(attempt))
params = {
"url": "https://www.apartments.com/loyola-junction-i-austin-tx/940ms65/",
}
body = socialcrawl(params)
if body is not None:
print(body["data"])// GET /v1/apartments/property: 1 credit per call. Cache hits are free and failed calls are refunded.
// Check the price first for 0 credits: add dry_run=1 to the query. Nothing is fetched or charged.
const API_KEY = process.env.SOCIALCRAWL_API_KEY ?? "YOUR_API_KEY";
const TIMEOUT_MS = 60_000; // the API's own time limit for this endpoint.
const MAX_RETRIES = 3;
type Page = { next_cursor: string | null; has_more: boolean };
type SocialCrawlResponse =
| { success: true; data: any; pagination?: Page; credits_used: number; request_id: string }
| { success: false; error: { type: string; message: string; retryable: boolean }; request_id: string };
const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
// Exponential backoff with jitter: about 1 s, 2 s, then 4 s.
const backoffMs = (attempt: number) => 2 ** attempt * 1000 * (0.5 + Math.random() / 2);
async function socialcrawl(url: URL) {
// One Idempotency-Key per request, reused on every retry, so a retried call is never charged twice.
const idempotencyKey = crypto.randomUUID();
for (let attempt = 0; ; attempt++) {
let res: Response;
let body: SocialCrawlResponse;
try {
res = await fetch(url, {
headers: {
"x-api-key": API_KEY,
"Idempotency-Key": idempotencyKey,
},
signal: AbortSignal.timeout(TIMEOUT_MS),
});
body = (await res.json()) as SocialCrawlResponse;
} catch (error) {
// A timeout, a dropped connection or a non-JSON gateway page: retry with the same key.
if (attempt >= MAX_RETRIES) throw error;
await sleep(backoffMs(attempt));
continue;
}
if (body.success) return body;
// Branch on error.type, never on the message text.
if (body.error.type === "RESOURCE_NOT_FOUND") return null; // refunded: nothing to read
const retryAfter = res.headers.get("Retry-After");
// SERVICE_UNAVAILABLE without Retry-After is a withdrawn endpoint: permanent.
const permanent = body.error.type === "SERVICE_UNAVAILABLE" && retryAfter === null;
if (!body.error.retryable || permanent || attempt >= MAX_RETRIES) {
throw new Error(`${body.error.type}: ${body.error.message} (request_id ${body.request_id})`);
}
// Retry-After (seconds) wins; otherwise back off.
await sleep(retryAfter ? Number(retryAfter) * 1000 : backoffMs(attempt));
}
}
const url = new URL("https://www.socialcrawl.dev/v1/apartments/property");
url.searchParams.set("url", "https://www.apartments.com/loyola-junction-i-austin-tx/940ms65/");
const body = await socialcrawl(url);
if (body) console.log(body.data);Parameters
| Parameter | Required | Description |
|---|---|---|
| url | Yes | An Apartments.com building link ending in its listing id, for example https://www.apartments.com/loyola-junction-i-austin-tx/940ms65/. |
What does the Apartments.com Property API return?
Every response follows one unified schema. Here is a real, unmodified response body, so you can see the exact fields you get back before spending a credit.
Example response
{
"success": true,
"platform": "yelp",
"endpoint": "/v1/yelp/business/info",
"data": {
"place": {
"id": "zj8Lq1T8KIC5zwFief15jg",
"name": "Prince Street Pizza",
"url": "https://www.yelp.com/biz/prince-street-pizza-new-york-2",
"category": "Pizza",
"rating": {
"value": 4.3,
"max": 5
},
"reviews_count": 5716,
"price_level": "$",
"address": "27 Prince St\nNew York, NY 10012\nUnited States",
"phone": null,
"latitude": 40.7230777,
"longitude": -73.9945444,
"verified": null,
"description": null,
"image_urls": [
"https://s3-media0.fl.yelpcdn.com/bphoto/Jo9jBP5y6G_bG_g3H31fiw/ls.jpg",
"https://s3-media0.fl.yelpcdn.com/bphoto/Jo9jBP5y6G_bG_g3H31fiw/258s.jpg"
],
"categories": [
"Pizza"
],
"ext": {
"timezone": "America/New_York",
"hours": [
{
"date": null,
"day_name": "Sunday",
"is_open": true,
"opens_at": "10:00",
"closes_at": "03:00"
},
{
"date": null,
"day_name": "Monday",
"is_open": true,
"opens_at": "10:00",
"closes_at": "03:00"
}
]
}
}
},
"credits_used": 1,
"request_id": "req_example000000",
"cached": false,
"credits_remaining": 9999,
"redacted": true
}Example captured from the Yelp API. Every SocialCrawl endpoint returns this same unified schema, so your Apartments.com Property response has the same fields.
How does the Apartments.com Property API work?
Send a GET request with your API key and get back clean, structured JSON in our unified schema. Supported computed fields are populated when the source provides the required inputs.
Method
GET
Response
JSON
How do you scrape social media data in seconds?
The fastest social media scraping API for developers. Scrape profiles, posts, comments, and analytics from 95 platforms covering 10B+ monthly active users.
One schema, every platform
Query 95 platforms with identical response structures. Write your integration once.
Computed fields, not just scraped
When an endpoint supports these metrics and the source provides the required inputs, the normalized record includes engagement_rate, estimated_reach, content_category, and language. Ready to use.
See your data before you code
Visual Data Explorer. Paste any URL, get rich result cards, sortable tables, CSV export.
import requests
response = requests.get(
'https://www.socialcrawl.dev/v1/tiktok/profile',
params={'handle': 'charlidamelio'},
headers={'x-api-key': 'sc_YOUR_API_KEY'}
)
data = response.json(){
"success": true,
"platform": "tiktok",
"data": {
"author": {
"username": "charlidamelio",
"followers": 152400000
},
"engagement": {
"likes": 12400000000,
"engagement_rate": 0.087
},
"metadata": {
"language": "en",
"content_category": "lifestyle"
}
}
}Have a question? We got answers
Find answers to frequently asked questions about SocialCrawl's API, pricing, and capabilities.
Contact usHow do I read one Apartments.com building with an API?
What does the building record add over a search row?
Does it return the rent for each floor plan?
What happens with a link that is not a building?
How much does the Apartments.com Property API cost?
Ask AI about SocialCrawl
Ready to scrape Apartments.com Property data?
Get your API key and start pulling Apartments.com data in under 60 seconds.
