/apartments/listings
curl --request POST \
--url https://api.anysite.io/api/apartments/listings \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"listing": "<string>",
"timeout": 300
}
'import requests
url = "https://api.anysite.io/api/apartments/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/apartments/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/apartments/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/apartments/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/apartments/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/apartments/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": "ApartmentsListing",
"name": "<string>",
"phone": "<string>",
"address": {
"@type": "ApartmentsAddress",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"geo": {
"@type": "ApartmentsGeo",
"latitude": 123,
"longitude": 123
},
"rent_low": 123,
"rent_high": 123,
"currency": "<string>",
"availability": "<string>",
"pets_allowed": true,
"year_built": 123,
"unit_count": 123,
"rating": 123,
"rating_count": 123,
"blended_rating": 123,
"community_rating": 123,
"image": "<string>",
"images": [],
"community_amenities": [],
"apartment_amenities": [],
"floor_plans": [],
"reviews": [],
"scores": {},
"lease_options": []
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/apartments
/apartments/listings
Get full Apartments.com rental listing details by shortcode (or listing URL): name, description, address, geo, rent range, floor plans (beds/baths/sqft/rent), amenities, photos, ratings, pet policy, year built, unit count and lease options.
Price: 10 credits
⚠️ Common errors: 412: Listing not found (well-formed but nonexistent shortcode)
POST
/
api
/
apartments
/
listings
/apartments/listings
curl --request POST \
--url https://api.anysite.io/api/apartments/listings \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"listing": "<string>",
"timeout": 300
}
'import requests
url = "https://api.anysite.io/api/apartments/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/apartments/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/apartments/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/apartments/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/apartments/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/apartments/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": "ApartmentsListing",
"name": "<string>",
"phone": "<string>",
"address": {
"@type": "ApartmentsAddress",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"geo": {
"@type": "ApartmentsGeo",
"latitude": 123,
"longitude": 123
},
"rent_low": 123,
"rent_high": 123,
"currency": "<string>",
"availability": "<string>",
"pets_allowed": true,
"year_built": 123,
"unit_count": 123,
"rating": 123,
"rating_count": 123,
"blended_rating": 123,
"community_rating": 123,
"image": "<string>",
"images": [],
"community_amenities": [],
"apartment_amenities": [],
"floor_plans": [],
"reviews": [],
"scores": {},
"lease_options": []
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API token from the dashboard
Headers
Body
application/json
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