curl --request GET \
--url https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/{comp_set_id}/floor_plans \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/{comp_set_id}/floor_plans"
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/v1/comp_sets/{comp_set_id}/floor_plans', 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/v1/comp_sets/{comp_set_id}/floor_plans",
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/v1/comp_sets/{comp_set_id}/floor_plans"
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/v1/comp_sets/{comp_set_id}/floor_plans")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/{comp_set_id}/floor_plans")
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{
"data": {
"id": "11848667",
"type": "floorplan",
"attributes": {
"floor_plans_by_bed_bath": [
{
"bedroom_count": 1,
"bathroom_count": 1,
"floor_plan_summary": {
"asking_rent": 1841.3333,
"asking_rent_change": -28.5,
"asking_rent_change_percent": -1.5,
"asking_rent_over_time": [
{
"collected_at": "2024-09-10T23:59:59.999Z",
"value": 1841.3333
}
],
"asking_rent_per_sq_ft": 1.83,
"bathroom_count": 1,
"bedroom_count": 1,
"days_on_market": 81,
"name": "A3 - Clearwater",
"net_effective_rent": 1841.3333,
"net_effective_rent_change": -28.5,
"net_effective_rent_change_percent": -1.5,
"net_effective_rent_over_time": [
{
"collected_at": "2024-09-10T23:59:59.999Z",
"value": 1841.3333
}
],
"net_effective_rent_per_sq_ft": 1.83,
"all_in_rent": 1975,
"all_in_rent_per_sqft": 2.1,
"all_in_ner": 1925,
"all_in_ner_per_sqft": 2.05,
"property_id": 99030676,
"property_name": "Cortland Bowery",
"sqft": 785.9565217391304,
"subject_property": true,
"unit_count": 35,
"unit_mix_est": 260,
"unit_mix_percent": 0.1
},
"floor_plans": [
{
"asking_rent": 1841.3333,
"asking_rent_change": -28.5,
"asking_rent_change_percent": -1.5,
"asking_rent_over_time": [
{
"collected_at": "2024-09-10T23:59:59.999Z",
"value": 1841.3333
}
],
"asking_rent_per_sq_ft": 1.83,
"bathroom_count": 1,
"bedroom_count": 1,
"days_on_market": 81,
"name": "A3 - Clearwater",
"net_effective_rent": 1841.3333,
"net_effective_rent_change": -28.5,
"net_effective_rent_change_percent": -1.5,
"net_effective_rent_over_time": [
{
"collected_at": "2024-09-10T23:59:59.999Z",
"value": 1841.3333
}
],
"net_effective_rent_per_sq_ft": 1.83,
"all_in_rent": 1975,
"all_in_rent_per_sqft": 2.1,
"all_in_ner": 1925,
"all_in_ner_per_sqft": 2.05,
"property_id": 99030676,
"property_name": "Cortland Bowery",
"sqft": 785.9565217391304,
"subject_property": true,
"unit_count": 35,
"unit_mix_est": 260,
"unit_mix_percent": 0.1
}
]
}
]
}
}
}{
"error": "Invalid parameter",
"message": "account_id is required",
"errors": [
"<string>"
],
"quota_limit": 123,
"quota_usage": 123
}{
"error": "Invalid parameter",
"message": "account_id is required",
"errors": [
"<string>"
],
"quota_limit": 123,
"quota_usage": 123
}{
"error": "Lease term filtering is not available for this account."
}You have exceeded the rate limit for this API.
List Floorplans
Retrieves a list of floorplans for a comp set.
With filter[lease_term_ids], a floorplan whose units offer none of the selected terms reports asking_rent and net_effective_rent as null.
curl --request GET \
--url https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/{comp_set_id}/floor_plans \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/{comp_set_id}/floor_plans"
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/v1/comp_sets/{comp_set_id}/floor_plans', 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/v1/comp_sets/{comp_set_id}/floor_plans",
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/v1/comp_sets/{comp_set_id}/floor_plans"
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/v1/comp_sets/{comp_set_id}/floor_plans")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/{comp_set_id}/floor_plans")
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{
"data": {
"id": "11848667",
"type": "floorplan",
"attributes": {
"floor_plans_by_bed_bath": [
{
"bedroom_count": 1,
"bathroom_count": 1,
"floor_plan_summary": {
"asking_rent": 1841.3333,
"asking_rent_change": -28.5,
"asking_rent_change_percent": -1.5,
"asking_rent_over_time": [
{
"collected_at": "2024-09-10T23:59:59.999Z",
"value": 1841.3333
}
],
"asking_rent_per_sq_ft": 1.83,
"bathroom_count": 1,
"bedroom_count": 1,
"days_on_market": 81,
"name": "A3 - Clearwater",
"net_effective_rent": 1841.3333,
"net_effective_rent_change": -28.5,
"net_effective_rent_change_percent": -1.5,
"net_effective_rent_over_time": [
{
"collected_at": "2024-09-10T23:59:59.999Z",
"value": 1841.3333
}
],
"net_effective_rent_per_sq_ft": 1.83,
"all_in_rent": 1975,
"all_in_rent_per_sqft": 2.1,
"all_in_ner": 1925,
"all_in_ner_per_sqft": 2.05,
"property_id": 99030676,
"property_name": "Cortland Bowery",
"sqft": 785.9565217391304,
"subject_property": true,
"unit_count": 35,
"unit_mix_est": 260,
"unit_mix_percent": 0.1
},
"floor_plans": [
{
"asking_rent": 1841.3333,
"asking_rent_change": -28.5,
"asking_rent_change_percent": -1.5,
"asking_rent_over_time": [
{
"collected_at": "2024-09-10T23:59:59.999Z",
"value": 1841.3333
}
],
"asking_rent_per_sq_ft": 1.83,
"bathroom_count": 1,
"bedroom_count": 1,
"days_on_market": 81,
"name": "A3 - Clearwater",
"net_effective_rent": 1841.3333,
"net_effective_rent_change": -28.5,
"net_effective_rent_change_percent": -1.5,
"net_effective_rent_over_time": [
{
"collected_at": "2024-09-10T23:59:59.999Z",
"value": 1841.3333
}
],
"net_effective_rent_per_sq_ft": 1.83,
"all_in_rent": 1975,
"all_in_rent_per_sqft": 2.1,
"all_in_ner": 1925,
"all_in_ner_per_sqft": 2.05,
"property_id": 99030676,
"property_name": "Cortland Bowery",
"sqft": 785.9565217391304,
"subject_property": true,
"unit_count": 35,
"unit_mix_est": 260,
"unit_mix_percent": 0.1
}
]
}
]
}
}
}{
"error": "Invalid parameter",
"message": "account_id is required",
"errors": [
"<string>"
],
"quota_limit": 123,
"quota_usage": 123
}{
"error": "Invalid parameter",
"message": "account_id is required",
"errors": [
"<string>"
],
"quota_limit": 123,
"quota_usage": 123
}{
"error": "Lease term filtering is not available for this account."
}You have exceeded the rate limit for this API.
Authorizations
Query Parameters
Filter the data by the earliest date it was collected, in ISO 8601 format. Collection date is when the data was gathered, not when a unit becomes available — for that, use filter[date_available_gte]. Dates later than the most recent available collection day are clamped to that day. Omit both collection filters to get the most recent available collection day on its own.
Filter the data by the latest date it was collected, in ISO 8601 format. Collection date is when the data was gathered, not when a unit becomes available — for that, use filter[date_available_lte]. Omit both collection filters to get the most recent available collection day on its own.
Filter the data by a comma-separated list of lease lengths in months, such as 6,12. Rent and NER average across the selected terms that each unit offers. Units that offer none of the selected terms stay in the data with blank rent values; the endpoint description says which values. Requires lease terms on the comp set's account; otherwise the request returns 403. An empty value counts as no filter.
Response
A Map with a data attribute that contains an array of floorplans for the comp set.