ApartmentIQ

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 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 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 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