curl --request POST \
--url https://api.anysite.io/api/apartmentlist/listings \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"listing": "<string>",
"timeout": 300
}
'import requests
url = "https://api.anysite.io/api/apartmentlist/listings"
payload = {
"listing": "<string>",
"timeout": 300
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({listing: '<string>', timeout: 300})
};
fetch('https://api.anysite.io/api/apartmentlist/listings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/apartmentlist/listings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'listing' => '<string>',
'timeout' => 300
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/apartmentlist/listings"
payload := strings.NewReader("{\n \"listing\": \"<string>\",\n \"timeout\": 300\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/apartmentlist/listings")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listing\": \"<string>\",\n \"timeout\": 300\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/apartmentlist/listings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listing\": \"<string>\",\n \"timeout\": 300\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"url": "<string>",
"@type": "ApartmentlistListing",
"alias": "<string>",
"name": "<string>",
"highlight": "<string>",
"formatted_address": "<string>",
"street_address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"county": "<string>",
"neighborhood": "<string>",
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"management_company": "<string>",
"source_name": "<string>",
"occupancy_types": [],
"show_price": true,
"has_unit_level_availability": true,
"tour_booking_allowed": true,
"updated_at": 123,
"availability_checked_at": 123,
"image": "<string>",
"images": [],
"virtual_tours": [],
"community_amenities": [],
"unit_amenities": [],
"specials": [],
"application_fee": "<string>",
"additional_fees": "<string>",
"deposit_fee": "<string>",
"move_in_fees": "<string>",
"lease_terms": "<string>",
"utilities_included": "<string>",
"income_requirement": "<string>",
"income_multiplier": 123,
"walk_score": {
"@type": "ApartmentlistScore",
"score": 123,
"summary": "<string>",
"link": "<string>"
},
"transit_score": {
"@type": "ApartmentlistScore",
"score": 123,
"summary": "<string>",
"link": "<string>"
},
"top_amenities": [],
"parking": [],
"office_hours": [],
"pet_policy": {
"@type": "ApartmentlistPetPolicy",
"allowed": true,
"allowed_pets": [],
"deposit": "<string>",
"rent": "<string>",
"fee": "<string>",
"restrictions": "<string>"
},
"average_rent": {
"@type": "ApartmentlistAverageRent",
"price_studio": 123,
"price_1br": 123,
"price_2br": 123,
"price_3br": 123,
"trend": "<string>",
"pricing_date": "<string>"
},
"floor_plans": [],
"schools": [],
"pois": [],
"reviews": [],
"similar_listings": []
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/apartmentlist/listings
Get full Apartment List rental listing details by listing URL (or /// 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.
Price: 10 credits
⚠️ Common errors: 412: Listing not found (well-formed but nonexistent listing URL/slug)
curl --request POST \
--url https://api.anysite.io/api/apartmentlist/listings \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"listing": "<string>",
"timeout": 300
}
'import requests
url = "https://api.anysite.io/api/apartmentlist/listings"
payload = {
"listing": "<string>",
"timeout": 300
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({listing: '<string>', timeout: 300})
};
fetch('https://api.anysite.io/api/apartmentlist/listings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/apartmentlist/listings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'listing' => '<string>',
'timeout' => 300
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/apartmentlist/listings"
payload := strings.NewReader("{\n \"listing\": \"<string>\",\n \"timeout\": 300\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/apartmentlist/listings")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listing\": \"<string>\",\n \"timeout\": 300\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/apartmentlist/listings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listing\": \"<string>\",\n \"timeout\": 300\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"url": "<string>",
"@type": "ApartmentlistListing",
"alias": "<string>",
"name": "<string>",
"highlight": "<string>",
"formatted_address": "<string>",
"street_address": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"county": "<string>",
"neighborhood": "<string>",
"latitude": 123,
"longitude": 123,
"phone": "<string>",
"management_company": "<string>",
"source_name": "<string>",
"occupancy_types": [],
"show_price": true,
"has_unit_level_availability": true,
"tour_booking_allowed": true,
"updated_at": 123,
"availability_checked_at": 123,
"image": "<string>",
"images": [],
"virtual_tours": [],
"community_amenities": [],
"unit_amenities": [],
"specials": [],
"application_fee": "<string>",
"additional_fees": "<string>",
"deposit_fee": "<string>",
"move_in_fees": "<string>",
"lease_terms": "<string>",
"utilities_included": "<string>",
"income_requirement": "<string>",
"income_multiplier": 123,
"walk_score": {
"@type": "ApartmentlistScore",
"score": 123,
"summary": "<string>",
"link": "<string>"
},
"transit_score": {
"@type": "ApartmentlistScore",
"score": 123,
"summary": "<string>",
"link": "<string>"
},
"top_amenities": [],
"parking": [],
"office_hours": [],
"pet_policy": {
"@type": "ApartmentlistPetPolicy",
"allowed": true,
"allowed_pets": [],
"deposit": "<string>",
"rent": "<string>",
"fee": "<string>",
"restrictions": "<string>"
},
"average_rent": {
"@type": "ApartmentlistAverageRent",
"price_studio": 123,
"price_1br": 123,
"price_2br": 123,
"price_3br": 123,
"trend": "<string>",
"pricing_date": "<string>"
},
"floor_plans": [],
"schools": [],
"pois": [],
"reviews": [],
"similar_listings": []
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API token from the dashboard
Headers
Body
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes