Skip to main content
​
2.0.0
Replace construction_state with unified_status filter
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
​
1.2.0
Bulk Data Export and Property Search endpoints
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
  • 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
​
1.1.0
Compare Markets endpoint
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
  • Documentation
​
1.0.0
Initial public documentation
Initial public documentation of the ApartmentIQ API.
  • Authentication: Bearer tokens via Authorization header
  • 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
  • Markets
    • Search Geo Boundaries: POST /geo_boundaries/search
    • Bulk Properties: POST /geo_boundaries/properties
  • Global
    • Security scheme: HTTP Bearer (JWT)
    • Rate limit: 100 requests per 5 minutes (returns 429 when exceeded)