curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v2/markets/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "{account_id}"
}
'{
"rows": [
{
"name": "Madison, WI Metro Area",
"geo_boundary_id": 4127,
"geo_type": "MSA",
"properties_count": 842,
"units_count": 156420,
"ner_to_income_ratio": 0.1739,
"median_income": 120000,
"population_total": 515000,
"population_growth_rate_yoy": 0.0198,
"employed_labor_force_count": 289400,
"unemployed_labor_force_count": 9100
},
{
"name": "Example Submarket",
"geo_boundary_id": 90114,
"geo_type": "Submarket",
"msa_name": "Madison, WI Metro Area",
"properties_count": 64,
"units_count": 11820,
"ner_to_income_ratio": null,
"median_income": null,
"population_total": null,
"population_growth_rate_yoy": null,
"employed_labor_force_count": null,
"unemployed_labor_force_count": null
}
],
"pagination": {
"current_page": 1,
"total_pages": 1,
"total_count": 2,
"per_page": 25
}
}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.
curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v2/markets/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "{account_id}"
}
'{
"rows": [
{
"name": "Madison, WI Metro Area",
"geo_boundary_id": 4127,
"geo_type": "MSA",
"properties_count": 842,
"units_count": 156420,
"ner_to_income_ratio": 0.1739,
"median_income": 120000,
"population_total": 515000,
"population_growth_rate_yoy": 0.0198,
"employed_labor_force_count": 289400,
"unemployed_labor_force_count": 9100
},
{
"name": "Example Submarket",
"geo_boundary_id": 90114,
"geo_type": "Submarket",
"msa_name": "Madison, WI Metro Area",
"properties_count": 64,
"units_count": 11820,
"ner_to_income_ratio": null,
"median_income": null,
"population_total": null,
"population_growth_rate_yoy": null,
"employed_labor_force_count": null,
"unemployed_labor_force_count": null
}
],
"pagination": {
"current_page": 1,
"total_pages": 1,
"total_count": 2,
"per_page": 25
}
}Authorizations
Body
Request contract for the API V2 markets bulk export endpoint.
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 Response
Bulk market rows and pagination metadata.