amenities_list
ChatGPTUse when you need valid ApartmentIQ amenity IDs, names, and categories for property filtering or amenity comparisons.
comp_set_floor_plans_get
ChatGPTUse when you need floor-plan-level rent and NER trends plus estimated unit mix for a comp set, such as which floor plans performed best recently. Call comp_sets_list first to find the comp_set_id.
comp_set_get
ChatGPTUse when you need the Market Survey comparison table for a comp set: rent, concessions, occupancy, and exposure per property, matching what the Market Survey UI shows. Call comp_sets_list first to find the comp_set_id. Returns a default set of metrics unless fields and/or metric_group is given, in which case the named fields (individually and/or via named groups) are returned instead.
comp_set_units_get
ChatGPTUse when you need unit-level rent, days on market, concessions, and lease dates for granular unit-to-unit comparisons within a comp set, such as what rented in the last N days or how a bedroom type's days on market compares across properties. Call comp_sets_list first to find the comp_set_id. Returns at most 1000 units total across all pages for a single query -- narrow with filters if the comp set holds more.
comp_sets_list
ChatGPTUse 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.
market_absorption_historicals_get
ChatGPTUse when you need historical market absorption and delivery counts across selected market and property filters. Returns quarterly buckets.
market_construction_pipeline_get
ChatGPTUse when you need construction pipeline time series for a market or filtered property set. Returns pipeline status and unit distribution series for Supply charts; use markets_search first to find market IDs.
market_forecasts_get
ChatGPTUse when you need modeled future rent growth, occupancy, absorption, or delivery trends for a market returned by markets_search. Forecasts are only available for MSA, BespokeSubmarket, and ZipCode markets.
market_historicals_get
ChatGPTUse when you need historical time series for market performance metrics, such as rent, NER, occupancy, exposure, concessions, or supply trends across selected market and property filters.
market_lease_stabilization_velocity_get
ChatGPTUse when you need market lease-up stabilization timing, monthly velocity, monthly units-leased pace, or the lease-up corridor. The summary uses completed lease-ups. The corridor reports chart-ready leased share 25th percentile, median, and 75th percentile by lease-up month. Use markets_search first to find market IDs.
market_narrative_get
ChatGPTUse when you need a structured written market narrative covering overview, rents, demand, pipeline, sales, and demographics for a geo boundary. Narratives are only available for MSA and BespokeSubmarket markets, are not generated daily, and may lag the latest indexed data; use live data tools such as market_summary_get or market_historicals_get when the most recent data is most important.
market_properties_list
ChatGPTUse when you need the properties inside a market or trade area, optionally filtered by property characteristics, for comp selection, underwriting, or pipeline analysis.
market_related_markets_get
ChatGPTUse 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_schools_list
ChatGPTUse 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_summary_get
ChatGPTUse when you need the primary source for high-level market data, market screening, or market comparison metrics such as rent, NER, occupancy, inventory, demographics, forecasted growth, and sales activity. Prefer this over deriving high-level market data from lower-level tools.
market_surveys_summary_get
ChatGPTUse 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, 50 a page; research reports and other comp sets are never included. Omit comp_set_ids to cover every market survey the user can access, or pass 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_transactions_historicals_get
ChatGPTUse 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_list
ChatGPTUse when you need individual closed property transactions for a market and date range, including transaction-level sale details for deal review or comps.
markets_search
ChatGPTUse 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.
properties_search
ChatGPTUse 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.
property_forecasts_get
ChatGPTUse 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_historicals_get
ChatGPTUse when you need historical time series for selected properties, such as rent, NER, occupancy, exposure, concessions, supply, or unit mix trends.
property_lease_stabilization_velocity_get
ChatGPTUse 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_operating_expenses_get
ChatGPTUse when you need current operating expense metrics for a property, including revenue, expense, and NOI fields. Use properties_search to find property IDs.
property_rent_comps_get
ChatGPTUse 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_roll_get
ChatGPTUse 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_sales_comps_get
ChatGPTUse 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_schools_list
ChatGPTUse when you need schools and district summaries for attendance areas serving an ApartmentIQ property. Use properties_search first to find a property ID.
property_summary_get
ChatGPTUse when you need current summary metrics for selected properties or property groups, such as benchmarking rent, NER, occupancy, exposure, concessions, or unit counts.
property_transactions_get
ChatGPTUse when you need sales transaction records for a property. Use properties_search to find property IDs.
stakeholder_details_get
ChatGPTUse 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_people_get
ChatGPTUse when you need people and contact details associated with a stakeholder entity. Call stakeholders_search first to find the stakeholder_entity_id.
stakeholder_properties_list
ChatGPTUse 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.
stakeholders_search
ChatGPTUse when you need stakeholder entity IDs for owners, registered owners, or property managers before filtering property search or market/property analysis by stakeholder.
amenities_list
Claudemarket_absorption_historicals_get
Claudemarket_construction_pipeline_get
Claudemarket_forecasts_get
Claudemarket_historicals_get
Claudemarket_narrative_get
Claudemarket_properties_list
Claudemarket_related_markets_get
Claudemarket_summary_get
Claudemarket_transactions_historicals_get
Claudemarket_transactions_list
Claudemarkets_search
Claudeproperties_search
Claudeproperty_forecasts_get
Claudeproperty_historicals_get
Claudeproperty_operating_expenses_get
Claudeproperty_rent_comps_get
Claudeproperty_rent_roll_get
Claudeproperty_sales_comps_get
Claudeproperty_summary_get
Claudeproperty_transactions_get
Claudestakeholder_details_get
Claudestakeholder_people_get
Claudestakeholder_properties_list
Claudestakeholders_search
Claude