Search Geo Boundaries (
POST /geo_boundaries/search) accepts a limit of up to 1500. The docs previously listed 1000 as the maximum.Documented lease terms on the comp set endpoints. The lease term filter,
lease_term_rents, and the two Market Survey lease term fields need lease terms on the comp set’s account.- Market Survey (
GET /comp_sets/{comp_set_id}/market_survey), Units (GET /comp_sets/{comp_set_id}/units) and Floor Plans (GET /comp_sets/{comp_set_id}/floor_plans) acceptfilter[lease_term_ids], which averages rent and NER across the selected lease lengths. Each endpoint’s description says which values go blank when a unit offers none of them - These endpoints return 403 when
filter[lease_term_ids]is set and the comp set’s account does not have lease terms - Market Survey items include
lease_terms_offeredandby_unit_type_best_lease_term - Units include
lease_term_rents, with the price, NER and concession percentage for each lease length the unit offers. It isnullfor leased and applied rows and for accounts without lease terms.concession_percentageis an unrounded fraction (0.0754is 7.54%) - Units
best_lease_termhas a new rule: the unit’s cheapest offered lease length, limited to the selected lease lengths whenfilter[lease_term_ids]is set. A unit with no per-term rents keeps its listing’s term, even outside the filter - Under
filter[lease_term_ids], a unit’s concession values are repriced along with its rent, andfilter[rent_gte]andfilter[rent_lte]match the base asking rent before averaging - Unit
statusexamples now match the API’s casing (Available) - The Bulk Data Export guide no longer says unit reports include lease terms, and describes their pricing history as a rent-change summary
Documented the
collected_at filters on Floorplans (GET /comp_sets/{comp_set_id}/floor_plans), which the endpoint already accepted.filter[collected_at_gte]andfilter[collected_at_lte]select which collection days the response covers- They are distinct from
filter[date_available_gte]andfilter[date_available_lte], which filter on when a unit becomes available - Omit both to get the most recent available collection day on its own
Property Forecasts can now use an optional submarket fallback when property rent-growth forecast data is unavailable.
- Set
use_submarket_fallback: trueonPOST /properties/{property_id}/forecaststo enable the fallback - The fallback applies only when all requested property rent-growth values are unavailable
- The default remains
false, so existing requests keep their current behavior - With
use_rent_value: true, the endpoint applies submarket growth to the property’s rent baseline
Property bulk exports no longer require a geographic filter.
- Search Properties (
POST /geo_boundaries/properties) can retrieve properties across all available areas geo_boundary_idsandgeometryremain available as optional filters- Bulk export quota limits continue to apply to returned unique properties
Added four all-in pricing metrics — All In Rent, All In Rent/ft, All In NER, and All In NER/ft (base rent or NER plus recurring monthly fees; per-square-foot variants divide by square footage) — across the market survey and bulk data export endpoints.
- Market Survey table (
GET /comp_sets/{comp_set_id}/market_survey):total_monthly_leasing_price_breakdown,total_monthly_leasing_price_psf,all_in_net_effective_rent_breakdown,all_in_net_effective_rent_psf(also available asby_unit_type_*andby_bed_bath_*variants) - Units (
GET /comp_sets/{comp_set_id}/units):all_in_rent,all_in_rent_per_sq_ft,all_in_ner,all_in_ner_per_sq_ft - Floor Plans (
GET /comp_sets/{comp_set_id}/floor_plans):all_in_rent,all_in_rent_per_sqft,all_in_ner,all_in_ner_per_sqft - Bulk Data Export (
report_typeproperty,units,floorplans):all_in_rent,all_in_rent_psf,all_in_ner,all_in_ner_psf
Updated the API documentation to match current rate limit, error, and bulk property details behavior.
- Documented rate limit response headers and retry guidance without publishing fixed limits
- Added the Property Lookup access requirement note
- Updated Bulk Property Details and Search Properties access and quota notes
- Clarified JSON, plain text, and empty-body error responses
The Property Lookup (
GET /properties/lookup) endpoint now supports filtering by property URL.- Added
property_urlquery parameter (partial match supported)
The Compare Markets (
POST /explore_markets) response no longer includes absorption_rate_avg_t30.Updated authentication docs and OpenAPI schema to accurately reflect the OAuth token flow.
- Removed incorrect JWT references from the auth page and OpenAPI security scheme
- Fixed token response example to match the actual API response (opaque token, correct casing, added
scopeandcreated_atfields) - Documented
application/jsonas an alternative content type for the token endpoint - Simplified the OpenAPI security configuration to a single
oauth2scheme - Updated Try It panel description to match the bearer token input UX
account_id parameter when calling other endpoints.- Accounts
- List Accounts:
GET /accounts- Retrieve a paginated list of accounts with their ID and name - Supports pagination via
pageandper_pagequery parameters (default 50 per page, max 100)
- List Accounts:
The Geo Boundary Forecasts (
POST /geo_boundary/{geo_boundary_id}/forecasts) and Property Forecasts (POST /properties/{property_id}/forecasts) endpoints now support use_rent_value.- Set
use_rent_value: trueto return rent-growth aggregations as seasonally adjusted forecasted rent values in dollars - Aggregation keys stay the same as the
namevalues you provide in the request - Non-rent-growth aggregations, such as occupancy, absorption, and deliveries, are unchanged
New endpoint for retrieving market narratives for geographic boundaries. Narratives provide structured analysis across six key areas: market overview, rent performance, occupancy and demand, construction pipeline, sales transactions, and demographics.
- Markets
- Market Narratives:
GET /markets/narratives- Retrieve the most recent narrative for a geo boundary
- Market Narratives:
- Narratives are only available for MSA and Submarket geo boundary types
- The
salessection is truncated for accounts without Explore Pro+ access - Requires Explore access
The Search Properties (
POST /geo_boundaries/properties) and Bulk Property Details (GET /properties/bulk_details) endpoints now include market_name and submarket_name in each property’s attributes, so you no longer need a separate call to the Search Geo Boundaries endpoint to resolve boundary names.- Added:
market_name- Display name of the market-level geographic boundary (MSA) the property belongs to - Added:
submarket_name- Display name of the submarket-level geographic boundary the property belongs to
New endpoints for retrieving modeled future time-series forecast data, powered by ApartmentIQ’s proprietary forecasting models. Requires Explore Pro access.
- Forecasts
- Geo Boundary Forecasts:
POST /geo_boundary/{geo_boundary_id}/forecasts- Retrieve forecast time-series data for a geographic boundary (MSA, submarket, etc.) - Property Forecasts:
POST /properties/{property_id}/forecasts- Retrieve forecast time-series data for a specific property
- Geo Boundary Forecasts:
- Configurable aggregations:
avg,median,sum,max,min - Time intervals:
month,quarter, oryear - Forecast window: current month through 5 years out
- Includes confidence bounds (downside/upside variants) for all forecast metrics
New filter parameters to search and filter properties by loan maturity date and sales transaction data. Available on the Search Properties and Property Lookup endpoints.
- Added
loan_maturity_date_gteandloan_maturity_date_ltefilter parameters - Added
transaction_cap_rate_gteandtransaction_cap_rate_ltefilter parameters - Added
transaction_date_closed_gteandtransaction_date_closed_ltefilter parameters - Added
transaction_price_per_unit_gteandtransaction_price_per_unit_ltefilter parameters
The Search Properties (
POST /geo_boundaries/properties) and Bulk Property Details (GET /properties/bulk_details) endpoints now include market_geo_boundary_id and submarket_geo_boundary_id in each property’s attributes. Use these IDs with the Search Geo Boundaries endpoint to look up boundary details.- Added:
market_geo_boundary_id- ID of the market-level geographic boundary (MSA) the property belongs to - Added:
submarket_geo_boundary_id- ID of the submarket-level geographic boundary the property belongs to
The
construction_state filter parameter has been removed from the Bulk Properties and Compare Markets endpoints. Use the new unified_status filter instead, which consolidates construction stage, implementation status, and lease-up into a single property lifecycle indicator.- Removed:
construction_state[]filter parameter - Added:
unified_status[]filter parameter with values:stabilized,planning,scheduled_construction,under_construction,lease_up
New asynchronous batch job system for retrieving historical property data at scale, plus new property search capabilities.
-
Bulk Data Export
- Create Batch Job:
POST /bulk_api/jobs- Submit a request for property, units, or floorplans data - List Batch Jobs:
GET /bulk_api/jobs- Retrieve a paginated list of all batch jobs - Get Batch Job Status:
GET /bulk_api/jobs/{job_id}- Monitor job progress and check completion status - Cancel Batch Job:
DELETE /bulk_api/jobs/{job_id}- Cancel a running or submitted job - Download Batch Job Results:
GET /bulk_api/jobs/{job_id}/results- Download completed results in CSV, JSONL, or Parquet format
- Create Batch Job:
-
Markets
- Property Lookup:
GET /properties/lookup- Search for properties by location, coordinates, or attributes and return paginated property IDs - Bulk Property Details:
GET /properties/bulk_details- Retrieve full property details for multiple properties by ID
- Property Lookup:
New endpoint for comparing aggregated market-level metrics across MSAs and submarkets.
-
Markets
- Compare Markets:
POST /explore_markets- Retrieve aggregated metrics for geographic areas including rent performance, inventory, demographics, and sales transaction data
- Compare Markets:
-
Documentation
- Added Compare Markets use case guide
Initial public documentation of the ApartmentIQ API.
-
Authentication: Bearer tokens via
Authorizationheader -
Base URL:
https://data.apartmentiq.io/apartmentiq/api/v1 -
Market Surveys
- List Competitive Sets:
GET /accounts/{account_id}/comp_sets - Market Survey:
GET /comp_sets/{comp_set_id}/market_survey - Units:
GET /comp_sets/{comp_set_id}/units - Floorplans:
GET /comp_sets/{comp_set_id}/floor_plans
- List Competitive Sets:
-
Markets
- Search Geo Boundaries:
POST /geo_boundaries/search - Bulk Properties:
POST /geo_boundaries/properties
- Search Geo Boundaries:
-
Global
- Security scheme: HTTP Bearer (JWT)
- Rate limits return 429 when exceeded