Suggest Comps
curl --request GET \
--url https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions', 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://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"subject_property_id": 781245,
"suggestions": [
{
"property_id": 781266,
"rank": 1,
"score": 0.82,
"property_name": "Marina Heights",
"address": "88 Lakeview Ave, Austin, TX 78703",
"distance_miles": 1.42,
"year_built": 2012,
"unit_count": 196,
"number_of_stories": 4,
"property_type": "conventional",
"property_class": "B",
"lease_up": false,
"in_comp_set": true
},
{
"property_id": 781390,
"rank": 2,
"score": 0.77,
"property_name": "The Foundry",
"address": "1200 E 6th St, Austin, TX 78702",
"distance_miles": 2.08,
"year_built": 2024,
"unit_count": 310,
"number_of_stories": 6,
"property_type": "conventional",
"property_class": "A",
"lease_up": true,
"in_comp_set": false
}
]
}Market Surveys
Suggest Comps
Rank comp candidates for a subject property, scored the way ApartmentIQ scores comps when it suggests them for a comp set, without value-add.
- Candidates come from the 1,500 properties with the most units within 25 miles that are active or have floorplan-only data. Properties with known occupancy data issues are removed after that cap, so the pool can be smaller.
- For a subject that is not conventional, candidates must have exactly the same property type. For a conventional subject, candidates of every type are included and the score decides: under comp scoring V1 a different type scores 0, and under V2 only senior living candidates are removed.
- Filters run on that pool after the 1,500 cap. In a dense market, a narrow filter can return few or no suggestions even when matching properties exist nearby. Range and class filters drop candidates whose value is unknown.
- At most half of
limit, rounded down, can be lease-ups, solimit=1never returns a lease-up. When the subject is leasing up, lease-ups come first. - Scores run from 0 to 1 under both comp scoring versions, but they mean different things, so compare scores only within one account.
- With the default
minimum_scoreof 0.5, a request can return fewer thanlimitsuggestions. Under V2, 0.5 is a strict cutoff. Lowerminimum_scorefor a longer list. Under V2, deactivated candidates score 0, and a deactivated subject gets no suggestions. - With
comp_set_id, suggestions that are comps in that comp set havein_comp_set: trueand count towardlimit. A comp in the set appears only if it passes every rule above. The comp set’s exclusions are not applied.
This request scores candidates live, so it can take several seconds in dense markets.
GET
/
properties
/
{property_id}
/
comp_suggestions
Suggest Comps
curl --request GET \
--url https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions', 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://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.apartmentiq.io/apartmentiq/api/v2/properties/{property_id}/comp_suggestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"subject_property_id": 781245,
"suggestions": [
{
"property_id": 781266,
"rank": 1,
"score": 0.82,
"property_name": "Marina Heights",
"address": "88 Lakeview Ave, Austin, TX 78703",
"distance_miles": 1.42,
"year_built": 2012,
"unit_count": 196,
"number_of_stories": 4,
"property_type": "conventional",
"property_class": "B",
"lease_up": false,
"in_comp_set": true
},
{
"property_id": 781390,
"rank": 2,
"score": 0.77,
"property_name": "The Foundry",
"address": "1200 E 6th St, Austin, TX 78702",
"distance_miles": 2.08,
"year_built": 2024,
"unit_count": 310,
"number_of_stories": 6,
"property_type": "conventional",
"property_class": "A",
"lease_up": true,
"in_comp_set": false
}
]
}