Skip to main content
This guide shows how to explore Market Surveys: comp sets, survey tables, units, and floorplans. Use this workflow to answer pricing and performance questions, such as:
  • How do our rents and NER compare to competitors today?
  • Which properties are offering concessions and how deep are they?
  • Where are we over/under-exposed by floorplan or bedroom type?
  • What unit mix trends should influence our pricing strategy?

​
Prerequisites

  • Your API key (Bearer token)
  • Account ID
    If you don’t have an API token yet, see Getting started → “Get an API token”.

​
1) List competitive sets

curl -s \
  -H "Authorization: Bearer <your_api_key>" \
  "https://data.apartmentiq.io/apartmentiq/api/v1/accounts/<account_id>/comp_sets"
This returns an array of comp sets you have access to. Each item includes helpful attributes like the comp set name, category, and subject property indicators.
Pick a comp set that represents the properties you actively compete with in a submarket. Save its id for the next steps.

​
2) Get the market survey table for a comp set

curl -s \
  -H "Authorization: Bearer <your_api_key>" \
  "https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/<comp_set_id>/market_survey"
You can filter the table to focus on specific segments. Supported query filters (comma-separated values as strings):
  • filter[bedroom_count], filter[bathroom_count]
  • filter[iq_property_ids]
  • filter[size_gte], filter[size_lte]
  • filter[rent_gte], filter[rent_lte]
  • filter[date_available_gte], filter[date_available_lte]
  • filter[year_built_gte], filter[year_built_lte]
  • filter[unit_style]
The response includes per‑property metrics (asking rent, NER, rent per sq ft, size, concessions, exposure, leased percent) and an overall comp‑average column for quick benchmarking.
See Key terms for definitions like NER, exposure, and leased percent.

​
3) List units in a comp set

curl -s \
  -H "Authorization: Bearer <your_api_key>" \
  "https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/<comp_set_id>/units?filter[bedroom_count]=1,2&filter[size_gte]=600"
This endpoint returns individual unit details, including property name, floorplan, rent and NER, square footage, availability dates, days on market, and concessions. Use it to drill into specific availability and price points.

​
4) List floorplans

curl -s \
  -H "Authorization: Bearer <your_api_key>" \
  "https://data.apartmentiq.io/apartmentiq/api/v1/comp_sets/<comp_set_id>/floor_plans?filter[aggregation_type]=avg"
Results can be grouped by bedroom only or by bedroom/bathroom. Each floorplan summary includes asking rent and NER (and their changes), rent per square foot, average size, estimated unit mix, and trends over time—ideal for floorplan‑level pricing decisions.
Set filter[aggregation_type]=avg to average metrics across underlying units, or omit to use the service default.

​
Example questions to guide analysis

  • Pricing strategy: “Are our 1‑bed asking rents above the market average? If so, by how much PSF?”
  • Concessions: “Which comps are offering the richest deals, and for which floorplans?”
  • Exposure and leasing: “Where is exposure high but leased percent trending down?”
  • Product mix: “Do larger 2‑bed homes have longer days on market relative to the comp average?”

​
Errors and rate limits

  • 401 if authorization is missing/invalid
  • 403 if you lack permissions
  • 429 if you exceed the 100 requests / 5 minutes limit
  • See Errors and Rate limits