ApartmentIQ

Use when you need the primary source for high-level market data, market screening, or market comparison metrics such as NER, occupancy, inventory, demographics, forecasted growth, and sales activity. Rent metrics cover all unit types at the selected properties. Bedroom and bathroom filters select properties offering those types; they do not restrict rents to matching units or an exact bed/bath pair. For gross asking rent or bedroom-specific asking rent and NER, use market_historicals_get with explicit metric fields and dates. A null summary value does not mean those historical fields are unavailable.

market_summary_get

Use when a question spans the user's market surveys: ranking or comparing them, a portfolio overview, or the numbers the Market Surveys list page shows. Returns one row per market survey with the subject property's metrics, the comp-set averages and the subject-versus-comps differences, up to 50 a page; research reports and other comp sets are never included. To rank, pass sort_by with a limit instead of reading every page: the server ranks every matching survey first, and ranked_count of total_count had a value to rank on. Pass metrics to get only the numbers the question needs. advertised_occupancy is the Occupancy column and leased_percent is Leased %. Example, the five subjects furthest below their comps on occupancy: sort_by advertised_occupancy, sort_on difference, sort_direction asc, limit 5, metrics [advertised_occupancy]. Use query to narrow to surveys by name or subject property, or comp_set_ids from comp_sets_list. Use comp_set_get for one survey's full comparison table with bedroom or date filters. The first call for an account whose summary is cold can take a while.

market_surveys_summary_get

Use when you need a time series of closed sale transaction metrics for a market, such as sales volume, price per unit, or cap rate trends over a date range.

market_transactions_historicals_get

Use when you need modeled future rent growth or occupancy time series for a specific property. Property forecasts are not available for every property; if no modeled coverage exists, use live property data instead.

property_forecasts_get

Use when you need historical time series for selected properties, such as rent, NER, occupancy, exposure, concessions, supply, or unit mix trends.

property_historicals_get

Use when you need lease-stabilization velocity, net leased share, and Units / Month for a property. Average Units / Month is the average units leased across available observation months; time-series Units / Month is the number of units leased during each observation month. The time series includes available nonnegative lease-up months and may have gaps. Use properties_search to find property IDs.

property_lease_stabilization_velocity_get

Use when you need current operating expense metrics for a property, including revenue, expense, and NOI fields. Use properties_search to find property IDs.

property_operating_expenses_get

Use when you need rent comparable properties for a property, including the same property details, rent metrics, comp scores, subject property details, and existing comp-set metadata returned by the property rent comps API. Use properties_search to find property IDs.

property_rent_comps_get

Use when you need unit-level rent roll rows for a property, including the fields returned by the property rent roll API and Data Driven Excel export. Use properties_search to find property IDs.

property_rent_roll_get

Use when you need sales comparable properties for a property, including transaction details, sale pricing metrics, buyer/seller ownership context, subject property details, and the same comp selection behavior returned by the property sales comps API. Use properties_search to find property IDs.

property_sales_comps_get

Use when you need current summary metrics for selected properties or property groups, such as benchmarking rent, NER, occupancy, exposure, concessions, or unit counts.

property_summary_get

Use when you need sales transaction records for a property. Use properties_search to find property IDs.

property_transactions_get

Use when you need markets related to a known ApartmentIQ market ID or geometry, primarily submarkets and zip codes associated with a market. Defaults to BespokeSubmarket and ZipCode results when geo_types is omitted, and returns up to 10 markets by default. Use markets_search first if you need to find a market ID.

market_related_markets_get

Use when you need detailed company profile and portfolio summary metrics for a stakeholder entity. Call stakeholders_search first to find the stakeholder_entity_id.

stakeholder_details_get

Use when you need people and contact details associated with a stakeholder entity. Call stakeholders_search first to find the stakeholder_entity_id.

stakeholder_people_get

Use when you need valid ApartmentIQ amenity IDs, names, and categories for property filtering or amenity comparisons.

amenities_list

Use when you need to find the comp_set_id for a property, saved research report, or Market Survey comp set before calling comp_set_get, comp_set_units_get, or comp_set_floor_plans_get, or to see every comp set the user can access (omit query). Results come 10 at a time unless you pass limit (up to 50); ask for 50 when you need the whole list. While a response carries nextCursor, call again with it as cursor to get the rest. Matches comp set names, saved research report names, and custom subject-property addresses (prospective properties not yet in the system), in addition to real property names and addresses. Use properties_search instead if you need general Explore property data unrelated to a comp set, and market_surveys_summary_get to rank or compare the user's market surveys. For the ApartmentIQ Copilot each result also carries copilot_url, the link to use when naming that comp set.

comp_sets_list

Use when you need the properties inside a market or trade area, optionally filtered by property characteristics, for comp selection, underwriting, or pipeline analysis.

market_properties_list

Use when you need schools and district summaries inside an ApartmentIQ market or custom trade-area geometry. Provide geo_boundary_id or geometry; use markets_search first to find a market ID.

market_schools_list

Use when you need individual closed property transactions for a market and date range, including transaction-level sale details for deal review or comps.

market_transactions_list

Use when you need schools and district summaries for attendance areas serving an ApartmentIQ property. Use properties_search first to find a property ID.

property_schools_list

Use when you need properties associated with an owner, registered owner, or property manager, optionally filtered by property characteristics. Call stakeholders_search first to find the stakeholder_entity_id.

stakeholder_properties_list

Use when you need to find ApartmentIQ market or geo boundary IDs by name before calling market summary, market properties, market historicals, forecasts, narratives, or transaction tools.

markets_search

Use when you need to find ApartmentIQ property IDs by name, address, city, state, ZIP, or property ID before calling property summary, property historicals, or property forecasts.

properties_search

Use when you need stakeholder entity IDs for owners, registered owners, or property managers before filtering property search or market/property analysis by stakeholder.

stakeholders_search