Skip to main content
GET
/
comp_sets
/
{comp_set_id}
/
units
List Units In Competitive Set
curl --request GET \
  --url https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/{comp_set_id}/units \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "99030676_021621",
      "type": "unit",
      "attributes": {
        "property_id": 99030676,
        "subject_property": true,
        "property_name": "Cortland Bowery",
        "is_leased": false,
        "year_built": 1987,
        "unit_name": "#02 - 1621",
        "days_on_market": 81,
        "date_available": "2024-02-13",
        "bedroom_count": 1,
        "bathroom_count": 1,
        "min_rent": 1841,
        "sq_ft": 757,
        "floorplan_name": "A3 - Clearwater",
        "avg_rent_per_sq_ft": 2.4319682959048876,
        "last_rent_change_date": "2024-02-07",
        "last_rent_change": "$10",
        "total_30_day_rent_change": "$55",
        "rent_changes_last_30_days": 10,
        "is_trucomp": false,
        "date_leased": "2024-02-01T12:00:00Z",
        "trucomp_rent_differential": 0.021040974529346623,
        "trucomp_sq_ft_differential": -0.04634522236900049,
        "trucomp_rent_per_sq_ft_differential": 0.07066099649366094,
        "concessions": {
          "id": 299639,
          "property_id": 99030676,
          "expires_at": "2024-02-29T23:59:59.999Z",
          "updated_at": "2024-02-13T10:15:26.403Z",
          "updated_at_formatted": "8 hours ago",
          "display_text": "up to 6 weeks in free rent\nRestrictions: Move in by February 29, 2024, 13 month lease, Must be a new applicant",
          "rent_concessions": [
            {
              "display_text": "Up to 6 Weeks Free Rent",
              "restrictions": [
                "Move in by february 29, 2024",
                "13 month lease",
                "Must be a new applicant"
              ],
              "expires_on_date": "2024-02-29",
              "subject": "Rent",
              "type_value": 6,
              "details": "Up to 6 weeks in free rent"
            }
          ],
          "non_rent_concessions": [
            {
              "display_text": "50% Off Administration Fee",
              "restrictions": [
                "Move in by february 29, 2024",
                "13 month lease",
                "Must be a new applicant"
              ],
              "expires_on_date": "2024-02-29",
              "subject": "Administration Fee",
              "type_value": 0.5,
              "details": "Half off admin fee"
            }
          ]
        },
        "net_effective_rent": 1841,
        "net_effective_rent_per_sq_ft": 2.4319682959048876,
        "annual_rent_reduction_value": 4928,
        "amenity_names": {
          "Views": [
            "<string>"
          ],
          "Balcony/Patio": [
            "<string>"
          ],
          "Washer/Dryer": [
            "<string>"
          ],
          "Kitchen Island": [
            "<string>"
          ],
          "Stainless Steel Appliances": [
            "<string>"
          ],
          "Stone Countertops": [
            "<string>"
          ],
          "Garage Attached": [
            "<string>"
          ],
          "Hardwood Floors": [
            "<string>"
          ],
          "Vinyl Flooring": [
            "<string>"
          ],
          "Walk-In Closets": [
            "<string>"
          ],
          "Linen Closet": [
            "<string>"
          ],
          "High Ceilings": [
            "<string>"
          ],
          "Ceiling Fans": [
            "<string>"
          ],
          "Air Conditioning": [
            "<string>"
          ],
          "Smart Technology": [
            "<string>"
          ],
          "Garbage Disposal": [
            "<string>"
          ],
          "Dishwasher": [
            "<string>"
          ],
          "Fireplace": [
            "<string>"
          ],
          "Carpet": [
            "<string>"
          ],
          "Pantry": [
            "<string>"
          ],
          "Tile": [
            "<string>"
          ],
          "Washer/Dryer Hookup": [
            "<string>"
          ],
          "other": [
            "<string>"
          ]
        },
        "status": "available"
      }
    }
  ]
}

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.

Response

A Map with a data attribute that contains an array of units in the competitive set [blocked].

​
data
object[]