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"
      }
    }
  ]
}

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

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

comp_set_id

integer

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.

data

object[]

Show child attributes

data.id

string

required

ID of the unit.

Example:

"99030676_021621"

data.type

string

required

Type of data returned in the response.

Example:

"unit"

data.attributes

object

required

Container for unit attributes and metrics.

Show child attributes

data.attributes.property_id

integer

ID of the property the unit belongs to.

Example:

99030676

data.attributes.subject_property

boolean

Whether the unit belongs to the subject property of this comp set.

Example:

true

data.attributes.property_name

string

Name of the property the unit belongs to.

Example:

"Cortland Bowery"

data.attributes.is_leased

boolean

Whether the unit is leased.

Example:

false

data.attributes.year_built

integer

Year the property the unit belongs to was built.

Example:

1987

data.attributes.unit_name

string

Name of the unit.

Example:

"#02 - 1621"

data.attributes.days_on_market

integer

Number of days the unit has been on the market since it started being advertised.

Example:

81

data.attributes.date_available

string<date>

Date the unit is available for move, in ISO 8601 format.

Example:

"2024-02-13"

data.attributes.bedroom_count

integer

Number of bedrooms in the unit.

Example:

1

data.attributes.bathroom_count

number<float>

Number of bathrooms in the unit.

Example:

1

data.attributes.min_rent

number<float>

Minimum rent of the unit.

Example:

1841

data.attributes.sq_ft

integer

Square footage of the unit.

Example:

757

data.attributes.floorplan_name

string

Name of the floorplan of the unit.

Example:

"A3 - Clearwater"

data.attributes.avg_rent_per_sq_ft

number<float>

Average rent per square foot of the unit.

Example:

2.4319682959048876

data.attributes.last_rent_change_date

string<date>

Date of the last rent change, in ISO 8601 format.

Example:

"2024-02-07"

data.attributes.last_rent_change

string

Amount of the last rent change.

Example:

"$10"

data.attributes.total_30_day_rent_change

string

Total rent change in the last 30 days.

Example:

"$55"

data.attributes.rent_changes_last_30_days

integer

Number of rent changes in the last 30 days.

Example:

10

data.attributes.is_trucomp

boolean

Whether the unit is a truComp of the subject units in the comp set.

Example:

false

data.attributes.date_leased

string<date-time>

Date the unit was leased.

Example:

"2024-02-01T12:00:00Z"

data.attributes.trucomp_rent_differential

number<float>

Percent differential of the units rent compared to the truComp average rent.

Example:

0.021040974529346623

data.attributes.trucomp_sq_ft_differential

number<float>

Percent differential of the units square footage compared to the truComp average square footage.

Example:

-0.04634522236900049

data.attributes.trucomp_rent_per_sq_ft_differential

number<float>

Percent differential of the units rent per square foot compared to the truComp average rent per square foot.

Example:

0.07066099649366094

data.attributes.concessions

object

Concessions being offered and their metadata.

Show child attributes

data.attributes.concessions.id

integer

ID of the concession.

Example:

299639

data.attributes.concessions.property_id

integer

ID of the property the concession applies to.

Example:

99030676

data.attributes.concessions.expires_at

string<date-time>

Time the concession expires, in ISO 8601 format.

Example:

"2024-02-29T23:59:59.999Z"

data.attributes.concessions.updated_at

string<date-time>

Time the concession was last updated, in ISO 8601 format.

Example:

"2024-02-13T10:15:26.403Z"

data.attributes.concessions.updated_at_formatted

string

Formatted date the concession was last updated.

Example:

"8 hours ago"

data.attributes.concessions.display_text

string

Human friendly text describing the concessions and any restrictions that apply to them.

Example:

"up to 6 weeks in free rent\nRestrictions: Move in by February 29, 2024, 13 month lease, Must be a new applicant"

data.attributes.concessions.rent_concessions

object[]

List of concessions that apply to rent.

Show child attributes

data.attributes.concessions.rent_concessions.display_text

string

Human friendly text describing the rent concession and any restrictions that apply.

Example:

"Up to 6 Weeks Free Rent"

data.attributes.concessions.rent_concessions.restrictions

string[]

List of restrictions that apply to the rent concession.

Example:

[
  "Move in by february 29, 2024",
  "13 month lease",
  "Must be a new applicant"
]

data.attributes.concessions.rent_concessions.expires_on_date

string<date>

Date the rent concession expires, in ISO 8601 format.

Example:

"2024-02-29"

data.attributes.concessions.rent_concessions.subject

string

Subject of the rent concession.

Example:

"Rent"

data.attributes.concessions.rent_concessions.type_value

number<float>

Value of the rent concession.

Example:

6

data.attributes.concessions.rent_concessions.details

string

Raw details of the rent concession.

Example:

"Up to 6 weeks in free rent"

data.attributes.concessions.non_rent_concessions

object[]

List of concessions that do not apply to rent.

Show child attributes

data.attributes.concessions.non_rent_concessions.display_text

string

Human friendly text describing the non-rent concession and any restrictions that apply.

Example:

"50% Off Administration Fee"

data.attributes.concessions.non_rent_concessions.restrictions

string[]

List of restrictions that apply to the non-rent concession.

Example:

[
  "Move in by february 29, 2024",
  "13 month lease",
  "Must be a new applicant"
]

data.attributes.concessions.non_rent_concessions.expires_on_date

string<date>

Date the non-rent concession expires, if known, in ISO 8601 format.

Example:

"2024-02-29"

data.attributes.concessions.non_rent_concessions.subject

string

Subject of the non-rent concession.

Example:

"Administration Fee"

data.attributes.concessions.non_rent_concessions.type_value

number<float>

Value of the non-rent concession.

Example:

0.5

data.attributes.concessions.non_rent_concessions.details

string

Raw details of the non-rent concession.

Example:

"Half off admin fee"

data.attributes.net_effective_rent

integer<float>

Net effective rent of the unit.

Example:

1841

data.attributes.net_effective_rent_per_sq_ft

number<float>

Net effective rent per square foot of the unit.

Example:

2.4319682959048876

data.attributes.annual_rent_reduction_value

integer<float>

Annual rent reduction value of the units concessions.

Example:

4928

data.attributes.amenity_names

object

Object containing various unit amenities and their corresponding data.

Show child attributes

data.attributes.amenity_names.Views

string[]

Text description of the views available from the unit.

data.attributes.amenity_names.Balcony/Patio

string[]

Text description of the balconies or patios available.

data.attributes.amenity_names.Washer/Dryer

string[]

Text description of the washer and dryer options in the unit.

data.attributes.amenity_names.Kitchen Island

string[]

Text description of the kitchen islands available.

data.attributes.amenity_names.Stainless Steel Appliances

string[]

Text description of the stainless steel appliances available.

data.attributes.amenity_names.Stone Countertops

string[]

Text description of the stone countertops available.

data.attributes.amenity_names.Garage Attached

string[]

Text description of the attached garages available.

data.attributes.amenity_names.Hardwood Floors

string[]

Text description of the hardwood floors available.

data.attributes.amenity_names.Vinyl Flooring

string[]

Text description of the vinyl flooring available.

data.attributes.amenity_names.Walk-In Closets

string[]

Text description of the walk-in closets available.

data.attributes.amenity_names.Linen Closet

string[]

Text description of the linen closets available.

data.attributes.amenity_names.High Ceilings

string[]

Text description of the high ceilings available.

data.attributes.amenity_names.Ceiling Fans

string[]

Text description of the ceiling fans available.

data.attributes.amenity_names.Air Conditioning

string[]

Text description of the air conditioning available.

data.attributes.amenity_names.Smart Technology

string[]

Text description of the smart technology features available.

data.attributes.amenity_names.Garbage Disposal

string[]

Text description of the garbage disposal units available.

data.attributes.amenity_names.Dishwasher

string[]

Text description of the dishwashers available.

data.attributes.amenity_names.Fireplace

string[]

Text description of the fireplaces available.

data.attributes.amenity_names.Carpet

string[]

Text description of the carpeting available.

data.attributes.amenity_names.Pantry

string[]

Text description of the pantries available.

data.attributes.amenity_names.Tile

string[]

Text description of the tile flooring or features available.

data.attributes.amenity_names.Washer/Dryer Hookup

string[]

Text description of the washer/dryer hookups available.

data.attributes.amenity_names.other

string[]

Other miscellaneous amenities not covered in the above categories.

data.attributes.status

string

Status of the unit.

Example:

"available"

Get Market Survey Data List Floorplans

⌘I

Overview

Use Cases

API Reference

List Units In Competitive Set

Authorizations

Path Parameters

Query Parameters

Response