curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v1/geo_boundaries/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "your_account_id",
"property_filters": {
"geo_boundary_ids": [
"94216",
"93759"
],
"total_units_gte": 400,
"property_class": [
"A",
"B"
]
}
}
'{
"data": [
{
"id": "99030676",
"type": "properties",
"attributes": {
"collected_at": "2024-01-15",
"msa_name": "Raleigh-Cary, NC",
"property_name": "The Heights at Main Street",
"property_id": 123456,
"property_url": "https://example.com/property/123456",
"address": "123 Main Street",
"city": "Raleigh",
"state": "NC",
"zip": "27605",
"latitude": 35.8234,
"longitude": -78.6382,
"unit_count": 250,
"year_built": 2018,
"year_renovated": 2022,
"construction_status": "existing",
"property_class": "A",
"management_company_name": "Premium Property Management",
"property_type": "conventional",
"building_type": "Mid-Rise",
"building_count": 3,
"rentable_building_area_sq_ft": 225000,
"land_area_sq_ft": 435600,
"units_per_acre": 25.2,
"number_of_stories": 5,
"average_unit_size": 900,
"transit_score": 45,
"walk_score": 72,
"ownership_company_1_name": "ABC Real Estate Holdings",
"ownership_company_1_ownership_type": "Private",
"ownership_company_2_name": "XYZ Real Estate Holdings",
"ownership_company_2_ownership_type": "Public",
"ownership_company_3_name": "123 Real Estate Holdings",
"ownership_company_3_ownership_type": "Institutional",
"ownership_company_4_name": "456 Real Estate Holdings",
"ownership_company_4_ownership_type": "Private",
"owned_since_date": "2015-03-15",
"last_sale_price": 45000000,
"last_sale_price_status": "closed",
"asking_rent": 1850,
"asking_rent_psf": 2.06,
"net_effective_rent": 1795,
"net_effective_rent_psf": 1.99,
"exposure_percent": 8.5,
"advertised_occupancy_percent": 94.2,
"leased_percent": 95.6,
"available_unit_count_0_bed": 2,
"available_unit_count_1_bed": 5,
"available_unit_count_2_bed": 8,
"available_unit_count_3_bed": 3,
"available_unit_count_4_bed": 0,
"leased_unit_count_0_bed": 2,
"leased_unit_count_1_bed": 5,
"leased_unit_count_2_bed": 8,
"leased_unit_count_3_bed": 3,
"leased_unit_count_4_bed": 0,
"asking_rent_0_bed": 1450,
"asking_rent_1_bed": 1450,
"asking_rent_2_bed": 1950,
"asking_rent_3_bed": 2450,
"asking_rent_4_bed": 2450,
"asking_rent_psf_0_bed": 2.07,
"asking_rent_psf_1_bed": 2.07,
"asking_rent_psf_2_bed": 1.95,
"asking_rent_psf_3_bed": 1.88,
"asking_rent_psf_4_bed": 1.88,
"concession_percent_0_bed": 2.5,
"concession_percent_1_bed": 2.5,
"concession_percent_2_bed": 3,
"concession_percent_3_bed": 2,
"concession_percent_4_bed": 2,
"concession_value_0_bed": 1200,
"concession_value_1_bed": 1300,
"concession_value_2_bed": 1800,
"concession_value_3_bed": 2400,
"concession_value_4_bed": 2400,
"net_effective_rent_0_bed": 1300,
"net_effective_rent_1_bed": 1414,
"net_effective_rent_2_bed": 1892,
"net_effective_rent_3_bed": 2401,
"net_effective_rent_4_bed": 2400,
"net_effective_rent_psf_0_bed": 1.95,
"net_effective_rent_psf_1_bed": 1.95,
"net_effective_rent_psf_2_bed": 1.88,
"net_effective_rent_psf_3_bed": 1.88,
"net_effective_rent_psf_4_bed": 1.88,
"days_on_market_0_bed": 15,
"days_on_market_1_bed": 15,
"days_on_market_2_bed": 22,
"days_on_market_3_bed": 28,
"days_on_market_4_bed": 28
}
}
]
}Retrieve bulk property data filtered by geographic boundaries (MSAs, Submarkets, Cities, Counties, Zip Codes, or Neighborhoods) or custom GeoJSON geometries. Returns detailed property data including physical characteristics, rent metrics, availability, and ownership information (with appropriate data access).
curl --request POST \
--url https://data.apartmentiq.io/apartmentiq/api/v1/geo_boundaries/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "your_account_id",
"property_filters": {
"geo_boundary_ids": [
"94216",
"93759"
],
"total_units_gte": 400,
"property_class": [
"A",
"B"
]
}
}
'{
"data": [
{
"id": "99030676",
"type": "properties",
"attributes": {
"collected_at": "2024-01-15",
"msa_name": "Raleigh-Cary, NC",
"property_name": "The Heights at Main Street",
"property_id": 123456,
"property_url": "https://example.com/property/123456",
"address": "123 Main Street",
"city": "Raleigh",
"state": "NC",
"zip": "27605",
"latitude": 35.8234,
"longitude": -78.6382,
"unit_count": 250,
"year_built": 2018,
"year_renovated": 2022,
"construction_status": "existing",
"property_class": "A",
"management_company_name": "Premium Property Management",
"property_type": "conventional",
"building_type": "Mid-Rise",
"building_count": 3,
"rentable_building_area_sq_ft": 225000,
"land_area_sq_ft": 435600,
"units_per_acre": 25.2,
"number_of_stories": 5,
"average_unit_size": 900,
"transit_score": 45,
"walk_score": 72,
"ownership_company_1_name": "ABC Real Estate Holdings",
"ownership_company_1_ownership_type": "Private",
"ownership_company_2_name": "XYZ Real Estate Holdings",
"ownership_company_2_ownership_type": "Public",
"ownership_company_3_name": "123 Real Estate Holdings",
"ownership_company_3_ownership_type": "Institutional",
"ownership_company_4_name": "456 Real Estate Holdings",
"ownership_company_4_ownership_type": "Private",
"owned_since_date": "2015-03-15",
"last_sale_price": 45000000,
"last_sale_price_status": "closed",
"asking_rent": 1850,
"asking_rent_psf": 2.06,
"net_effective_rent": 1795,
"net_effective_rent_psf": 1.99,
"exposure_percent": 8.5,
"advertised_occupancy_percent": 94.2,
"leased_percent": 95.6,
"available_unit_count_0_bed": 2,
"available_unit_count_1_bed": 5,
"available_unit_count_2_bed": 8,
"available_unit_count_3_bed": 3,
"available_unit_count_4_bed": 0,
"leased_unit_count_0_bed": 2,
"leased_unit_count_1_bed": 5,
"leased_unit_count_2_bed": 8,
"leased_unit_count_3_bed": 3,
"leased_unit_count_4_bed": 0,
"asking_rent_0_bed": 1450,
"asking_rent_1_bed": 1450,
"asking_rent_2_bed": 1950,
"asking_rent_3_bed": 2450,
"asking_rent_4_bed": 2450,
"asking_rent_psf_0_bed": 2.07,
"asking_rent_psf_1_bed": 2.07,
"asking_rent_psf_2_bed": 1.95,
"asking_rent_psf_3_bed": 1.88,
"asking_rent_psf_4_bed": 1.88,
"concession_percent_0_bed": 2.5,
"concession_percent_1_bed": 2.5,
"concession_percent_2_bed": 3,
"concession_percent_3_bed": 2,
"concession_percent_4_bed": 2,
"concession_value_0_bed": 1200,
"concession_value_1_bed": 1300,
"concession_value_2_bed": 1800,
"concession_value_3_bed": 2400,
"concession_value_4_bed": 2400,
"net_effective_rent_0_bed": 1300,
"net_effective_rent_1_bed": 1414,
"net_effective_rent_2_bed": 1892,
"net_effective_rent_3_bed": 2401,
"net_effective_rent_4_bed": 2400,
"net_effective_rent_psf_0_bed": 1.95,
"net_effective_rent_psf_1_bed": 1.95,
"net_effective_rent_psf_2_bed": 1.88,
"net_effective_rent_psf_3_bed": 1.88,
"net_effective_rent_psf_4_bed": 1.88,
"days_on_market_0_bed": 15,
"days_on_market_1_bed": 15,
"days_on_market_2_bed": 22,
"days_on_market_3_bed": 28,
"days_on_market_4_bed": 28
}
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Successfully retrieved property data. Returns properties in JSON:API format with comprehensive property details.
Array of property data in JSON:API format
Show child attributes