Bulk Markets
Retrieve bulk market rows for geographic boundaries using optional geography filters, property filters, requested fields, and pagination.
Demographic fields are annual. Omit interval for a snapshot that uses each geography’s latest available demographic data, or use interval: year for yearly rows that use demographic data for the matching year. Monthly or quarterly requests containing a demographic field return HTTP 400.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request contract for the API V2 markets bulk export endpoint.
ApartmentIQ account ID used to set the request account context.
Optional period bucket for requested metrics. Omit for one summary row per market. Demographic fields support only an omitted interval or year; requesting them with month or quarter returns HTTP 400.
month, quarter, year Optional metric field names. Omit or pass an empty array for identity-only rows. Snapshot demographic values use the latest available annual data for each geography. Yearly rows use data for the matching year; if that year's data is unavailable, the requested value is null. Every requested key remains present and is null when its required geography, annual data, prior-year comparison, NER, or demographic value is unavailable.
Metric field to include. Absorption and delivery fields require interval quarter. Demographic fields are annual-only and require interval year or no interval.
rent, rent_0_bed, rent_1_bed, rent_2_bed, rent_3_bed, ner, ner_0_bed, ner_1_bed, ner_2_bed, ner_3_bed, rent_psf, rent_0_bed_psf, rent_1_bed_psf, rent_2_bed_psf, rent_3_bed_psf, ner_psf, ner_0_bed_psf, ner_1_bed_psf, ner_2_bed_psf, ner_3_bed_psf, rent_growth_rate_yoy, ner_growth_rate_yoy, concession_value, concession_percent, days_on_market, occupancy_percent, leased_percent, exposure_percent, absorbed_unit_count, delivered_unit_count, ner_to_income_ratio, median_income, population_total, population_growth_rate_yoy, employed_labor_force_count, unemployed_labor_force_count Market selection filters. Omit to page through all supported market boundaries.
Property filters used when calculating market-level metric values.
One-based page number for the export result set.
x >= 1Number of rows per page. Values above the maximum are clamped.
1 <= x <= 100