/apartmentlist/locations
curl --request POST \
--url https://api.anysite.io/api/apartmentlist/locations \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"location_id": 123,
"timeout": 300,
"location_name": ""
}
'import requests
url = "https://api.anysite.io/api/apartmentlist/locations"
payload = {
"location_id": 123,
"timeout": 300,
"location_name": ""
}
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({location_id: 123, timeout: 300, location_name: ''})
};
fetch('https://api.anysite.io/api/apartmentlist/locations', 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/locations",
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([
'location_id' => 123,
'timeout' => 300,
'location_name' => ''
]),
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/locations"
payload := strings.NewReader("{\n \"location_id\": 123,\n \"timeout\": 300,\n \"location_name\": \"\"\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/locations")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"location_id\": 123,\n \"timeout\": 300,\n \"location_name\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/apartmentlist/locations")
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 \"location_id\": 123,\n \"timeout\": 300,\n \"location_name\": \"\"\n}"
response = http.request(request)
puts response.read_body[
{
"@type": "ApartmentlistLocationSummary",
"location_id": 123,
"location_name": "<string>",
"average_rent": {
"@type": "ApartmentlistAverageRent",
"price_studio": 123,
"price_1br": 123,
"price_2br": 123,
"price_3br": 123,
"trend": "<string>",
"pricing_date": "<string>"
},
"avg_price": 123,
"avg_sqft": 123,
"median_price": 123,
"median_sqft": 123,
"property_count": 123,
"unit_count": 123,
"amenity_percentages": {}
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/apartmentlist
/apartmentlist/locations
Get Apartment List market rent summary for a location by numeric location id: average rent by bedroom type with month-over-month trend, average and median price and square footage, total property/unit counts, and the share of listings offering each amenity.
Price: 1 credit
⚠️ Common errors: 412: Location not found (unknown location id)
POST
/
api
/
apartmentlist
/
locations
/apartmentlist/locations
curl --request POST \
--url https://api.anysite.io/api/apartmentlist/locations \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"location_id": 123,
"timeout": 300,
"location_name": ""
}
'import requests
url = "https://api.anysite.io/api/apartmentlist/locations"
payload = {
"location_id": 123,
"timeout": 300,
"location_name": ""
}
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({location_id: 123, timeout: 300, location_name: ''})
};
fetch('https://api.anysite.io/api/apartmentlist/locations', 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/locations",
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([
'location_id' => 123,
'timeout' => 300,
'location_name' => ''
]),
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/locations"
payload := strings.NewReader("{\n \"location_id\": 123,\n \"timeout\": 300,\n \"location_name\": \"\"\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/locations")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"location_id\": 123,\n \"timeout\": 300,\n \"location_name\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/apartmentlist/locations")
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 \"location_id\": 123,\n \"timeout\": 300,\n \"location_name\": \"\"\n}"
response = http.request(request)
puts response.read_body[
{
"@type": "ApartmentlistLocationSummary",
"location_id": 123,
"location_name": "<string>",
"average_rent": {
"@type": "ApartmentlistAverageRent",
"price_studio": 123,
"price_1br": 123,
"price_2br": 123,
"price_3br": 123,
"trend": "<string>",
"pricing_date": "<string>"
},
"avg_price": 123,
"avg_sqft": 123,
"median_price": 123,
"median_sqft": 123,
"property_count": 123,
"unit_count": 123,
"amenity_percentages": {}
}
]{
"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
⌘I