curl --request GET \
--url https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/{comp_set_id}/floor_plans \
--header 'Authorization: Bearer <token>'{
"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,
"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,
"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
}
]
}
]
}
}
}List Floorplans
Retrieves a list of floorplans for a comp set.
curl --request GET \
--url https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/{comp_set_id}/floor_plans \
--header 'Authorization: Bearer <token>'{
"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,
"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,
"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
}
]
}
]
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the comp set to get data for.
Query Parameters
Filter the data by a comma-separated list of bedroom counts.
Filter the data by a comma-separated list of bathroom counts.
Filter the data by a comma-separated list of property IDs.
Filter the data by minimum unit size, in square feet.
Filter the data by maximum unit size, in square feet.
Filter the data by minimum rent, in dollars.
Filter the data by maximum rent, in dollars.
Filter the data by minimum date available, in ISO 8601 format.
Filter the data by maximum date available, in ISO 8601 format.
Filter the data by minimum year built.
Filter the data by maximum year built.
Filter the data by a comma-separated list of unit styles, where unit styles are affordable, standard, penthouse, or renovated.
Optional aggregation type to apply to the floor plan results (for example, averaging across units). If omitted, the service default is used.
Response
A Map with a data attribute that contains an array of floorplans for the comp set.
Show child attributes
Show child attributes
ID of the comp set.
11848667
Type of data returned in the response.
"floorplan"
- Option 1
- Option 2
Show child attributes
Show child attributes
List of floorplans by bedroom and bathroom count.
Show child attributes
Show child attributes
Number of bedrooms in the floorplan.
1
Number of bathrooms in the floorplan.
1
Summary of the floorplan.
Show child attributes
Show child attributes
Asking rent of the floorplan.
1841.3333
Asking rent change of the floorplan.
-28.5
Percent change in asking rent of the floorplan.
-1.5
List of asking rents over time for the floorplan.
Show child attributes
Show child attributes
Date the asking rent was collected, in ISO 8601 format.
"2024-09-10T23:59:59.999Z"
Asking rent of the floorplan at the time the data was collected.
1841.3333
Asking rent per square foot of the floorplan.
1.83
Number of bathrooms in the floorplan.
1
Number of bedrooms in the floorplan.
1
Number of days the floorplan has been on the market since it started being advertised.
81
Name of the floorplan.
"A3 - Clearwater"
Net effective rent of the floorplan.
1841.3333
Net effective rent change of the floorplan.
-28.5
Percent change in net effective rent of the floorplan.
-1.5
List of net effective rents over time for the floorplan.
Show child attributes
Show child attributes
Date the net effective rent was collected, in ISO 8601 format.
"2024-09-10T23:59:59.999Z"
Net effective rent of the floorplan at the time the data was collected.
1841.3333
Net effective rent per square foot of the floorplan.
1.83
ID of the property the floorplan belongs to.
99030676
Name of the property the floorplan belongs to.
"Cortland Bowery"
Square footage of the floorplan.
785.9565217391304
Whether the property is the subject property of this comp set.
true
Number of available units in the floorplan.
35
Estimated total number of units of the floorplan.
260
Percent of the property's units that are of the floorplan.
0.1
List of floorplans for the bedroom and bathroom count by property.
Show child attributes
Show child attributes
Asking rent of the floorplan.
1841.3333
Asking rent change of the floorplan.
-28.5
Percent change in asking rent of the floorplan.
-1.5
List of asking rents over time for the floorplan.
Show child attributes
Show child attributes
Date the asking rent was collected, in ISO 8601 format.
"2024-09-10T23:59:59.999Z"
Asking rent of the floorplan at the time the data was collected.
1841.3333
Asking rent per square foot of the floorplan.
1.83
Number of bathrooms in the floorplan.
1
Number of bedrooms in the floorplan.
1
Number of days the floorplan has been on the market since it started being advertised.
81
Name of the floorplan.
"A3 - Clearwater"
Net effective rent of the floorplan.
1841.3333
Net effective rent change of the floorplan.
-28.5
Percent change in net effective rent of the floorplan.
-1.5
List of net effective rents over time for the floorplan.
Show child attributes
Show child attributes
Date the net effective rent was collected, in ISO 8601 format.
"2024-09-10T23:59:59.999Z"
Net effective rent of the floorplan at the time the data was collected.
1841.3333
Net effective rent per square foot of the floorplan.
1.83
ID of the property the floorplan belongs to.
99030676
Name of the property the floorplan belongs to.
"Cortland Bowery"
Square footage of the floorplan.
785.9565217391304
Whether the property is the subject property of this comp set.
true
Number of available units in the floorplan.
35
Estimated total number of units of the floorplan.
260
Percent of the property's units that are of the floorplan.
0.1