Skip to main content
GET
/
comp_sets
/
{comp_set_id}
/
floor_plans
List Floorplans
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

​
Authorization
string
header
required

Enter a Bearer token obtained via the OAuth client credentials flow or from the Access Tokens tab in your account settings.

Path Parameters

​
comp_set_id
string
required

ID of the comp set to get data for.

Query Parameters

​
filter[bedroom_count]
string

Filter the data by a comma-separated list of bedroom counts.

​
filter[bathroom_count]
string

Filter the data by a comma-separated list of bathroom counts.

​
filter[iq_property_ids]
string

Filter the data by a comma-separated list of property IDs.

​
filter[size_gte]
integer

Filter the data by minimum unit size, in square feet.

​
filter[size_lte]
integer

Filter the data by maximum unit size, in square feet.

​
filter[rent_gte]
integer

Filter the data by minimum rent, in dollars.

​
filter[rent_lte]
integer

Filter the data by maximum rent, in dollars.

​
filter[date_available_gte]
string<date>

Filter the data by minimum date available, in ISO 8601 format.

​
filter[date_available_lte]
string<date>

Filter the data by maximum date available, in ISO 8601 format.

​
filter[year_built_gte]
integer

Filter the data by minimum year built.

​
filter[year_built_lte]
integer

Filter the data by maximum year built.

​
filter[unit_style]
string

Filter the data by a comma-separated list of unit styles, where unit styles are affordable, standard, penthouse, or renovated.

​
filter[aggregation_type]
string

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.

​
data
object